Общая информация
Компонент StringInput предназначен для ввода пользователем текстовой информации
Поддерживаемые экраны
Компонент может быть задействован на экранах типа:
Внешний вид компонента
В услуге Робота Макса

В стандартной услуге

В конструкторе

Структура компонента StringInput
| ВКУ | 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 | Короткое поле | isHalfWidth | boolean | Если чекбокс установлен, то ширина компонента уменьшается вдвое. Работает на ширине экрана свыше 576 px. На мобильных устройствах остаётся 100% |
| 8 | Скрыть поле | hidden | boolean | Если чекбокс установлен, то компонент не отображается на экране |
| 9 | Только для чтения | testReadOnly | string | Атрибут предназначен для отключения возможности пользователю вводить значение |
| 10 | Предустановка значения в поле | vkuPresetValue | string | Позволяет выбрать тип значения для предустановки |
| 11 | Значение по умолчанию | defaultValue | string | Позволяет заполнить поле значением по умолчанию |
| 12 | Пример значения в поле | placeholder | string | Позволяет отображать в поле пример заполнения серым текстом |
| 13 | Название поля, в которое запишется введённое значение на циклических экранах | fields | array | Используется для сохранения значения в поле элемента спискового компонента, обрабатываемого в цикле |
| 14 | Зависимости с ранее введёнными данными | ref | array | Массив объектов, в элементах которых описываются зависимости и правила отображения полей |
| 15 | Отображение компонента в повторяющихся блоках RepeatableFields | onlyFirstScreen | boolean | Можно выбрать отображение только в первом блоке или наоборот. Если оставить выпадающий список пустым, то компонент Lookup будет отображаться во всех блоках компонента RepeatableFields |
| 16 | Приведение букв к верхнему регистру | fstuc | string | Позволяет автоматически делать заглавную букву в первом слове, в каждом слове или делать каждую букву заглавной |
| 17 | Тип валидации | Validation | object |
Позволяет выбрать один из типов валидации:
|
| 18 | Регулярное выражение | value | string | Позволяет указать регулярное выражение, в соответствии с которым будет осуществляться проверка вводимых данных |
| 19 | Сообщение об ошибке | errorMsg | string | Позволяет указать текст, который отображается пользователю в случае, если значение не соответствует правилу валидации |
| 20 | Когда валидировать значение | updateOn | string | Позволяет выбрать событие, при котором происходит проверка значения: при вводе значения, после окончания ввода или при переходе на следующий экран |
| 21 | Маска ввода | mask | string, array | Позволяет настроить маску ввода или выбрать одну из предустановленных масок |
| 22 | Отображать разделитель групп разрядов | rank | string | Позволяет отображать введённые числа с разделителем групп разрядов, то есть число 12200000 показывать пользователю как 12 200 000 |
| 23 | Модальные окна с пояснениями | clarifications | object, array | Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» или сделать список ссылок на пояснительные переходы |
| 24 | Настроить модальное окно с пояснением вручную | acceptableTypes | additionalProperties | Позволяет настроить модальные окна |
| 25 | Настройка формирования health-метрик | healthList | array | Позволяет задать список событий компонента, по которым будут формироваться health-запросы |
| 26 | Ссылки на значения атрибутов для подстановки в отображаемый текст | refs | array of objects | Ссылки на значения компонентов, значения которых необходимо отобразить |
| 27 | Вычисляемые аргументы компонента (linkedValues) | linkedValues | array | Атрибуты компонента, позволяющие реализовать сложный функционал |
| 28 | Идентификатор подсказки suggest | suggestionId | string | Механизм отображения пользователю набора подходящих для ввода данных и автоматическое заполнение полей формы этими данными |
| 29 | Идентификаторы компонентов, для которых чистить кэш | clearCacheForComponentIds | array | Если ответ на текущий компонент отличается от того, что указан в cachedAnswers, при наличии, то будут удалены все cachedValues, указанные в этом поле |
Пример JSON структуры компонента, передаваемой в DTO
|
{ “visited”: true, “value”: “Фамилия” } |
Варианты использования
Данный компонент можно использовать для реализации проверки вводимых значений при помощи регулярных выражений, а также по заданному выражению. Для этого необходимо в расширенном режиме в блоке «Правила валидации» выбрать «Проверка значений по заданному выражению» и в поле «Выражение для проверки введённого значения» указать правило проверки
В примере ниже реализована проверка на ввод в зависимости от значений в других строках. То есть сумма первого слагаемого и удвоенного второго должна быть больше разности вводимого значения и 10
