Общая информация
Компонент позволяет выбрать регион, город или населенный пункт и сохранить в черновике. Представляет собой поле ввода с выпадающим списком подсказок, с возможностью выбора одного из вариантов.
Поддерживаемые экраны
Компонент может быть задействован на экране типа:
- Составной экран (CUSTOM).
Внешний вид компонента
В услуге
В конструкторе
Структура компонента CityInput
ВКУ |
JSON |
|||
№ |
В конструкторе |
Атрибут |
Тип |
Описание |
1 |
Идентификатор компонента |
id |
string |
Уникальный идентификатор компонента. Один компонент может принадлежать только одному экрану |
2 |
Удобочитаемое имя компонента |
name |
string |
Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
3 |
Подпись компонента |
label |
string |
Название поля. Описывает, что пользователю необходимо ввести в отображаемое ему поле |
4 |
Поле является обязательным для заполнения? |
required |
bool |
Признак обязательности ввода или выбора данных в компоненте Если выставлен — обязателен, не выставлен — не обязателен (по умолчанию) |
5 |
Идентификатор подсказки/саджеста/suggest |
suggestionID |
string |
Идентификатор, используемый в механизме автозаполнения полей данными, введенными пользователем ранее |
6 |
Создавать заявление на экране, где присутствует этот компонент? |
createOrder |
boolean |
Если в услуге есть компонент с таким флагом, то будет создано новое заявление с новым orderId |
7 |
Описание валидации компонента |
validation |
array of objects |
Если на экране есть несколько простых элементов и необходимо, чтобы пользователь указал хотя бы один |
8 |
Тип поиска |
searchType |
string |
Тип поиска в зависимости от указанного значения (регион, город, населенный пункт). По умолчанию, если атрибут не указан, тип поиска city |
9 |
Фильтр |
cityFilter |
array |
Фильтр ограничивает значения, указанные в массиве, которые доступны для выбора |
10 |
Предзаполнить значение региона пользователя? |
useBarLocation |
boolean |
Предзаполнение значения региона (при наличии информации в userRegion) |
Пример JSON структуры компонента передаваемой в DTO
{ "value":"{ "code": "c2deb16a - 0330 - 4f05 - 821f - 1d09c93331e6", "address": { "fiasCode": "c2deb16a - 0330 - 4f05 - 821f - 1d09c93331e6", "fullAddress": "г Санкт - Петербург", "postIndex": "190000", "elements": [ { "level": 1, "fiasCode": "c2deb16a - 0330 - 4f05 - 821f - 1d09c93331e6", "kladrCode": "7800000000000", "data": "Санкт - Петербург", "type": "город", "shortType": "г", "numericFiasCode": "78 - 0 - 000 - 000 - 000 - 000 - 0000 - 0000 - 000" } ] }, "level": 1, "id": "c2deb16a - 0330 - 4f05 - 821f - 1d09c93331e6", "text": "г Санкт - Петербург", "error": { "code": 0, "message": "operation completed" }, "dadataQc": "0", "dadataQcComplete": "3", "dadataQcHouse": "10", "fiasLevel": "1", "postalCode": "190000", "regionKladrId": "4400000000000", "okato": "40000000000", "tax_office": "7800", "oktmo": "40000000", "geo_lat": "59.9391313", "geo_lon": "30.3159004", "regionCode": "78" }" "visited":true } |
Вариант использования
Данный компонент можно использовать в тех случаях, когда необходимы сведения только о городе, а не об адресе целиком. Например при вводе паспортных данных, когда необходимо указать место рождения.