Краткий текст — text

Определение

Компонент используется для ввода однострочных текстовых данных: названий и наименований. Тип компонента в конфигураторе: text.

Внешний вид

JSON-схема для простого текстового поля в конфигураторе:

"location": {
            "type": "text",
            "title": "Местоположение",
            "description": "Укажите оси отметки"
}

Как оно выглядит в пользовательском приложении:

Свойства

{
    "type": "text",
    "title": "Название объекта",
    "description": "Введите название ЖК",
    "minLength": 3,
    "maxLength": 15,
    "hidden": false
}

Свойство	Определение	Тип данных
type	Тип элемента. Для краткого текста — это всегда text.	string
title	Название поля, отображаемое в форме.	string
description	Описание поля. Отображается как заглушка поля в форме.	string
minLength	Минимальное количество символов в поле для того, чтобы заполненная форма считалась корректной.	number
maxLength	Максимальное количество символов в поле для того, чтобы заполненная форма считалась корректной.	number
hidden	Это стандартное свойство для всех компонентов. При установке значения true для этого свойства, компонент будет скрыт из формы. Это свойство помогает выстраивать логику для работы с полями. То есть с помощью хуков есть возможность изменить значение этого свойства в определённых ситуациях. Либо использовать данные из этого поля в других местах, но так, чтобы конечный пользователь не видел этого.	boolean

Модель данных

Данные сохраняются в FormInstances в поле Data в виде JSON.

Заполненное текстовое поле в пользовательском приложении:

После сохранения данные попадают в FromInstances в конфигураторе. Они сохраняются также в JSON формате:

{
  "name": "ЖК \"Зелёный город\""
}

Примеры использования

Далее идёт пример использования компонента в форме заполнения данных организации. Каждое поле в данной форме является текстовым. В примере ниже компоненты прописаны с description. Для всех полей указана минимальная длинна в свойстве minLenght.

{
    "properties": {
        "inn": {
          "type": "text",
          "title": "ИНН",
          "minLenght": 8,
          "description": "Введите ИНН"
                },
        "Ogrn": {
          "type": "text",
          "title": "ОГРН",
          "minLenght": 1,
          "description": "Введите ОГРН"
                },
        "name": {
          "type": "text",
          "title": "Название",
          "minLenght": 1,
          "description": "Введите название организации"
                },
        "phone": {
          "type": "text",
          "title": "Телефон",
          "minLenght": 10,
          "description": "Введите номер телефона"
                },
        "address": {
          "type": "text",
          "title": "Юридический адрес",
          "minLenght": 1,
          "description": "Введите юридический адрес"
                }
        }
}