Общая информация
Компонент предназначен для ввода многострочного текста.
Поддерживаемые экраны
Компонент может быть задействован на экранах типа:
- Составной экран (CUSTOM);
- Экран для повторяющегося набора компонентов (REPEATEBLE).
Внешний вид компонента
В услуге
В конструкторе
Структура компонента 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 |
Максимальное количество вводимых символов |
charsAmount |
integer |
Заполнение этого поля обязательно для соответствия вида компонента редполитике |
8 |
Только для чтения |
readonly |
boolean |
Если true, то компонент недоступен для редактирования пользователем |
9 |
Подсказка внутри поля |
placeholder |
string |
Добавляет внутрь поля ввода серый текст, описывающий пример заполнения |
10 |
Значение по умолчанию |
defaultValue |
string |
Добавляет внутрь поля текст по умолчанию, который может быть изменён пользователем |
11 |
Описание валидации компонента |
validation |
array |
Позволяет установить регулярные выражения для поля |
12 |
Установить зависимости с ранее введёнными данными |
ref |
array |
Массив объектов, в элементах которых описываются зависимости и правила отображения полей |
13 |
Пояснительные переходы |
clarifications |
object, array |
Позволяет вывести блок «Настройка пояснительных переходов в компоненте» или «Список ссылок на пояснительные переходы» |
14 |
Настройка пояснительных переходов в компоненте |
acceptableTypes |
additionalProperties |
Настройка модальных окон |
15 |
Настройка формирования health-метрик |
healthList |
array |
Позволяет задать список событий компонента, по которым будут формироваться health-запросы |
Пример JSON структуры компонента передаваемой в DTO
{ "value":"Настраиваемый компонент типа TextArea, позволяющий размещать на экране типа CUSTOM многострочное поле ввода, со счётчиком введённыхдоступных для ввода символов.", "visited": true } |
Варианты использования
Компонент используется в случаях, когда от пользователя требуется ввод большого количества текстовых данных. Например, когда есть потребность описать суть жалобы или вопроса при обращении в ведомство, либо описать какой-то объект в свободной форме.