Общая информация
Компонент предназначен для ввода многострочного текста
Поддерживаемые экраны
Компонент может быть задействован на экране типа:
Внешний вид компонента
В услуге
В конструкторе
Структура компонента TextArea
ВКУ | JSON |
|
||
№ | В конструкторе | Атрибут | Тип | Описание |
1 | Идентификатор компонента | id | string | Уникальный идентификатор компонента в JSON |
2 | Имя компонента | name | string | Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
3 | Заголовок компонента | label | string | Название поля. Описывает, что пользователю необходимо ввести в отображаемое ему поле |
4 | Компонент обязателен для заполнения | required | boolean | Принуждает пользователя к взаимодействию с компонентом |
Атрибуты компонента | ||||
5 | Подсказка под компонентом вместо надписи «Необязательно» | customUnrecLabel | string | Подсказка, отображаемая в случае, если компонент не обязателен для заполнения. По умолчанию текст «Необязательно» |
6 | Подсказка под компонентом | hint | string | Текст, который отображается под компонентом |
7 | Количество отображаемых строк компонента | stringsAmount | integer | Количество строк компонента, отображаемое на экране. По умолчанию 3 строки |
8 | Максимальное количество вводимых символов | charsAmount | integer | Максимальное количество вводимых символов. Заполнение этого поля обязательно для соответствия вида компонента редполитике |
9 | Только для чтения | testReadOnly | string | Атрибут предназначен для отключения возможности пользователю редактировать значение |
10 | Пример значения в поле | placeholder | string | Добавляет в поле ввода серый текст, описывающий пример заполнения |
11 | Зависимости с ранее введёнными данными | ref | array of objects | Массив объектов, в элементах которых описываются зависимости и правила отображения полей |
12 | Отображение компонента в повторяющихся блоках RepeatableFields | onlyFirstScreen | boolean | Можно выбрать отображение только в первом блоке или наоборот. Если оставить выпадающий список пустым, то компонент Lookup будет отображаться во всех блоках компонента RepeatableFields |
Валидация | ||||
13 | Регулярное выражение | type | string | Регулярное выражение, в соответствии с которым будет осуществляться проверка вводимых данных |
14 | Сообщение об ошибке | errorMsg | string | Сообщение об ошибке, отображаемое если правило валидации не выполняется |
15 | Когда валидировать значение | updateOn | string | Cобытие, при котором происходит проверка значения: при изменении значения в поле, клике вне поля или при переходе на следующий экран |
16 | Модальные окна с пояснениями | clarifications | array of objects | Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» или сделать список ссылок на пояснительные переходы |
17 | Настроить модальное окно с пояснением вручную | acceptableTypes | additionalProperties | Позволяет настроить модальные окна |
18 | Настройка формирования health-метрик | healthList | array of objects | Позволяет задать список событий компонента, по которым будут формироваться health-запросы |
19 | Идентификатор подсказки suggest | suggestionId | string | Механизм отображения пользователю набора подходящих для ввода данных и автоматическое заполнение полей формы этими данными |
Пример JSON структуры объекта передаваемой в DTO
{ "visited": true, "value": "Текстовое многострочное поле (TextArea)" } |
Варианты использования
Компонент используется в случаях, когда от пользователя требуется ввод большого количества текстовых данных. Например, когда есть потребность описать суть жалобы или вопроса при обращении в ведомство, либо описать какой-то объект в свободной форме