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

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

@@ -0,0 +1,208 @@
+/**
+ * Дескриптор Scroller (TScroller) — лента произвольного содержимого в одну
+ * строку, которую двигают две кнопки.
+ *
+ * Наследует ControlDescriptor (size, variant, disabled, focused, наборы,
+ * плагины element/ready/action/aria) и добавляет атрибуты вьюпорта от
+ * потребителя, выходы для разметки, плагин вьюпорта и плагин имён кнопок
+ * от локали.
+ */
+import { TScroller } from '@soxa-ui/core';
+export declare const ScrollerDescriptor: () => import("../../..").IComponentDescriptor<import("../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TScroller;
+    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: {
+            readonly default: {
+                readonly description: "Содержимое ленты: лежит прямо во вьюпорте";
+            };
+            readonly 'prev-icon': {
+                readonly description: "Значок кнопки «назад»";
+            };
+            readonly 'next-icon': {
+                readonly description: "Значок кнопки «вперёд»";
+            };
+        };
+        readonly props: {
+            /**
+             * Роль ряда и всё, что к ней прилагается, приходит от
+             * потребителя: своего экземпляра у вьюпорта нет, а кнопкам
+             * внутри `role="listbox"` места нет — отсюда и проп.
+             */
+            readonly viewportAria: {
+                readonly type: ObjectConstructor;
+                readonly triggers: readonly ["change:viewportAria"];
+            };
+            /**
+             * Наборы кнопок: своего экземпляра у кнопок нет, и наборы держит
+             * лента. Имена в них пишет `TScrollerNamesPlugin`.
+             */
+            readonly prevAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:prevAria"];
+            };
+            readonly nextAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:nextAria"];
+            };
+            /**
+             * Выключенность кнопок считает ядро: «выключена лента **или**
+             * упёрлись в край» — одно правило, а не условие в шести
+             * разметках.
+             */
+            readonly prevDisabled: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:canPrev", "change:disabled"];
+            };
+            readonly nextDisabled: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:canNext", "change:disabled"];
+            };
+            /** `tabindex` вьюпорта: `0`, когда листать есть куда, а своих остановок нет. */
+            readonly viewportTabIndex: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:canPrev", "change:canNext", "change:hasTabStops"];
+            };
+        };
+    };
+    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").TScrollerViewportPlugin, "viewport", import("../../..").IContribution>>, import("../../..").IPluginDefinition<import("../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TScrollerNamesPlugin, "names", import("../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/scroller.descriptor.js

@@ -0,0 +1,91 @@
+import { defineComponent } from "../../../protected/define/component.js";
+import { defineDescriptor } from "../../../protected/define/descriptor.js";
+import { ActionPluginDescriptor } from "../plugins/action.plugin.js";
+import { ScrollerViewportPluginDescriptor } from "../plugins/scroller-viewport.plugin.js";
+import { ScrollerNamesPluginDescriptor } from "../plugins/scroller-names.plugin.js";
+import { ControlDescriptor } from "./control.descriptor.js";
+import { TScroller } from "@soxa-ui/core";
+import { viewportStopOf } from "@soxa-ui/plugins";
+//#region content/descriptors/components/scroller.descriptor.ts
+/**
+* Дескриптор Scroller (TScroller) — лента произвольного содержимого в одну
+* строку, которую двигают две кнопки.
+*
+* Наследует ControlDescriptor (size, variant, disabled, focused, наборы,
+* плагины element/ready/action/aria) и добавляет атрибуты вьюпорта от
+* потребителя, выходы для разметки, плагин вьюпорта и плагин имён кнопок
+* от локали.
+*/
+var ScrollerDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TScroller,
+	extends: ControlDescriptor(),
+	contribution: {
+		/**
+		* Содержимое — слот, а не коллекция: лента не владеет тем, что
+		* листает. У первого потребителя набор тегов уже есть, и второй был
+		* бы вторым путём к тем же данным.
+		*/
+		slots: {
+			default: { description: "Содержимое ленты: лежит прямо во вьюпорте" },
+			"prev-icon": { description: "Значок кнопки «назад»" },
+			"next-icon": { description: "Значок кнопки «вперёд»" }
+		},
+		props: {
+			/**
+			* Роль ряда и всё, что к ней прилагается, приходит от
+			* потребителя: своего экземпляра у вьюпорта нет, а кнопкам
+			* внутри `role="listbox"` места нет — отсюда и проп.
+			*/
+			viewportAria: {
+				type: Object,
+				triggers: ["change:viewportAria"]
+			},
+			/**
+			* Наборы кнопок: своего экземпляра у кнопок нет, и наборы держит
+			* лента. Имена в них пишет `TScrollerNamesPlugin`.
+			*/
+			prevAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:prevAria"]
+			},
+			nextAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:nextAria"]
+			},
+			/**
+			* Выключенность кнопок считает ядро: «выключена лента **или**
+			* упёрлись в край» — одно правило, а не условие в шести
+			* разметках.
+			*/
+			prevDisabled: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:canPrev", "change:disabled"]
+			},
+			nextDisabled: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:canNext", "change:disabled"]
+			},
+			/** `tabindex` вьюпорта: `0`, когда листать есть куда, а своих остановок нет. */
+			viewportTabIndex: {
+				type: Number,
+				protected: true,
+				triggers: [
+					"change:canPrev",
+					"change:canNext",
+					"change:hasTabStops"
+				]
+			}
+		}
+	},
+	plugins: [
+		ActionPluginDescriptor.with({ focusTarget: viewportStopOf }),
+		ScrollerViewportPluginDescriptor,
+		ScrollerNamesPluginDescriptor
+	]
+}));
+//#endregion
+export { ScrollerDescriptor };

package/dist/content/descriptors/components/select/collection.descriptor.d.ts

@@ -0,0 +1,135 @@
+/**
+ * Дескрипторы коллекционной части Select — фасады владельца и опции.
+ *
+ * Членство в коллекции отделено от собственных пропсов компонента
+ * (`SelectDescriptor`, `SelectItemDescriptor`): адаптер собирает компонент из
+ * обоих рантайм-списков.
+ */
+import { TSelectCollectionFacade, TSelectItemCollectionFacade } from '@soxa-ui/core';
+export declare const SelectCollectionDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TSelectCollectionFacade;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly contribution: {
+            readonly props: {
+                readonly engine: {
+                    readonly type: ObjectConstructor;
+                };
+                readonly items: {
+                    readonly type: ArrayConstructor;
+                    readonly triggers: readonly ["change:items"];
+                };
+                readonly shown: {
+                    readonly type: ArrayConstructor;
+                    readonly protected: true;
+                    readonly triggers: readonly ["change:shown"];
+                };
+                readonly trackBy: {
+                    readonly type: FunctionConstructor;
+                    readonly triggers: readonly ["change:trackBy"];
+                };
+            };
+            readonly events: readonly ["engine:create", "item:add:before", "item:added", "item:remove:before", "item:removed", "item:update:before", "item:updated", "item:move:before", "item:moved", "items:clear:before", "change:count", "reset", "items:added", "items:removed", "change:shown", "change:items", "change:trackBy"];
+        };
+    }>>;
+    /**
+     * Коллекционные props владельца Select (выводятся `TSelectCollectionFacade`):
+     * режим выбора, сам выбор, группы опций (общий фрагмент `GROUP_PROPS`, как
+     * у Menu и ListBox), теги поля и что рисует список панели.
+     *
+     * `mode` служит переключателем множественного выбора: отдельного `multiple`
+     * нет намеренно — два имени для одного состояния однажды разошлись бы.
+     */
+    readonly contribution: {
+        readonly props: {
+            /**
+             * Инстанс тегов при множественном выборе, `null` иначе. Живёт в
+             * `TSelectTagsExtension` — второй компонент со своей коллекцией, а не
+             * разметка: связку «опция ⇄ тег» пришлось бы иначе повторять в шести
+             * адаптерах.
+             */
+            readonly tags: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:tags"];
+            };
+            /** Коллекция тегов — то, что `<Tags :engine="...">` берёт готовым. */
+            readonly tags_engine: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:tags"];
+            };
+            /**
+             * Что делать с тегами, которым не хватило строки поля. Передаётся
+             * своему `TTags` так же, как `size` и `variant`; по умолчанию
+             * `wrap` — поведение поля не меняется, пока режим не задали.
+             */
+            readonly tagsOverflow: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:overflow"];
+            };
+            /**
+             * Что рисует список панели, по секциям: группа с подписью или опции
+             * без группы, а в секции — опции на своих местах и, в окне обёртки
+             * `Virtual`, распорки на месте пропущенных. Между соседними
+             * секциями разметка рисует разделитель, если его просит Select
+             * (`groupSeparators`). Без групп секция одна
+             */
+            readonly drawnSections: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:drawnSections"];
+            };
+            readonly groupBy: {
+                type: FunctionConstructor;
+                triggers: "change:groupBy"[];
+            };
+            readonly groups: {
+                type: ArrayConstructor;
+                triggers: "change:groups"[];
+            };
+            readonly mode: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:mode"];
+            };
+            readonly selected: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:selection"];
+            };
+        };
+        readonly events: readonly ["change:mode", "change:selection", "change:groupBy", "change:groups", "change:overflow"];
+    };
+}>>;
+/**
+ * Без `extends`: это чистое членство в коллекции — выбранность и порядок.
+ * Собственные пропсы опции приходят из SelectItemDescriptor.
+ */
+export declare const SelectCollectionItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TSelectItemCollectionFacade;
+    /**
+     * Item-level props опции (выводятся `TSelectItemCollectionFacade`).
+     */
+    readonly contribution: {
+        readonly props: {
+            readonly selected: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:selected"];
+            };
+            readonly order: {
+                readonly type: NumberConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:order"];
+            };
+            /**
+             * Сторона отметки выбранного. Только на чтение: значение одно на весь
+             * список и живёт на поле — как `view` у элемента ListBox.
+             */
+            readonly indicator: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:indicator"];
+            };
+        };
+        readonly events: readonly ["change:selected", "change:order"];
+    };
+}>>;

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

@@ -0,0 +1,119 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { CollectionDescriptor } from "../collection/collection.descriptor.js";
+import { GROUP_PROPS } from "../list.js";
+import { TSelectCollectionFacade, TSelectItemCollectionFacade } from "@soxa-ui/core";
+//#region content/descriptors/components/select/collection.descriptor.ts
+/**
+* Дескрипторы коллекционной части Select — фасады владельца и опции.
+*
+* Членство в коллекции отделено от собственных пропсов компонента
+* (`SelectDescriptor`, `SelectItemDescriptor`): адаптер собирает компонент из
+* обоих рантайм-списков.
+*/
+var SelectCollectionDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TSelectCollectionFacade,
+	extends: CollectionDescriptor(),
+	/**
+	* Коллекционные props владельца Select (выводятся `TSelectCollectionFacade`):
+	* режим выбора, сам выбор, группы опций (общий фрагмент `GROUP_PROPS`, как
+	* у Menu и ListBox), теги поля и что рисует список панели.
+	*
+	* `mode` служит переключателем множественного выбора: отдельного `multiple`
+	* нет намеренно — два имени для одного состояния однажды разошлись бы.
+	*/
+	contribution: {
+		props: {
+			mode: {
+				type: String,
+				triggers: ["change:mode"]
+			},
+			selected: {
+				type: Array,
+				protected: true,
+				triggers: ["change:selection"]
+			},
+			...GROUP_PROPS,
+			/**
+			* Инстанс тегов при множественном выборе, `null` иначе. Живёт в
+			* `TSelectTagsExtension` — второй компонент со своей коллекцией, а не
+			* разметка: связку «опция ⇄ тег» пришлось бы иначе повторять в шести
+			* адаптерах.
+			*/
+			tags: {
+				type: Object,
+				protected: true,
+				triggers: ["change:tags"]
+			},
+			/** Коллекция тегов — то, что `<Tags :engine="...">` берёт готовым. */
+			tags_engine: {
+				type: Object,
+				protected: true,
+				triggers: ["change:tags"]
+			},
+			/**
+			* Что делать с тегами, которым не хватило строки поля. Передаётся
+			* своему `TTags` так же, как `size` и `variant`; по умолчанию
+			* `wrap` — поведение поля не меняется, пока режим не задали.
+			*/
+			tagsOverflow: {
+				type: String,
+				triggers: ["change:overflow"]
+			},
+			/**
+			* Что рисует список панели, по секциям: группа с подписью или опции
+			* без группы, а в секции — опции на своих местах и, в окне обёртки
+			* `Virtual`, распорки на месте пропущенных. Между соседними
+			* секциями разметка рисует разделитель, если его просит Select
+			* (`groupSeparators`). Без групп секция одна
+			*/
+			drawnSections: {
+				type: Array,
+				protected: true,
+				triggers: ["change:drawnSections"]
+			}
+		},
+		events: [
+			"change:mode",
+			"change:selection",
+			"change:groupBy",
+			"change:groups",
+			"change:overflow"
+		]
+	}
+}));
+/**
+* Без `extends`: это чистое членство в коллекции — выбранность и порядок.
+* Собственные пропсы опции приходят из SelectItemDescriptor.
+*/
+var SelectCollectionItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TSelectItemCollectionFacade,
+	/**
+	* Item-level props опции (выводятся `TSelectItemCollectionFacade`).
+	*/
+	contribution: {
+		props: {
+			selected: {
+				type: Boolean,
+				triggers: ["change:selected"]
+			},
+			order: {
+				type: Number,
+				protected: true,
+				triggers: ["change:order"]
+			},
+			/**
+			* Сторона отметки выбранного. Только на чтение: значение одно на весь
+			* список и живёт на поле — как `view` у элемента ListBox.
+			*/
+			indicator: {
+				type: String,
+				protected: true,
+				triggers: ["change:indicator"]
+			}
+		},
+		events: ["change:selected", "change:order"]
+	}
+}));
+//#endregion
+export { SelectCollectionDescriptor, SelectCollectionItemDescriptor };