Общее описание
Редактор форм платформы Citeck включает набор компонентов, сгруппированных по назначению:
Основные — для ввода и выбора данных,
Расширенные — специализированные компоненты платформы,
Макет — для структурирования формы,
Данные — для организации структуры данных формы, загрузки данных и работы с коллекциями.
Часть компонентов основана на стандартных компонентах Form.io и дополнена функциональностью Citeck. Для таких компонентов приведены ссылки на оригинальную документацию Form.io, а также на описание доработок.
Основные компоненты
Text Field
Однострочное текстовое поле.
Select Journal
Компонент для выбора записей из журнала. Журнал можно задать в настройках компонента (journalId), определить выражением (customJournalId) или получить из настроек ссылочного типа атрибута.
Select Orgstruct
Компонент, отвечающий за выбор из оргструктуры пользователей/групп. Что именно будет выбираться (пользователи с группами вместе, или что-то одно), – регулируется внутри компонента.
Number
Числовое поле. Может принимать в себя как целочисленные значения, так и с плавающей точкой. Это регулируется внутри компонента.
По умолчанию разделение разрядов выключено. Его можно включить в настройках компонента. Если разделение включено и свой разделитель не задан, используется пробел. Например, 1 000 000.
Date/Time
Поле, отвечающее за отображение даты и времени.
Отображение регулируется внутри компонента, доступна локализация Ru/Eng
Text Area
Аналог Text Field. Многострочное текстовое поле.
Для многострочного ввода достаточно обычного Text Area. На вкладке Вид можно выбрать редактор для форматированного текста или исходного кода, в том числе Lexical или Monaco. При просмотре значения обычный текст и форматированный текст отображаются в соответствии с выбранным режимом редактора:
Checkbox
Флажок для ввода логического значения: true или false. По умолчанию значение — false. При включении настройки hasThreeStates поддерживает три состояния: true, false и null (значение не задано).
Day
Поле для ввода значений «День», «Месяц» и «Год» с использованием числа или выбора типа поля.
ECOS Select
Поле, отвечающее за выбор из списка. Основан на стандартном formio-компоненте Select, был модифицирован.
Расширенные
ML Text
Однострочное текстовое поле. Для выбора языка предусмотрен переключатель в виде флага России /США. После выбора языка в поле вводится текст.
Переводы сохраняются в объекте со строчными ключами языков, например {"ru": "Название", "en": "Title"}. Можно заполнить один или оба перевода. Суффикс ML в ключе поля не требуется; тип компонента — mlText.
В базовых настройках компонентов многоязычный ввод поддерживается для названия поля (label), текста внутри пустого поля (placeholder), описания (description) и подсказки (tooltip). Подсказка использует многострочный компонент ML Textarea. Также локализуются контент HTML Element (content) и заголовок Panel (title).
Color Picker
Компонент для выбора цвета. Тип компонента — colorPicker.
Table Form
Компонент позволяет отображать выбранные значения в виде таблицы.
Task Outcome
Компонент используется для добавления кнопок вердиктов задачи на форму. Компонент автоматически формирует кнопки вердиктов исходя из настроек Результатов задачи.
Select Hierarchical
Компонент реализует иерархический select для форм Citeck — выбор записей, организованных в дерево через само-ассоциацию (parent–child).
Возможности компонента:
выпадающий список с деревом;
ленивая загрузка дочерних узлов: корень загружается при открытии, вложенные — при раскрытии узла;
отображение полного пути (Parent › Child) через цепочку
_parentвверх по дереву (до 20 уровней);автоматическое раскрытие при открытии: если выбрано значение — предки раскрываются автоматически;
выбор одного или нескольких значений.
Email
Компонент представляет собой строковое поле, которое выполняет специальную проверку ввода, гарантирующую, что введенные данные находятся в допустимом формате электронной почты.
Действительный адрес электронной почты состоит из префикса электронной почты и домена электронной почты в приемлемых форматах.
URL
Компонент имеет настраиваемый параметр проверки, который, если он настроен правильно, может гарантировать, что введенное значение является допустимым URL-адресом.
Phone Number
Компонент можно использовать для ввода номеров телефонов в форму. Можно задать маску ввода номера.
Address Field
Специальный компонент, выполняющий поиск введенных адресов.
ML Textarea
Многострочное текстовое поле для ввода на русском/английском языках. Для выбора языка предусмотрен переключатель в виде флага России /США. После выбора языка в поле вводится текст.
Переводы сохраняются в объекте со строчными ключами языков, например {"ru": "Описание", "en": "Description"}. Можно заполнить один или оба перевода. Суффикс ML в ключе поля не требуется; тип компонента — mlTextarea.
HTML Element
Компонент может быть добавлен в форму для отображения одного элемента HTML.
Динамически через скрипт можно менять контент. Например:
instance.component.content = {en: '<p>Hello World</p>', ru: '<p>Привет, мир</p>'};
instance.setHTML();
File
Компонент для загрузки файлов.
Select Action
Раскрывающееся меню действий. При выборе пункта компонент выполняет JavaScript или генерирует событие формы.
На вкладке Данные в списке Items (source.items) для каждого пункта задаются:
название действия (
name);тип действия (
type);JavaScript-код (
code) или название события (eventName) в зависимости от типа действия.
Макет
Horizontal Line
Компонент для отображения разделителя блоков.
Columns
Компонент, отвечающий за разделение формы на столбцы. Основан на стандартном formio-компоненте Columns, был модифицирован.
См. подробное описание Columns на Form.io
См. подробное описание Columns
Основы Bootstrap Grid
Система Bootstrap Grid нужна для разметки страницы, в частности, для создания адаптивных макетов.
Фреймворк определяет 5 уровней адаптивности (брейкпоинтов), которые основаны на ширине области просмотра:
xs — extra small, супермаленький — ширина < 576px (это уровень по умолчанию);
sm — small, маленький — ширина ≥ 576px;
md — medium, средний — ширина ≥ 768px;
lg — large, большой — ширина ≥ 992px;
xl — extra large, супербольшой — ширина ≥ 1200px.
Сетка состоит из групп рядов и колонок, расположенных внутри одного или нескольких контейнеров.
Основные правила сетки в Bootstrap:
колонки находятся строго внутри ряда на первом уровне вложенности;
ряды нужны только для размещения колонок;
ряды должны располагаться внутри контейнера.
Ряды и колонки всегда работают вместе, их нельзя разделять.
Элемент с классом .container является корневым блоком сетки в Bootstrap, то есть располагается на внешнем уровне. Контейнер подходит для хранения любых элементов, а не только рядов и колонок.
Внутри ряда должны находиться только колонки, а контент – уже внутри них.
Колонки нужны для разделения области просмотра по горизонтали, при этом в одном ряду могут быть столбцы разной ширины.
Классическая Bootstrap-сетка состоит из 12 колонок.
В большинстве случаев не требуется использование всех, их можно объединять по мере надобности. Представьте, что вся область просмотра разделена на 12 равных частей – единиц ширины. В одной колонке может быть от 1 до 12 таких единиц.
Panel
Панель, в которую можно поместить свойство. Нужна для зонирования. В неё помещаются близкие по смыслу компоненты и им присваивается заголовок.
Table
Компонент позволяет создать таблицу со столбцами и строками.
Tabs
Компонент отвечает за вкладки на форме. Вкладка скрывается, когда на ней все компоненты скрыты, либо компонентов нет совсем.
Данные
Скрытое поле
Компонент можно добавить в форму, чтобы создать свойство ресурса, которое можно настроить в форме. Внешнего виджета для скрытых компонентов нет. Они не отображаются в визуализированных формах.
Async Data
Невидимый компонент для загрузки асинхронных данных.
Include Form
Компонент для включения одной формы в другие.
В свойствах необходимо заполнить поле formRef, выбрав форму из журнала форм (ecos-forms).
В редакторе компонент отображается подобно Hidden. Для выбранной формы подпись формируется по шаблону «Форма: имя_формы» (на английском — Form: form_name), где используется отображаемое имя выбранной формы.
При просмотре формы компонент Include Form не отображается как отдельный элемент интерфейса.
Контейнер
Группирует вложенные поля в объект данных под ключом контейнера. Например, поле name внутри контейнера с ключом person сохраняется в data.person.name.
В отличие от визуальной группировки с помощью Panel или Field Set, контейнер добавляет уровень вложенности в данные формы. Для размещения полей по столбцам используется компонент Columns.
Data Grid
Компонент управления отображением данных, который извлекает информацию из коллекции объектов и визуализирует ее в сетке со строками и ячейками. Каждая строка соответствует отдельному объекту, а каждый столбец — свойству в этом объекте.
Data Grid Assoc
Таблица для работы со связанными записями. В отличие от обычного Data Grid, может принимать ссылки на записи и загружать их атрибуты в строки таблицы.
Для создания связанных записей по данным строк необходимо настроить recordRef — ссылку, используемую при создании записи. Компонент может получить её из первого доступного варианта создания для атрибута.
Data Map
Компонент позволяет пользователям создавать пары ключ/значение.