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

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

@@ -0,0 +1,178 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { CollectionDescriptor } from "../collection/collection.descriptor.js";
+import { TTableCollectionFacade, TTableRowCollectionFacade } from "@soxa-ui/core";
+//#region content/descriptors/components/table/collection.descriptor.ts
+/**
+* Дескрипторы коллекционной части Table — фасады таблицы и строки.
+*
+* Членство в коллекции отделено от собственных пропсов компонента
+* (`TableDescriptor`, `TableRowDescriptor`): адаптер собирает компонент из
+* обоих рантайм-списков.
+*/
+var TableCollectionDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTableCollectionFacade,
+	extends: CollectionDescriptor(),
+	/**
+	* Коллекционные props таблицы — то, что выводит фасад
+	* `TTableCollectionFacade`: режим выбора строк, колонки данными,
+	* сортировка и режим сетки; выходы — колонки, выбор, набор ячейки
+	* выбора и строки шапки и что рисует тело; события — ширина и место,
+	* которые пользователь задал колонке. Окно — не проп: его ставит обёртка
+	* `Virtual`.
+	*/
+	contribution: {
+		props: {
+			/** Режим выбора строк. `none` (по умолчанию) — колонки выбора нет */
+			mode: {
+				type: String,
+				triggers: ["change:mode"]
+			},
+			/**
+			* Колонки данными: сверка по `field`. Читаются экземпляры колонок,
+			* пишутся данные — как `items` у строк
+			*/
+			columns: {
+				type: Array,
+				triggers: ["change:shownColumns"]
+			},
+			sort: {
+				type: Array,
+				triggers: ["change:sort"]
+			},
+			sortMode: {
+				type: String,
+				triggers: ["change:sortMode"]
+			},
+			presorted: {
+				type: Boolean,
+				triggers: ["change:presorted"]
+			},
+			/**
+			* Режим сетки (APG Data Grid): одна остановка Tab, стрелки по
+			* ячейкам, строку выбирают нажатием и пробелом
+			*/
+			grid: {
+				type: Boolean,
+				triggers: ["change:grid"]
+			},
+			/**
+			* Что рисует тело по порядку: строки на своих местах и, в окне,
+			* распорки на месте пропущенных. Без окна — все показанные строки
+			*/
+			drawn: {
+				type: Array,
+				protected: true,
+				triggers: ["change:drawn"]
+			},
+			/** Набор строки шапки — у неё нет экземпляра. В окне — её номер */
+			headRowAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:headRowAria"]
+			},
+			/**
+			* Набор ячейки колонки выбора в шапке — у неё нет экземпляра. В сетке
+			* ячейка принимает фокус, вне сетки набор пуст.
+			*/
+			cellAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:cellAria"]
+			},
+			selected: {
+				type: Array,
+				protected: true,
+				triggers: ["change:selection"]
+			},
+			/** Заголовки шапки — по одному на показанную колонку, в её порядке */
+			shownColumns: {
+				type: Array,
+				protected: true,
+				triggers: ["change:shownColumns"]
+			},
+			shownSelection: {
+				type: String,
+				protected: true,
+				triggers: ["change:shownSelection"]
+			},
+			/**
+			* Сколько колонок в строке вместе с колонкой выбора — `colspan`
+			* ячейки пустой таблицы. Посчитанное в разметке повторилось бы в
+			* каждом адаптере.
+			*/
+			columnCount: {
+				type: Number,
+				protected: true,
+				triggers: ["change:shownColumns", "change:selecting"]
+			}
+		},
+		/**
+		* Пользователь задал ширину колонки ручкой — одно событие на действие,
+		* с колонкой и итогом её ширины; переставил колонку — одно событие на
+		* действие, с колонкой и новым порядком полей. По ним приложение
+		* сохраняет настройку.
+		*/
+		events: [
+			"column:resize",
+			"column:move",
+			"change:mode",
+			"change:shownColumns",
+			"change:sort",
+			"change:sortMode",
+			"change:presorted",
+			"change:grid",
+			"change:selection",
+			"change:shownSelection"
+		]
+	}
+}));
+var TableCollectionRowDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTableRowCollectionFacade,
+	/**
+	* Item-level пропсы строки — то, что выводит фасад
+	* `TTableRowCollectionFacade`: выбор, ячейки, имя строки, включён ли
+	* выбор строк и набор ячеек сетки.
+	*/
+	contribution: {
+		props: {
+			selected: {
+				type: Boolean,
+				triggers: ["change:selected"]
+			},
+			/** Ячейки — по одной на показанную колонку, в её порядке */
+			cells: {
+				type: Array,
+				protected: true,
+				triggers: ["change:cells"]
+			},
+			/**
+			* `id` заголовка строки — им называют чекбокс выбора строки. Пока
+			* колонки заголовка нет или она скрыта, ссылки нет.
+			*/
+			rowHeaderId: {
+				type: String,
+				protected: true,
+				triggers: ["change:cells"]
+			},
+			/** Выбор строк включён — у строки ячейка выбора */
+			selecting: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:selecting"]
+			},
+			/**
+			* Набор каждой ячейки строки, и ячейки выбора тоже: у ячеек нет
+			* экземпляра. В сетке ячейка принимает фокус, вне сетки набор пуст.
+			*/
+			cellAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:cellAria"]
+			}
+		},
+		events: ["change:selected"]
+	}
+}));
+//#endregion
+export { TableCollectionDescriptor, TableCollectionRowDescriptor };

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

@@ -0,0 +1,237 @@
+/**
+ * Дескриптор TableColumn (TTableColumn) — заголовок колонки таблицы.
+ *
+ * Наследует `ComponentViewDescriptor`, а не `ControlDescriptor`: нажатия,
+ * фокуса и имени у заголовка нет — нажимают кнопку сортировки и ручку ширины в
+ * нём, — а `disabled` колонке пишет таблица — для них. Колонку рисует
+ * таблица — по заголовку на показанную колонку, над её экземпляром (`ctrl`),
+ * как Calendar рисует день, — а колонки задаются только данными (`columns`).
+ * Поэтому входов у части нет: всё своё у колонки объявлено защищённым и
+ * только читается.
+ *
+ * Корень — ячейка шапки (`th`), на ней наборы колонки (`aria-sort`,
+ * `aria-labelledby`, `data-sort`, `data-sort-priority`, `data-align`,
+ * `data-sized` — ширина известна, своя или раскладки, — `data-resizing`,
+ * `data-reorderable`, а в жесте перестановки — `data-dragging` и `data-drop`)
+ * и ширина переменной (`widthStyle`). Ширину колонки без своей ширины
+ * раскладывает таблица — расширение колонок по месту, которое мерит плагин
+ * раскладки таблицы. Перестановку ведёт плагин таблицы, а не колонки: место
+ * колонки знает коллекция колонок.
+ *
+ * Содержимое — ряд: подпись — слот по умолчанию с набором `textAria`, у всех
+ * колонок, — и за ней у сортируемой колонки кнопка сортировки с набором
+ * `sortAria`. Кнопку рисует сама колонка, а не таблица через слот: заголовок
+ * назван подписью, и кнопка в ней дописала бы своё имя к имени заголовка, а
+ * второй слот колонки стал бы публичным слотом таблицы. Нажатие кнопки —
+ * просьба колонки (`toggleSort`), сортирует расширение коллекции строк. Своё
+ * действие по заголовку потребитель ставит контролом в подпись (слот
+ * `header` таблицы): у `th` фокуса нет. За рядом — ручка ширины
+ * (`resizerRendered`): поле с ходом и шириной (`resizer`) и набором
+ * `resizerAria`.
+ *
+ * Плагин связок называет заголовок и поле ручки подписью, плагин имён —
+ * кнопку сортировки, от локали, плагин ручки ведёт указатель и клавиши.
+ */
+import { TTableColumn } from '@soxa-ui/core';
+export declare const TableColumnDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTableColumn;
+    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 slots: {
+            readonly default: {
+                readonly scope: {
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly sortable: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Подпись заголовка. Без него — текст колонки";
+            };
+        };
+        readonly props: {
+            readonly field: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:field"];
+            };
+            readonly text: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:text"];
+            };
+            readonly width: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:width"];
+            };
+            readonly minWidth: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:minWidth"];
+            };
+            readonly maxWidth: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:maxWidth"];
+            };
+            readonly align: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:align"];
+            };
+            readonly sortable: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:sortable"];
+            };
+            readonly compare: {
+                readonly type: FunctionConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:compare"];
+            };
+            readonly rowHeader: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:rowHeader"];
+            };
+            readonly resizable: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:resizable"];
+            };
+            readonly reorderable: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:reorderable"];
+            };
+            readonly disabled: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:disabled"];
+            };
+            /**
+             * Ширина колонки — `--so-table-column-width`. Считает ядро: в шести
+             * адаптерах одна формула была бы шесть раз.
+             */
+            readonly widthStyle: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:width"];
+            };
+            /**
+             * Рисовать ли ручку ширины: колонка `resizable`, не выключена, и
+             * ширина известна — своя или раскладки. Формулу считает ядро —
+             * разметка без экземпляра её не повторяет.
+             */
+            readonly resizerRendered: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:resizerRendered"];
+            };
+            /**
+             * Поле ручки: ход и ширина в px. Своего экземпляра у ручки нет —
+             * поле отдаётся значением, как ручки Slider.
+             */
+            readonly resizer: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:resizer"];
+            };
+            /**
+             * Атрибуты поля ручки, подписи и кнопки сортировки. Наборы колонки,
+             * а не свои: у разметки без компонента экземпляра нет.
+             */
+            readonly resizerAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:resizerAria"];
+            };
+            readonly textAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:textAria"];
+            };
+            readonly sortAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:sortAria"];
+            };
+        };
+        readonly events: readonly ["change:text", "change:disabled"];
+    };
+    readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableColumnIdsPlugin, "ids", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableColumnNamesPlugin, "names", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TTableColumnResizePlugin, "resize", import("../../../..").IContribution>>];
+}>>;

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

@@ -0,0 +1,173 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { TableColumnIdsPluginDescriptor } from "../../plugins/table-column-ids.plugin.js";
+import { TableColumnResizePluginDescriptor } from "../../plugins/table-column-resize.plugin.js";
+import { TableColumnNamesPluginDescriptor } from "../../plugins/table-column-names.plugin.js";
+import { ComponentViewDescriptor } from "../component-view.descriptor.js";
+import { TTableColumn } from "@soxa-ui/core";
+//#region content/descriptors/components/table/column.descriptor.ts
+/**
+* Дескриптор TableColumn (TTableColumn) — заголовок колонки таблицы.
+*
+* Наследует `ComponentViewDescriptor`, а не `ControlDescriptor`: нажатия,
+* фокуса и имени у заголовка нет — нажимают кнопку сортировки и ручку ширины в
+* нём, — а `disabled` колонке пишет таблица — для них. Колонку рисует
+* таблица — по заголовку на показанную колонку, над её экземпляром (`ctrl`),
+* как Calendar рисует день, — а колонки задаются только данными (`columns`).
+* Поэтому входов у части нет: всё своё у колонки объявлено защищённым и
+* только читается.
+*
+* Корень — ячейка шапки (`th`), на ней наборы колонки (`aria-sort`,
+* `aria-labelledby`, `data-sort`, `data-sort-priority`, `data-align`,
+* `data-sized` — ширина известна, своя или раскладки, — `data-resizing`,
+* `data-reorderable`, а в жесте перестановки — `data-dragging` и `data-drop`)
+* и ширина переменной (`widthStyle`). Ширину колонки без своей ширины
+* раскладывает таблица — расширение колонок по месту, которое мерит плагин
+* раскладки таблицы. Перестановку ведёт плагин таблицы, а не колонки: место
+* колонки знает коллекция колонок.
+*
+* Содержимое — ряд: подпись — слот по умолчанию с набором `textAria`, у всех
+* колонок, — и за ней у сортируемой колонки кнопка сортировки с набором
+* `sortAria`. Кнопку рисует сама колонка, а не таблица через слот: заголовок
+* назван подписью, и кнопка в ней дописала бы своё имя к имени заголовка, а
+* второй слот колонки стал бы публичным слотом таблицы. Нажатие кнопки —
+* просьба колонки (`toggleSort`), сортирует расширение коллекции строк. Своё
+* действие по заголовку потребитель ставит контролом в подпись (слот
+* `header` таблицы): у `th` фокуса нет. За рядом — ручка ширины
+* (`resizerRendered`): поле с ходом и шириной (`resizer`) и набором
+* `resizerAria`.
+*
+* Плагин связок называет заголовок и поле ручки подписью, плагин имён —
+* кнопку сортировки, от локали, плагин ручки ведёт указатель и клавиши.
+*/
+var TableColumnDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTableColumn,
+	extends: ComponentViewDescriptor(),
+	contribution: {
+		slots: { default: {
+			scope: {
+				text: defineType(String),
+				sortable: defineType(Boolean)
+			},
+			description: "Подпись заголовка. Без него — текст колонки"
+		} },
+		props: {
+			field: {
+				type: String,
+				protected: true,
+				triggers: ["change:field"]
+			},
+			text: {
+				type: String,
+				protected: true,
+				triggers: ["change:text"]
+			},
+			width: {
+				type: Number,
+				protected: true,
+				triggers: ["change:width"]
+			},
+			minWidth: {
+				type: Number,
+				protected: true,
+				triggers: ["change:minWidth"]
+			},
+			maxWidth: {
+				type: Number,
+				protected: true,
+				triggers: ["change:maxWidth"]
+			},
+			align: {
+				type: String,
+				protected: true,
+				triggers: ["change:align"]
+			},
+			sortable: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:sortable"]
+			},
+			compare: {
+				type: Function,
+				protected: true,
+				triggers: ["change:compare"]
+			},
+			rowHeader: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:rowHeader"]
+			},
+			resizable: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:resizable"]
+			},
+			reorderable: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:reorderable"]
+			},
+			disabled: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:disabled"]
+			},
+			/**
+			* Ширина колонки — `--so-table-column-width`. Считает ядро: в шести
+			* адаптерах одна формула была бы шесть раз.
+			*/
+			widthStyle: {
+				type: Object,
+				protected: true,
+				triggers: ["change:width"]
+			},
+			/**
+			* Рисовать ли ручку ширины: колонка `resizable`, не выключена, и
+			* ширина известна — своя или раскладки. Формулу считает ядро —
+			* разметка без экземпляра её не повторяет.
+			*/
+			resizerRendered: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:resizerRendered"]
+			},
+			/**
+			* Поле ручки: ход и ширина в px. Своего экземпляра у ручки нет —
+			* поле отдаётся значением, как ручки Slider.
+			*/
+			resizer: {
+				type: Object,
+				protected: true,
+				triggers: ["change:resizer"]
+			},
+			/**
+			* Атрибуты поля ручки, подписи и кнопки сортировки. Наборы колонки,
+			* а не свои: у разметки без компонента экземпляра нет.
+			*/
+			resizerAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:resizerAria"]
+			},
+			textAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:textAria"]
+			},
+			sortAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:sortAria"]
+			}
+		},
+		events: ["change:text", "change:disabled"]
+	},
+	plugins: [
+		TableColumnIdsPluginDescriptor,
+		TableColumnNamesPluginDescriptor,
+		TableColumnResizePluginDescriptor
+	]
+}));
+//#endregion
+export { TableColumnDescriptor };

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

@@ -0,0 +1,4 @@
+export { TableDescriptor } from './table.descriptor';
+export { TableColumnDescriptor } from './column.descriptor';
+export { TableRowDescriptor } from './row.descriptor';
+export { TableCollectionDescriptor, TableCollectionRowDescriptor } from './collection.descriptor';