Универсальный компонент ввода или подтверждения адреса (AddressInput)

Скопировать прямую ссылку на статью

Общая информация

Компонент AddressInput предназначен для ввода адреса пользователем

Поддерживаемые экраны

Компонент может быть задействован на экране типа:

Компонент в стандартной услуге

Внешний вид компонента

В услуге

Рисунок1.png

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

Рисунок2.png

Структура компонента AddressInput

ВКУ		JSON
№	В конструкторе	Атрибут	Тип	Описание
1	Идентификатор компонента	id	string	Уникальный идентификатор компонента в JSON
2	Имя компонента	name	string	Допускается ввод любых данных для отображения в конструкторе, однако классическим видом является s1_с1, где номера — сгенерированные идентификаторы, s — экран, c — компонент
3	Заголовок компонента	label	string	Название поля. Описывает, что пользователю необходимо ввести в отображаемое ему поле
4	Компонент обязателен для заполнения	required	boolean	Принуждает пользователя к взаимодействию с компонентом
5	Подсказка под компонентом вместо надписи «Необязательно»	customUnrecLabel	string	Подсказка, отображаемая в случае, если компонент не обязателен для заполнения. По умолчанию текст «Необязательно»
6	Отображение компонента в повторяющихся блоках RepeatableFields	onlyFirstScreen	boolean	Можно выбрать отображение только в первом блоке или наоборот. Если оставить выпадающий список пустым, то компонент AddressInput будет отображаться во всех блоках компонента RepeatableFields
7	Только для чтения	testReadOnly	string	Атрибут предназначен для отключения возможности пользователю редактирования значения в поле
8	Ссылка на переменную	disable	string	Позволяет ввести переменную, которая принимает значение «true» или «false». Если «true», то отключает возможность редактирования поля
9	Дополнить поля адреса литерой, комнатой или земельным участком	letterRoomEnabled	boolean	Дополняет поле ввода адреса литерой, комнатой или земельным участком
10	Предустановка значения в поле	preset	object	Предустановка значения адреса из другого компонента
11	Значение	value	string	Поле для ввода значения ранее заполненного компонента
12	Название поля	fieldName	string	Позволяет выбрать поле адреса, которое будет валидироваться
13	Регулярное выражение	value	string	Позволяет указать регулярное выражение, в соответствии с которым будет осуществляться проверка введённых данных
14	Заголовок дисклеймера	errorMsg	string	Позволяет указать заголовок дисклеймера, который отображается пользователю в случае, если значение не соответствует правилу валидации
15	Текст дисклеймера	errorDesc	string	Позволяет указать текст дисклеймера, который отображается пользователю в случае, если значение не соответствует правилу валидации
16	Сделать поле «Дом» необязательным для заполнения	selectHouseCheckbox	boolean	Позволяет сделать поле «Дом» в адресе необязательным для заполнения. По умолчанию обязательно для заполнения
17	Сделать поле «Квартира» необязательным для заполнения	selectApartmentCheckbox	boolean	Позволяет сделать поле «Квартира» в адресе необязательным для заполнения. По умолчанию обязательно для заполнения
18	Скрыть чекбокс «Нет квартиры»	selectApartmentCheckbox	boolean	Позволяет скрыть чек-бокс «Нет квартиры» от пользователя. По умолчанию чек-бокс отображается пользователю
19	Скрыть чекбокс «Нет дома»	hideHouseCheckbox	boolean	Позволяет скрыть чек-бокс «Нет дома» от пользователя. По умолчанию чек-бокс отображается пользователю
20	Скрыть функцию «Уточнить адрес»	hideSpecifyAddress	boolean	Позволяет скрыть функцию «Уточнить адрес». По умолчанию функция отображается пользователю
21	Включение нормализации адреса в компоненте при возврате назад по услуге	normalizeOnInit	boolean	При включении, в случае возвращения на предыдущий экран, для введённого адреса произойдёт нормализация, которая сделает деление по полям, рассчитает индекс и определит координаты. Данная нормализация приведёт адрес в стандартизированную форму. По умолчанию нормализация адреса выключена
22	Проверка наличия адреса в ГАР	verifyInGar	boolean	При активации производится проверка на наличие введённого адреса в государственном адресном реестре. По умолчанию включено
23	Отключить валидацию входных данных на backend	skipValidation	boolean	Отключает валидацию входных данных на backend, которая проверяет, что введённое значение присутствует в справочнике
24	Зависимости с ранее введёнными данными	ref	array	Массив объектов, в элементах которых описываются зависимости и правила отображения полей
25	Модальные окна с пояснениями	clarifications	array of objects	Позволяет раскрыть блок «Настроить модальное окно с пояснением вручную» или сделать список ссылок на пояснительные переходы
26	Настроить модальное окно с пояснением вручную	acceptableTypes	additionalProperties	Позволяет настроить модальные окна
27	Идентификатор подсказки suggest	suggestionId	string	Механизм отображения пользователю набора подходящих для ввода данных и автоматическое заполнение полей формы этими данными
28	Вычисляемые аргументы компонента (linkedValues)	linkedValues	array	Атрибуты компонента, позволяющие реализовать сложный функционал
29	Идентификаторы компонентов, для которых чистить кэш	clearCacheForComponentIds	array	При переходе на следующий экран cachedValues всех указанных компонентов будут удалены

Пример 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": "3",

"houseCheckbox":false,

"houseCheckboxClosed":false,

"building1Type": "",

"building1ShortType": "",

"building1": "",

"building2Type": "",

"building2ShortType": "",

"building2": "",

"apartmentType": "квартира",

"apartmentShortType": "кв",

"apartment": "2",

"apartmentCheckbox":false,

"apartmentCheckboxClosed":false,

"index": " 420059 ",

"geoLat": "55.7689478",

"geoLon": "49.1343655",

"fullAddress": "420059, Респ. Татарстан, г. Казань, ул. Дальняя, д. 3, кв. 2",

"addressStr": "Респ. Татарстан, г. Казань, ул. Дальняя",

"lat": "55.7689478",

"lng": "49.1343655",

"kladrCode": "1600000100003600005",

"fiasCode": "2ec7054b-fdac-472b-9c6c-b5e483ca51b4",

"regionFias": "0c089b04-099e-4e0e-955a-6bf1ce525f1a",

"regionKladr": "1600000000000",

"townFias": "",

"townKladr": "",

"streetFias": "41091f15-08ff-4b2b-bfbb-9cc8e2b08db5",

"streetKladr": "16000001000036000",

"houseFias": "6583d949-c7f0-4fd7-ab7b-e2f8031a469c",

"houseKladr": "1600000100003600005",

"apartmentFias": "2ec7054b-fdac-472b-9c6c-b5e483ca51b4",

"apartmentKladr": "1600000100003600005",

"okato": "92401380000",

"oktmo": "92701000001",

"hasErrors": 0,

"regionCode": "16",

"postalCode": "",

"oktmoName": "",

"esiaAddressSrt": "",

"visited ": true

}

Варианты использования

Чаще всего компонент AddressInput используется для указания адреса фактического проживания, если он не совпадает с адресом постоянной регистрации

Рисунок3.png

Рисунок4.png

Компонент также регулярно применяется при необходимости указания адреса регистрации, проживания, а также фактического или юридического адреса получателя услуги в сценарии представительства

Рисунок5.png

Компонент в услуге Робота Макса