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

Собственные представления компонентов и CUSTOM

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

Собственное представление компонента​

Атрибут custom компонента задаёт его представление React:

DESIGN items {
GRID(TREE t) { custom = 'CategoryTree'; } // тулбар и фильтры над строками остаются платформенными
TOOLBARSYSTEM(j) { custom = 'OrderToolbar'; } // над платформенным гридом j
}

custom таблицы группы объектов, GRID(i), — другое: это CUSTOM группы, функция отображения одного из видов, в которых платформа показывает строки группы (Компонент React в CUSTOM).

Компонент получает то же, что получил бы контейнер, в котором стоит только этот компонент, — NEW bar { custom = 'OrderToolbar'; MOVE TOOLBARSYSTEM(j); }: часть группы или дерева на её узле, под теми же именами (таблица частей и узлов) — состояние и члены тулбара на data.j и controller.j, строки дерева на узлах его групп, а его собственное — на data.<tree>, группа фильтров — на data.<group>.<filterGroup>, фильтр по свойству — на data.<group>.filter.<property>. Больше на верхнем уровне ничего нет.

Собственные атрибуты дизайна компонента относятся к его представлению, как и к его представлению платформы: размер и место в контейнере, класс и SHOWIF, который прячет представление, — поэтому в его данных нет записи самого компонента, которая была бы у контейнера вокруг него. Внутри того, что рисует React-контейнер, у компонента собственное представление, и контейнер размещает его через <Platform name="TOOLBARSYSTEM(j)"/>: запись компонента — в данных контейнера, а его части — в данных его собственного представления. Свойство, которое платформа рисует в строках, которые оно рисует, размещается построчно через <Platform name row/>; ничего другого оно не размещает.

Ограничения custom.

Атрибуты платформенной таблицы — valueClass таблицы, заданный свойством, hierarchicalCaption дерева — для её собственного представления ничего не значат, как и для таблицы, которую рисует React-контейнер: проекция не несёт ни того, ни другого.

Компонент React в CUSTOM​

Опция CUSTOM свойства в блоке PROPERTIES и группы объектов в блоке OBJECTS задаёт функцию отображения, и такой функцией может быть компонент React. Свойство или группа остаются платформенными: они стоят там, куда их помещает дизайн формы, а компонент рисует только то, что рисовала бы функция отображения, — одну ячейку свойства или строки группы.

Компонент от классической функции отображения свойства или группы объектов веб-клиент отличает по тому, как зарегистрировано имя: компонент регистрируется с видом reactView, а любое другое имя — классическая функция, с какой бы буквы оно ни начиналось. Само имя здесь этого не определяет, в отличие от custom контейнера: классическая функция может называться так же, как называют компоненты. Именованный экспорт собранного модуля регистрируется без вида, а функция файла .jsx не регистрируется вовсе, поэтому модуль регистрирует компонент явно:

function Quantity({data, controller}) {
return <button disabled={data.readOnly || data.disabled}
onClick={() => controller.change((data.value ?? 0) + 1)}>
{data.value}
</button>;
}

window.lsfusion.custom.register('Quantity', Quantity, 'reactView');
FORM items
OBJECTS i = Item
PROPERTIES(i) READONLY name
PROPERTIES(i) quantity CUSTOM 'Quantity'
;

Компонент свойства рисует одну ячейку: ячейку таблицы или значение свойства на панели. data описывает эту ячейку — её value, readOnly, disabled, loading, background, foreground, placeholder, pattern, regexp, regexpMessage, defaultValue, valueTooltip и options, а также type и askConfirm свойства — те же поля и в том же смысле, что и у записи панельного свойства, которое рисует представление; опция, для которой платформа ничего не вычислила, отсутствует. controller — это член свойства для этой ячейки: change(value), exec() и getValues(query, {mode, count}), каждый из которых возвращает Promise своего запроса, и контроллер формы в controller.form. Строка в вызове не указывается: в таблице вызов изменяет строку ячейки, какая бы строка ни была текущей, а на панели — текущий объект формы. Значение компонент изменяет только этими вызовами (редактирование при CUSTOM). Можно ли изменять ячейку, проверяет сервер, как и для классической функции отображения, поэтому изменение ячейки, доступной только для чтения, не выполняется.

Таблица использует элемент ячейки для другой строки, когда её строки сортируются или прокручиваются. Компонент при этом остаётся смонтированным и сохраняет своё состояние: он получает data другой строки, а его controller, который остаётся тем же объектом, изменяет ту строку, которую ячейка показывает в момент вызова, — в том числе после await. Представление, которое само рисует строки, размещает такое свойство так же, как и любое свойство, которое рисует платформа, — через <Platform name row/>, и компонент рисуется в дереве этого представления.

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

Атрибут custom таблицы — см. DESIGN. Компоненту передаётся его единственная группа, без имени над ней: data — узел группы, такой же, какой контейнер, рисующий строки группы, получает под именем группы (Чтение проекции), — её строки (data.list, data.byKey, data.keys), записи её свойств, её сортировки и фильтры представления и OPTIONS группы в data.options, — а controller — член группы: change(row), orders.change(...), viewFilters.change(...) и член на каждое свойство, — с контроллером формы в controller.form и с controller.batch. List и BucketScope там задаются без group. Свойство, которому форма задаёт собственное представление, — NOCUSTOM или функция отображения CUSTOM, — компонент не рисует, а размещает в каждой строке по одному его имени: <Platform name="quantity" row={row}/>; ничего другого компонент не размещает. Таблица принимает размер того, что рисует компонент, как любой вид CUSTOM, а тулбар переключает её с другими видами строк, которые даёт платформа. Тулбар и пользовательские фильтры группы остаются за платформой, которая рисует их вокруг компонента, поэтому в data и controller для них ничего нет. Свойство, имя которого — зарезервированное имя строки или узла группы там, где рисуются её строки, либо form или batch, не передаётся, как и свойство, сгруппированное по колонкам (COLUMNS): форма из-за него не отклоняется, так как сервер не знает, что функция отображения — компонент. Внутри контейнера, который рисует представление React, грид такой группы рисует платформа, а представление размещает его через <Platform name="GRID(i)"/>.

Компонент React внутри представления React​

Дочерний компонент, который рисует платформа, сам может быть нарисован компонентом React: свойство или группа, у которых в CUSTOM указан компонент, таблица с таким свойством, контейнер или другой компонент с собственным custom. Когда представление формы размещает такой дочерний компонент через <Platform> — целиком или его ячейку в строке, — компонент рисуется в дереве React этого представления, на месте <Platform>, а не в собственном корне React.

  • Контекст, который представление задаёт вокруг <Platform>, доходит до компонента, сколько бы компонентов ни было в размещённом дочернем компоненте, — в таблице он есть в каждой строке. props.data и props.controller, а значит, и useData и useController внутри компонента остаются собственными для компонента.
  • Событие в компоненте всплывает через обработчики React элементов вокруг <Platform>. Обработчики компонента, а за ними эти обработчики представления выполняются раньше, чем платформа обработает событие в ячейке — выберет строку, обработает клавишу, — поэтому stopPropagation() в любом из них не пропускает событие к платформе, а в компоненте — и к обработчикам представления.
  • Компонент, который выбросил ошибку при рисовании, показывает сообщение на своём месте, а представление вокруг него остаётся. Компонент, который приостановил рисование, показывает запасное содержимое ближайшего Suspense над ним — если у компонента нет собственного, это Suspense представления, вокруг всего размещённого дочернего компонента.
  • Компонент смонтирован, пока есть его место: когда представление перестаёт рендерить <Platform>, даёт ему другое имя или Suspense вокруг него показывает запасное содержимое, компонент размонтируется и теряет своё состояние, а когда дочерний компонент размещается снова, монтируется заново. Дочерний компонент, который не размещает ни один <Platform>, не рисуется. То, что платформа сохраняет для неразмещённого дочернего компонента, — например, редактор строки, пока строка не рендерится, — это её собственное представление, а не состояние компонента, который в нём нарисован.

Дочерний компонент, место которого отрендерено, но скрыто, остаётся размещённым: скрытие его места не прекращает чтение его сервером.

Когда убирать и возвращать приходится само место — собственные вкладки, которые рендерят только активный дочерний компонент, чтобы остальные не читались, или строка списка, которая не рендерится, пока прокручена за пределы экрана, — а компоненты внутри должны при этом сохранять своё состояние, задайте месту ownRoot, ценой контекста и границ Suspense, которые есть у представления вокруг места:

<Platform key={active} name={active} ownRoot/>
// или: usePlatform(active, { ownRoot: true })

Тогда каждый компонент в том, что размещено в таком месте, рисуется в собственном корне React и остаётся смонтированным, со своим состоянием, пока дочерний компонент не размещён ни в одном месте, — до закрытия формы. До него при этом не доходят ни контекст, ни границы Suspense представления вокруг <Platform>; событие в нём по-прежнему доходит до обработчиков представления вокруг места — после того, как его обработает платформа. Целый дочерний компонент, который не размещён, не читается: компонент сохраняет те data, которые у него были, пока дочерний компонент не будет размещён снова, а его эффекты и таймеры продолжают работать с этими data. Неразмещённый редактор строки продолжает получать свои data и существует, пока его строка не уйдёт из строк группы. Задавайте месту ownRoot при первом размещении дочернего компонента и не меняйте его: однажды созданный собственный корень сохраняется, где бы дочерний компонент ни размещался потом, а компонент, созданный позже, — ячейка новой строки — рисуется в собственном корне, если у его места есть ownRoot, и в дереве размещающего представления, если нет. Компонент в таком месте, который сам является представлением, рисует то, что он размещает собственным <Platform>, в своём дереве.

Там, где компонент не размещает ни одно представление формы, — в таблице или на панели, которые располагает платформа, — он рисуется в собственном корне React, отдельном для каждой ячейки, и никакой контекст до него не доходит. Форма в окне форм и окно в расположении окон тоже остаются в собственных корнях: открытая форма, которую не показывает ни один <Platform>, остаётся открытой, и её компоненты сохраняют своё состояние. То же верно для формы, показанной внутри другой формы — в контейнере или в ячейке, которые размещает представление той формы: компонент рисуется только в дереве представления собственной формы, — и для того, что форма показывает вне своего места: содержимого всплывающего контейнера, записи таблицы.