@soxa-ui/setup 0.0.0-stage → 0.3.0-beta.1

package/dist/content/descriptors/components/table/row.descriptor.d.ts

@@ -0,0 +1,166 @@
+/**
+ * Дескриптор TableRow (TTableRow) — строка таблицы.
+ *
+ * Наследует `StylableDescriptor`, а не `ControlDescriptor`, как день
+ * календаря: плагины Control строке не подходят. `TActionPlugin` дал бы
+ * строке нажатие, хотя в роли `table` нажатие по строке ничего не делает —
+ * выбирают чекбоксом, — а `TAriaPlugin` — имя, которое строке не нужно: её
+ * называет заголовок строки.
+ *
+ * Строку рисует таблица — по строке на показанную, над её экземпляром
+ * (`ctrl`), — а строки задаются только данными (`items`). Входов у строки нет:
+ * запись, «выключена», размер и вариант кладут в неё данные и таблица, и всё
+ * это только читается, поэтому объявлено защищённым.
+ *
+ * Плагин связок пишет `id` заголовка строки в её набор `headerAria`: на него
+ * ссылается имя чекбокса выбора строки.
+ */
+import { TTableRow } from '@soxa-ui/core';
+import type { ITableColumn, ITableRow } from '@soxa-ui/core';
+export declare const TableRowDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTableRow;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TStylable;
+        readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+            readonly ctor: typeof import("@soxa-ui/core").TComponentView;
+            readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+                readonly ctor: typeof import("@soxa-ui/core").TComponent;
+                readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+                    readonly contribution: {
+                        readonly props: {
+                            readonly ctrl: {
+                                readonly type: ObjectConstructor;
+                            };
+                            readonly embedded: {
+                                readonly type: StringConstructor;
+                            };
+                            readonly pluginProps: {
+                                readonly type: ObjectConstructor;
+                            };
+                        };
+                        readonly events: readonly ["bundle:create", "plugin:event"];
+                    };
+                }>>;
+                readonly contribution: {};
+            }>>;
+            readonly contribution: {
+                readonly slots: {
+                    readonly default: {
+                        readonly description: "Содержимое компонента";
+                    };
+                };
+                readonly props: {
+                    readonly rendered: {
+                        readonly type: BooleanConstructor;
+                        readonly triggers: readonly ["change:rendered"];
+                    };
+                    readonly visible: {
+                        readonly type: BooleanConstructor;
+                        readonly triggers: readonly ["change:visible"];
+                    };
+                    readonly present: {
+                        readonly type: BooleanConstructor;
+                        readonly protected: true;
+                        readonly triggers: readonly ["change:rendered", "change:visible"];
+                    };
+                    readonly tag: {
+                        readonly type: readonly [StringConstructor, ObjectConstructor];
+                        readonly triggers: readonly ["change:tag"];
+                    };
+                    readonly direction: {
+                        readonly type: StringConstructor;
+                        readonly triggers: readonly ["change:direction"];
+                    };
+                    readonly classes: {
+                        readonly type: ObjectConstructor;
+                        readonly protected: true;
+                        readonly triggers: readonly ["change:classes"];
+                    };
+                    readonly aria: {
+                        readonly type: ObjectConstructor;
+                        readonly protected: true;
+                        readonly triggers: readonly ["change:aria"];
+                    };
+                    readonly dataset: {
+                        readonly type: ObjectConstructor;
+                        readonly protected: true;
+                        readonly triggers: readonly ["change:dataset"];
+                    };
+                    readonly attrs: {
+                        readonly type: ObjectConstructor;
+                        readonly protected: true;
+                        readonly triggers: readonly ["change:attrs"];
+                    };
+                };
+                readonly events: readonly ["show", "hide", "show:before", "hide:before", "ready", "change:rendered", "change:visible", "change:tag", "change:direction"];
+            };
+            readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TElementPlugin, "element", {
+                readonly events: readonly ["ready", "removed"];
+            }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TReadyPlugin, "ready", import("../../../..").IContribution>>];
+        }>>;
+        readonly contribution: {
+            readonly props: {
+                readonly size: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:size"];
+                };
+                readonly variant: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:variant"];
+                };
+            };
+            readonly events: readonly ["change:size", "change:variant"];
+        };
+    }>>;
+    readonly contribution: {
+        readonly slots: {
+            /**
+             * Ячейка строки — scope слота `cell` таблицы: строку в него кладёт
+             * сама строка, и таблица отдаёт в него свой слот как есть, ничего не
+             * добавляя.
+             */
+            readonly cell: {
+                readonly scope: {
+                    readonly row: import("../../../..").TPropType<ITableRow<import("@soxa-ui/core").ITableRowProps, import("@soxa-ui/core").TTableRowEvents>>;
+                    readonly column: import("../../../..").TPropType<ITableColumn<import("@soxa-ui/core").ITableColumnProps, import("@soxa-ui/core").TTableColumnEvents>>;
+                    readonly value: import("../../../..").TPropType<unknown>;
+                };
+                readonly description: "Содержимое ячейки. Без него — значение текстом";
+            };
+        };
+        readonly props: {
+            readonly disabled: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:disabled"];
+            };
+            readonly focused: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:focused"];
+            };
+            readonly data: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:data"];
+            };
+            /**
+             * Атрибуты заголовка строки. Набор строки, а не свой: ячейка —
+             * разметка строки, экземпляра у неё нет.
+             */
+            readonly headerAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:headerAria"];
+            };
+            readonly size: {
+                readonly protected: true;
+            };
+            readonly variant: {
+                readonly protected: true;
+            };
+        };
+        readonly events: readonly ["change:disabled", "change:focused"];
+    };
+    readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableRowIdsPlugin, "ids", import("../../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/table/row.descriptor.js

@@ -0,0 +1,75 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { TableRowIdsPluginDescriptor } from "../../plugins/table-row-ids.plugin.js";
+import { OWNER_STYLE_PROPS, StylableDescriptor } from "../stylable.descriptor.js";
+import { TTableRow } from "@soxa-ui/core";
+//#region content/descriptors/components/table/row.descriptor.ts
+/**
+* Дескриптор TableRow (TTableRow) — строка таблицы.
+*
+* Наследует `StylableDescriptor`, а не `ControlDescriptor`, как день
+* календаря: плагины Control строке не подходят. `TActionPlugin` дал бы
+* строке нажатие, хотя в роли `table` нажатие по строке ничего не делает —
+* выбирают чекбоксом, — а `TAriaPlugin` — имя, которое строке не нужно: её
+* называет заголовок строки.
+*
+* Строку рисует таблица — по строке на показанную, над её экземпляром
+* (`ctrl`), — а строки задаются только данными (`items`). Входов у строки нет:
+* запись, «выключена», размер и вариант кладут в неё данные и таблица, и всё
+* это только читается, поэтому объявлено защищённым.
+*
+* Плагин связок пишет `id` заголовка строки в её набор `headerAria`: на него
+* ссылается имя чекбокса выбора строки.
+*/
+var TableRowDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTableRow,
+	extends: StylableDescriptor(),
+	contribution: {
+		slots: { 
+		/**
+		* Ячейка строки — scope слота `cell` таблицы: строку в него кладёт
+		* сама строка, и таблица отдаёт в него свой слот как есть, ничего не
+		* добавляя.
+		*/
+cell: {
+			scope: {
+				row: defineType(Object),
+				column: defineType(Object),
+				value: defineType(Object)
+			},
+			description: "Содержимое ячейки. Без него — значение текстом"
+		} },
+		props: {
+			...OWNER_STYLE_PROPS,
+			disabled: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:disabled"]
+			},
+			focused: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:focused"]
+			},
+			data: {
+				type: Object,
+				protected: true,
+				triggers: ["change:data"]
+			},
+			/**
+			* Атрибуты заголовка строки. Набор строки, а не свой: ячейка —
+			* разметка строки, экземпляра у неё нет.
+			*/
+			headerAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:headerAria"]
+			}
+		},
+		events: ["change:disabled", "change:focused"]
+	},
+	plugins: [TableRowIdsPluginDescriptor]
+}));
+//#endregion
+export { TableRowDescriptor };

package/dist/content/descriptors/components/table/table.descriptor.d.ts

@@ -0,0 +1,271 @@
+/**
+ * Дескриптор Table (TTable) — таблица по паттернам APG Table и Sortable Table.
+ *
+ * Наследует `ControlDescriptor` (disabled, focused, size, variant, имя
+ * `aria_label` / `aria_labelledBy`, ...) и добавляет язык сортировки — тег
+ * локали поддерева, его пишет плагин языка, — имя чекбокса «выбрать все» —
+ * выход плагина имён (`names_selectAll`), — закреплённую шапку
+ * (`stickyHead`): свойство вида таблицы, теме оно уходит `data-sticky-head`
+ * в наборе `dataset` корня, — то, как колонки без своей ширины делят место
+ * (`columnFit`): его читает раскладка колонок, а не тема. Место мерит плагин
+ * раскладки — ширину окна таблицы, — и тема получает от ядра готовые ширины
+ * колонок и признаки корня: `data-overflow` (колонки шире места) и
+ * `data-sized` (ширина известна у каждой показанной колонки). И то, что идёт
+ * за жестом перестановки колонки (`reorderPreview`): ничего, шапка или колонка
+ * целиком, — его читает расширение колонок, и только в жесте `column` у корня
+ * есть признак `data-reorder-preview`. Признаки жеста у корня ставит то же
+ * расширение, и только на время жеста: `data-resizing` — тянут ручку
+ * показанной колонки, `data-dragging` — переставляют колонку; по ним тема
+ * держит курсор жеста на всей таблице. Строки, колонки, ячейки, выбор и
+ * сортировка — коллекция и её расширения (`TableCollectionDescriptor`):
+ * разметка только раскладывает то, что они отдали.
+ *
+ * Колонки и строки задаются только данными (`columns`, `items`): частей
+ * разметкой у таблицы нет — заголовок колонки (`Table.Column`) и строку
+ * (`Table.Row`) рисует она сама. Поэтому и слота по умолчанию у неё нет, а
+ * содержимое заголовка и ячейки — статические слоты со scope: колонку
+ * выбирают условием по `column.field`, как элемент коллекции по `item.value`
+ * (AGENTS.md, «Слоты элементов»).
+ */
+import { TTable } from '@soxa-ui/core';
+import type { ITableColumn, ITableRow } from '@soxa-ui/core';
+export declare const TableDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTable;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TControl;
+        readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+            readonly ctor: typeof import("@soxa-ui/core").TStylable;
+            readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+                readonly ctor: typeof import("@soxa-ui/core").TComponentView;
+                readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+                    readonly ctor: typeof import("@soxa-ui/core").TComponent;
+                    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+                        readonly contribution: {
+                            readonly props: {
+                                readonly ctrl: {
+                                    readonly type: ObjectConstructor;
+                                };
+                                readonly embedded: {
+                                    readonly type: StringConstructor;
+                                };
+                                readonly pluginProps: {
+                                    readonly type: ObjectConstructor;
+                                };
+                            };
+                            readonly events: readonly ["bundle:create", "plugin:event"];
+                        };
+                    }>>;
+                    readonly contribution: {};
+                }>>;
+                readonly contribution: {
+                    readonly slots: {
+                        readonly default: {
+                            readonly description: "Содержимое компонента";
+                        };
+                    };
+                    readonly props: {
+                        readonly rendered: {
+                            readonly type: BooleanConstructor;
+                            readonly triggers: readonly ["change:rendered"];
+                        };
+                        readonly visible: {
+                            readonly type: BooleanConstructor;
+                            readonly triggers: readonly ["change:visible"];
+                        };
+                        readonly present: {
+                            readonly type: BooleanConstructor;
+                            readonly protected: true;
+                            readonly triggers: readonly ["change:rendered", "change:visible"];
+                        };
+                        readonly tag: {
+                            readonly type: readonly [StringConstructor, ObjectConstructor];
+                            readonly triggers: readonly ["change:tag"];
+                        };
+                        readonly direction: {
+                            readonly type: StringConstructor;
+                            readonly triggers: readonly ["change:direction"];
+                        };
+                        readonly classes: {
+                            readonly type: ObjectConstructor;
+                            readonly protected: true;
+                            readonly triggers: readonly ["change:classes"];
+                        };
+                        readonly aria: {
+                            readonly type: ObjectConstructor;
+                            readonly protected: true;
+                            readonly triggers: readonly ["change:aria"];
+                        };
+                        readonly dataset: {
+                            readonly type: ObjectConstructor;
+                            readonly protected: true;
+                            readonly triggers: readonly ["change:dataset"];
+                        };
+                        readonly attrs: {
+                            readonly type: ObjectConstructor;
+                            readonly protected: true;
+                            readonly triggers: readonly ["change:attrs"];
+                        };
+                    };
+                    readonly events: readonly ["show", "hide", "show:before", "hide:before", "ready", "change:rendered", "change:visible", "change:tag", "change:direction"];
+                };
+                readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TElementPlugin, "element", {
+                    readonly events: readonly ["ready", "removed"];
+                }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TReadyPlugin, "ready", import("../../../..").IContribution>>];
+            }>>;
+            readonly contribution: {
+                readonly props: {
+                    readonly size: {
+                        readonly type: StringConstructor;
+                        readonly triggers: readonly ["change:size"];
+                    };
+                    readonly variant: {
+                        readonly type: StringConstructor;
+                        readonly triggers: readonly ["change:variant"];
+                    };
+                };
+                readonly events: readonly ["change:size", "change:variant"];
+            };
+        }>>;
+        readonly contribution: {
+            readonly props: {
+                readonly disabled: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:disabled"];
+                };
+                readonly focused: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:focused"];
+                };
+            };
+            readonly events: readonly ["change:disabled", "change:focused"];
+        };
+        readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TActionPlugin, "action", {
+            readonly events: readonly ["press", "click", "focus", "blur"];
+        }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TAriaPlugin, "aria", {
+            readonly props: {
+                readonly label: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:label"];
+                };
+                readonly labelledBy: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:labelledBy"];
+                };
+                readonly describedBy: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:describedBy"];
+                };
+            };
+            readonly events: readonly ["change:label", "change:labelledBy", "change:describedBy"];
+        }>>];
+    }>>;
+    readonly contribution: {
+        readonly slots: {
+            /**
+             * Проброс слота заголовка колонки (`Table.Column`): его scope — текст
+             * и сортируемость колонки — плюс сама колонка.
+             */
+            readonly header: {
+                readonly scope: {
+                    readonly column: import("../../../..").TPropType<ITableColumn<import("@soxa-ui/core").ITableColumnProps, import("@soxa-ui/core").TTableColumnEvents>>;
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly sortable: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Содержимое заголовка колонки. Без него — текст колонки";
+            };
+            /**
+             * `value` — поле записи под ключом колонки. Тип записи таблица не
+             * знает (`TTableRecord` — любой объект), поэтому значение —
+             * `unknown`, и сужает его потребитель.
+             */
+            readonly cell: {
+                readonly scope: {
+                    readonly row: import("../../../..").TPropType<ITableRow<import("@soxa-ui/core").ITableRowProps, import("@soxa-ui/core").TTableRowEvents>>;
+                    readonly column: import("../../../..").TPropType<ITableColumn<import("@soxa-ui/core").ITableColumnProps, import("@soxa-ui/core").TTableColumnEvents>>;
+                    readonly value: import("../../../..").TPropType<unknown>;
+                };
+                readonly description: "Содержимое ячейки. Без него — значение текстом";
+            };
+            readonly empty: {
+                readonly description: "Когда показанных строк нет";
+            };
+        };
+        readonly props: {
+            /**
+             * Язык сортировки — не вход: это тег локали поддерева, и пишет его
+             * плагин языка, как `size` элементам пишет владелец.
+             */
+            readonly locale: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:locale"];
+            };
+            /**
+             * Шапка закреплена у верхнего края прокрутки, по умолчанию нет.
+             * Свойство таблицы, а не коллекции: строки и колонки от него не
+             * меняются, а закрепляет шапку тема по `data-sticky-head`.
+             */
+            readonly stickyHead: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:stickyHead"];
+            };
+            /**
+             * Как колонки без своей ширины делят место, по умолчанию `auto` —
+             * во всю ширину места. Значение библиотеки: его читает раскладка
+             * колонок, а теме оно не уходит.
+             */
+            readonly columnFit: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:columnFit"];
+            };
+            /**
+             * Что идёт за жестом перестановки колонки: `none` — только взятый
+             * заголовок, соседи стоят, колонка встаёт на отпускании; по
+             * умолчанию `head` — шапка, а тело стоит до отпускания; `column` —
+             * и ячейки нарисованных строк. Модель от него не меняется. Значение читает
+             * расширение колонок, а не тема: в `column` оно ставит корню
+             * `data-reorder-preview` только на время жеста, и тело тема ведёт
+             * по этому признаку — на покое таблица за режим не платит.
+             */
+            readonly reorderPreview: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:reorderPreview"];
+            };
+            /**
+             * Что идёт за протяжкой ручки ширины: по умолчанию `live` — сама
+             * колонка; `deferred` — призрак новой границы, а ширина пишется
+             * на отпускании. Значение читает ядро колонки, а теме уходит
+             * только признак отложенного жеста на заголовке.
+             */
+            readonly resizePreview: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:resizePreview"];
+            };
+            /**
+             * Ручка ширины у колонок без своего `resizable`, по умолчанию нет.
+             * Своё значение колонки сильнее — исключение в обе стороны.
+             */
+            readonly resizable: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:resizable"];
+            };
+            /**
+             * Перестановка колонок без своего `reorderable`, по умолчанию нет.
+             * Своё значение колонки сильнее.
+             */
+            readonly reorderable: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:reorderable"];
+            };
+        };
+        readonly events: readonly ["change:locale", "change:stickyHead", "change:columnFit", "change:reorderPreview", "change:resizePreview", "change:resizable", "change:reorderable"];
+    };
+    readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TLocalePlugin, "locale", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableNamesPlugin, "names", {
+        readonly props: {
+            readonly selectAll: {
+                readonly protected: true;
+                readonly triggers: readonly ["change:selectAll"];
+            };
+        };
+    }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TCollectionBundlesPlugin, "bundles", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TCollectionElements, "elements", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableLayoutPlugin, "layout", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableColumnReorderPlugin, "reorder", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableGridPlugin, "grid", import("../../../..").IContribution>>];
+}>>;