Перейти к основному содержимому
Версия: 7.0

Представления React

Представление React — пользовательское представление, которое компонент React рисует в веб-клиенте вместо платформы как часть интерактивного представления формы или дизайна навигатора. Статьи этого раздела описывают, что такой компонент получает и что вызывает.

Контейнер DESIGN может отрисовываться компонентом React вместо стандартной раскладки. Компонент получает проекцию состояния формы и сам рисует всё поддерево контейнера. Таблицу, тулбар, управляющие элементы фильтров, группу фильтров и фильтр по свойству так же может рисовать собственный компонент React вместо их представления платформы (Собственное представление компонента). Вне формы компонент React может рисовать окно навигатора, окно форм, окно сообщений и расположение окон.

Это возможность только веб-клиента. Десктоп-клиент десериализует контейнер и отрисовывает его обычное (не React) поддерево, а компонент с собственным компонентом React рисует представлением платформы, поэтому дизайн остаётся рабочим в обоих клиентах.

Виды представлений React​

Представления React бывают следующих видов:

  • контейнер дизайна формы: имя компонента задаёт его custom в DESIGN, и компонент рисует всё поддерево контейнера (Выбор компонента);
  • собственное представление компонента: имя компонента задаёт custom таблицы дерева, тулбара, управляющих элементов фильтров, группы фильтров или фильтра по свойству, и компонент рисует на их месте то, что они показывают из своей группы объектов или дерева;
  • компонент React в CUSTOM: имя компонента задаёт опция CUSTOM свойства или группы объектов, и компонент рисует одну ячейку свойства или строки группы;
  • окно или расположение окон: имя компонента задаёт опция CUSTOM инструкции WINDOW, а для расположения — инструкции NAVIGATOR, и компонент рисует окно навигатора, окно форм или окно сообщений либо располагает окна.

Представление React на форме читает проекцию формы и вызывает члены своего контроллера. Компоненты и хуки платформы для отрисовки строк, изображений и заголовков описаны в статье Отрисовка в React; размещение того, что рисует платформа, — в статье Компоненты, которые рисует платформа; фокус, загрузка формы, клавиши и привязки мыши, живые данные и скрытое представление — в статье Поведение формы в React; части группы объектов, которые рисует представление, — в статьях Деревья, сортировки и выделение в React и Фильтры и тулбар в React. Контроллеры формы и навигатора, которые получает любое представление на JavaScript, описаны в статье Контроллеры формы и навигатора.

Выбор компонента​

Компонент задаётся атрибутом custom контейнера:

FORM orders 'Orders'
OBJECTS o = Order
PROPERTIES(o) READONLY number, date, sum
;

DESIGN orders {
BOX(o) {
custom = 'OrderBoard';
}
}

Здесь объект o отрисовывается компонентом React OrderBoard вместо стандартной таблицы. Для компонента, не являющегося контейнером, см. Собственное представление компонента.

Размер окна и базовый размер​

Размер окна и базовый размер контейнера задаются через атрибуты size, width и height. Например, size = (900, 600) задаёт базовый размер контейнеру React, а size = (-1, -1) у главного контейнера формы делает окно динамическим по обоим направлениям, height = -1 — только по высоте. Атрибуты fill и overflowVert управляют расширением и переполнением по вертикали. Динамическое окно подходит для формы без таблиц с содержимым умеренной высоты.

Компонент​

OrderBoard — именованный экспорт из модуля .jsx в каталоге src/main/web. Примеры статей о React используют JSX. Для проекта с файлами без сборки поместите тот же компонент в файл .jsx — он преобразуется на сервере при отдаче. import и export там недоступны, поэтому ключевое слово export опускается, а компонент работает с предоставляемым платформой window.React — либо напишите его через React.createElement в обычном .js. Любой из этих файлов кладётся в src/main/resources/web/init (автозагрузка) или в src/main/resources/web с регистрацией через onWebClientInit.

Компонент — это обычная функция, получающая props.data и props.controller:

export function OrderBoard(props) {
const orders = props.data.o.list;
return <div className="order-board">{orders.length} orders</div>;
}

Впервые компонент отрисовывается с первой проекцией своего контейнера, когда пришли первые данные формы, и никогда раньше: props.data имеет форму, описанную в статье Проекция формы, с самой первой отрисовки, поэтому ничего в нём не нужно проверять на ещё не пришедшую проекцию.

Компонент, который рисует одну строку, получает её как props.row, когда его отрисовывает List:

function Row(props) {
const r = props.row;
return (
<div className={r.current ? "order order-current" : "order"}>
<span>{r.number.value}</span>
<span>{r.sum.value}</span>
</div>
);
}

Глобальные переменные времени выполнения​

Компоненты и хуки платформы — глобальные переменные времени выполнения в window.lsfusion, как и custom.register, который регистрирует компонент для CUSTOM. Каждая из них описана в своём разделе:

ИмяРаздел
useData, useControllerЧтение проекции
ListОтрисовка строк
BucketScope, useBucket, BucketsРаскладка строк по ячейкам
useSeekOnScrollОтслеживание прокрутки
ImageОтрисовка изображения
CaptionОтрисовка заголовка
Platform, usePlatform, useShownРазмещение дочернего компонента
useVisibleСкрытое представление
custom.registerКомпонент React в CUSTOM

Компонент React и HTML-шаблон​

Для компонента, который только размещает потомков и ничего не читает из props.data, см. также места HTML-шаблона. Если платформа рисует все дочерние компоненты контейнера, в props.data нет ни значений групп, ни значений свойств, поскольку такой компонент не проецируется, — только записи { caption, image, hidden } дочерних компонентов в props.data.

Компонент React тоже называет свои дочерние компоненты: чтобы добавить дочерний компонент, нужно изменить JSX, одного DESIGN недостаточно.