Конструктор форм

Общее описание

Конструктор форм — визуальный дизайнер для создания и настройки форм платформы Citeck. Он позволяет без написания кода определить состав и расположение полей, задать правила валидации, управлять видимостью и доступностью компонентов, а также добавить пользовательскую логику поведения формы.

С помощью конструктора можно:

  • выбирать из готового набора компонентов (текстовые поля, списки, даты, вложения и др.) и размещать их на форме перетаскиванием;

  • настраивать свойства каждого компонента — отображаемое название, привязку к атрибуту типа данных, обязательность, режим «только чтение»;

  • задавать условия отображения и логику изменения полей в зависимости от действий пользователя;

  • проверять корректность заполнения с помощью встроенных правил валидации или пользовательских скриптов.

Добавление компонента формы

Для пустой формы конструктор загружает начальный набор компонентов из системного шаблона uiserv/form@DEFAULT. Его состав зависит от конфигурации системы. Например, шаблон может содержать кнопки и текстовое поле; их можно удалить или отредактировать. Существующая непустая форма открывается со своим набором компонентов.

Чтобы добавить компонент в форму, перетащите компонент из левого столбца в нужное место в форме:

Редактирование компонента формы

Чтобы изменить компонент формы, наведите указатель мыши на компонент и щелкните значок шестеренки - откроется форма настроек для компонента.

Настройка компонентов

Ниже приведен список общих настроек, которые присутствуют в большинстве компонентов. Основные вкладки, используемые для настройки:

Базовые

Хранит в себе основные, используемые чаще всего, настройки.

../../../_images/tab_11.png

п/п

Наименование

Описание

1

Название поля

имя компонента, как оно будет отражаться на форме.

2

Имя свойства

имя свойства из типа данных
При вводе имени свойства появляются подсказки атрибутов модели родительской формы или типа редактируемой формы. Они помогают выбрать атрибут; список не является проверкой уже занятых ключей компонентов.

3

Подсказка

подсказка, которая отображается при наведении курсора на знак вопроса возле поля, если необходимо.

4

Множественный выбор

отвечает за возможность множественного выбора (нужно для выбора из списка, журнала, или оргструктуры).

5

Заблокирован ввод

отключает возможность ввода данных в компонент.

6

Обязательное

обязательность заполнения поля.

Вид

Хранит в себе настройки для отображения. Для базовой настройки нужны:

../../../_images/tab_21.png

п/п

Наименование

Описание

1

Текст для пустого поля

подсказка, которая отображает до начала заполнения поля. Используется в основном для текстовых полей.

2

Описание

подсказка, которая отображается на форме всегда, в отличие от Placeholder, если необходимо.

3

Очистить значение, если оно скрыто

отвечает для очистку данных в компоненте, когда она скрыта.

Данные

Отвечает за автоматическое заполнение поля данными. В списках, есть возможность заполнить список статическими, или полученными из асинхронного запроса данными.

../../../_images/tab_31.png

Валидация

Отвечает за проверку правильности заполнения поля. Поддерживает как простые проверки (проверки длины введенной строки или принятия конкретного значения), так и сложные.

../../../_images/tab_41.png

API

Хранит в себе ключ и атрибут для корректного сохранения данных.

../../../_images/tab_5.png

Поле

Значение

Ключ

строка attribute

Значение

точное имя атрибута Records API, например initiator или docs:documents. Пространство имён не преобразуется автоматически в подчёркивание.

Отображение

Отвечает за настройку отображения компонента. Поддерживает как простую логику, например, сопоставление значения поля и отображения при совпадении, так и сложную.

../../../_images/tab_6.png

Логика

Пользовательская логика. Добавление динамического поведения в формы:

  • Показ/скрытие полей.

  • Изменение значений, обязательности, доступности полей.

  • Выполнение кастомных действий через JavaScript.

../../../_images/tab_7.png

Тип триггера определяет структуру и условия срабатывания. Конфигурация триггера зависит от выбранного типа:

Тип

Описание

Документация

Простой

Использует стандартный интерфейс и методы настройки, аналогичные вкладке «Отображение».

Документация по простым условиям

JavaScript

Позволяет писать пользовательские условия на JavaScript. Интерфейс и настройки совпадают с «Расширенные условия отображения».

Документация по расширенным условиям

JSON Logic

Альтернатива JavaScript для написания логических условий с использованием JSON-структур.

Документация по JSON Logic

Событие

Запускает правило при получении указанного события формы. Событие может отправляться кнопкой с действием Event или скриптом.

—

Внешнее руководство Form.io может описывать интерфейс другой версии движка. Состав настроек в Citeck зависит от компонента и доработок платформы.

Доступны следующие действия, которые могут быть выполнены при активации условия:

Действие

Описание

Свойство

Изменение настроек поля (видимость, обязательность, текст подписи и др.).

Значение

Динамическое обновление данных с помощью JavaScript (доступны переменные row, data, component, result).

Валидация

Настройка правил проверки данных формы в зависимости от условий.

Шаблон элемента

Отвечает за дополнительные атрибуты, которые могут быть добавлены в форму.

Настройки макета

Можно изменить расположение компонентов на форме, используя HTML-атрибуты. Например, отступы сверху, снизу, слева и справа. Величины должны быть введены в допустимом формате CSS (например, 10px), чтобы отображаться корректно. Компоненты будут располагаться соответствующим образом в зависимости от того, какие поля отступов вы настроите.

../../../_images/tab_8.png