Общая информация
Компонент AddressInput предназначен для ввода и подтверждения пользователем адреса.
Поддерживаемые экраны
Компонент может быть задействован на экранах типа:
Внешний вид компонента
В услуге
В конструкторе
Структура компонента AddressInput
ВКУ
|
JSON
|
|||
№
|
В конструкторе
|
Атрибут
|
Тип
|
Описание
|
1 |
Идентификатор компонента |
id |
string |
Уникальный идентификатор компонента в JSON |
2 |
Удобочитаемое имя компонента |
name |
string |
Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент |
3 |
Заголовок компонента |
label |
string |
Название поля. Описывает, что пользователю необходимо ввести в отображаемое ему поле |
4 |
Поле является обязательным для заполнения? |
required |
boolean |
Принуждает пользователя к взаимодействию с компонентом |
Атрибуты компонента |
||||
5 |
Атрибут устанавливать true, если валидация входных параметров не должна происходить |
skipValidation |
boolean |
Атрибут, который отменяет валидацию ввода элементов данных |
6 |
Подсказка под компонентом вместо надписи «Необязательно» |
customUnre cLabe |
string |
Подсказка под полем вместо надписи «Необязательно» — отображается, если установлен флаг «required»: false |
7 |
Только для чтения |
readonly |
boolean |
Если true, то запрещает пользователю редактировать значение |
8 |
Задать ссылку на переменную/Задать значение вручную |
disable |
1) string 2) ${proactivity Created} 3) bool |
1) Атрибут предназначен для отключения возможности пользователю редактировать поле 2) Можно задать логическое значение, либо ссылку на переменную 3) Позволяет запретить пользователю выбрать элемент списка |
9 |
Предустановка значения в поле |
preset |
object |
Предустановка значения адреса из другого компонента |
10 |
Тип значения |
type |
string |
Позволяет выбрать тип значения для предустановки: REF, который используется для создания ссылки на переменные в поле «Значение» |
11 |
Значение |
value |
string |
Поле для ввода значения выбранного типа |
12 |
Поля адреса для задания кастомной валидации |
fieldname |
string |
Возможность задавать пользовательские правила валидации для полей адреса |
13 |
Установить зависимости с ранее введёнными данными |
ref |
array of objects |
Массив объектов, в элементах которых описываются зависимости и правила отображения полей |
14 |
Пояснительные переходы |
clarifications |
object |
Позволяет раскрыть блок «Настройка пояснительных переходов в компонентах» или сделать список ссылок на пояснительные переходы |
15 |
Настройка пояснительным переходов в компоненте |
acceptableTypes |
additionalProperties |
Позволяет настроить модальные окна |
16 |
Сделать поле «Дом» в адресе необязательным |
selectHouseCheckbox |
boolean |
При задании данного флага по умолчанию дом в адресе будет необязательным. По умолчанию принимает значение false |
17 |
Сделать поле «Квартира» в адресе необязательным |
selectApart mentCheck box |
boolean |
При задании данного флага по умолчанию квартира в адресе будет необязательной. По умолчанию принимает значение false |
18 |
Скрыть чекбокс «Нет дома» |
hideHouseCheckbox |
boolean |
При выборе чек-бокса «Нет дома» будет скрыт от пользователя. По умолчанию принимает значение false Важно! Согласно редакционной политике, чек-бокс «Нет дома» скрывать не нужно |
19 |
Скрыть чекбокс «Нет квартиры» |
hideApartmentCheckbox |
boolean |
При задании данного флага чек-бокс «Нет квартиры» будет скрыт от пользователя. По умолчанию принимает значение false |
20 |
Скрыть чекбокс «Уточнить адрес» |
hideSpecifyAddress |
boolean |
При задании данного флага в компоненте скрывается функция «Уточнить адрес». По умолчанию принимает значение false |
21 |
Включить нормализацию адреса в компоненте при переходе назад по услуге |
normalizeOnInit |
boolean |
Если включён чек-бокс, то при возвращении на предыдущий экран, для введённого адреса произойдёт нормализация, которая сделает деление по полям, рассчитает индекс и определит координаты. Данная нормализация приведёт адрес в стандартизированную форму |
22 |
Идентификатор подсказки/саджеста/ suggest |
suggestionId |
string |
|
23 |
Вычисляемые аргументы компонента (linkedValues) |
attrs |
object |
Атрибуты компонента, позволяющие реализовать сложный функционал |
Пример JSON структуры компонента передаваемой в DTO
{ "value": { "regionType": "", "regionShortType": "", "region": "", "cityType": "", "cityShortType": "", "city": "", "districtType": "", "districtShortType": "", "district": "", "townType": "", "townShortType": "", "town": "", "inCityDistType": "", "inCityDistShortType": "", "inCityDist": "", "streetType": "", "streetShortType": "-", "street": "", "additionalAreaType": "", "additionalAreaShortType": "", "additionalArea": "", "additionalStreetType": "", "additionalStreetShortType": "", "additionalStreet": "", "houseType": "", "houseShortType": "", "house": "2", "houseCheckbox": false, "houseCheckboxClosed": false, "building1Type": "", "building1ShortType": "", "building1": "", "building2Type": "", "building2ShortType": "", "building2": "", "apartmentType": "", "apartmentShortType": "", "apartment": "", "apartmentCheckbox": true, "apartmentCheckboxClosed": true, "index": "620014", "geoLat": "56.8358434", "geoLon": "60.5832751", "fullAddress": "620014, . , . , -. , . 2", "addressStr": ". , . , -. ", "lat": "56.8358434", "lng": "60.5832751", "fiasCode": "8e1a4d46-86a5-4965-a417-f130ebbb7881", "regionFias": "92b30014-4d52-4e2e-892d-928142b924bf", "streetFias": "6441e17d-e086-48f4-a5a6-0cc1a4a474b9", "houseFias": "8e1a4d46-86a5-4965-a417-f130ebbb7881", "okato": "65401000000", "hasErrors": 0, "kladrCode": "6600000100006050039", "regionCode": "66" }, "visited": true } |
Варианты использования
Самым распространённым использованием компонента AddressInput является проверка на совпадение фактического адреса и постоянной регистрации, которая подтягивается из ЛК ЕСИА. В таком сценарии необходимо добавить экран с разводящим вопросом, где при отрицательном ответе пользователь должен будет ввести вручную фактический адрес.
Также одним из частых примеров является ручной ввод адреса для сотрудника ИП. Данный экран отображается в услуге только в том случае, если пользователь проходит услугу под УЗ ИП сотрудника в сценарии подтверждения персональных данных.
Реализацию данных примеров можно посмотреть в шаблоне услуги 9900