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

package/dist/content/descriptors/components/list-box/item.descriptor.js

@@ -0,0 +1,66 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { IdPluginDescriptor } from "../../plugins/id.plugin.js";
+import { ActionPluginDescriptor } from "../../plugins/action.plugin.js";
+import { ListItemPluginDescriptor } from "../../plugins/list-item.plugin.js";
+import { OptionIdsPluginDescriptor } from "../../plugins/option-ids.plugin.js";
+import { OWNER_STYLE_PROPS } from "../stylable.descriptor.js";
+import { ValueControlDescriptor } from "../value-control.descriptor.js";
+import { TListBoxItem } from "@soxa-ui/core";
+import { rowIn } from "@soxa-ui/plugins";
+//#region content/descriptors/components/list-box/item.descriptor.ts
+/**
+* Дескриптор ListBoxItem (TListBoxItem).
+*
+* Наследует `ValueControlDescriptor` (value, name, disabled, focused, size,
+* variant, ...), добавляет `text`, `contentFit`, плагин подсветки элемента
+* (клавиатурная навигация) и его `id` в документе.
+*/
+var ListBoxItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TListBoxItem,
+	extends: ValueControlDescriptor(),
+	contribution: {
+		slots: {
+			leading: { description: "Перед текстом элемента" },
+			default: {
+				scope: {
+					text: defineType(String),
+					selected: defineType(Boolean)
+				},
+				description: "Содержимое элемента. Задано — переопределяет проп text"
+			},
+			trailing: { description: "После текста элемента" },
+			/**
+			* Подмена отметки выбранного в одном месте; глобально она меняется
+			* пакетом иконок (`useIcons`). Обёртка вокруг слота остаётся за
+			* компонентом: она резервирует место и уносит отметку из дерева
+			* доступности.
+			*/
+			"indicator-icon": {
+				scope: { selected: defineType(Boolean) },
+				description: "Отметка выбранного элемента"
+			}
+		},
+		props: {
+			...OWNER_STYLE_PROPS,
+			text: {
+				type: String,
+				triggers: ["change:text"]
+			},
+			contentFit: {
+				type: String,
+				triggers: ["change:contentFit"]
+			}
+		},
+		events: ["change:text", "change:contentFit"]
+	},
+	plugins: [
+		ActionPluginDescriptor.with({ focusTarget: rowIn }),
+		ListItemPluginDescriptor,
+		IdPluginDescriptor,
+		OptionIdsPluginDescriptor
+	]
+}));
+//#endregion
+export { ListBoxItemDescriptor };

package/dist/content/descriptors/components/list-box/list-box.descriptor.d.ts

@@ -0,0 +1,253 @@
+/**
+ * Дескриптор ListBox (TListBox).
+ *
+ * Наследует `ValueControlDescriptor` и добавляет `view` плюс плагины коллекции,
+ * списка и drag-and-drop.
+ *
+ * Именно `ValueControl`, а не `Control`: у списка есть значение — то, что
+ * выбрано. Выбор был всегда, но отдавался наружу списком объектов
+ * (`selected: TItem[]`), то есть внутренней моделью коллекции; потребителю
+ * нужен ответ в значениях, и он же уходит в форму.
+ *
+ * Списочные свойства (`maxRows`, `contentFit`, `scrollBehavior`) приходят из
+ * `LIST_PROPS` — общей с Select декларации. Общая там только декларация:
+ * реализация у каждого своя, потому что предок занят.
+ */
+import { TListBox } from '@soxa-ui/core';
+import type { IListBoxItem } from '@soxa-ui/core';
+import { TListKeyboardPlugin } from '@soxa-ui/plugins';
+export declare const ListBoxDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TListBox;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TValueControl;
+        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 props: {
+                readonly value: {
+                    readonly type: readonly [StringConstructor, NumberConstructor, BooleanConstructor, ObjectConstructor, ArrayConstructor];
+                    readonly triggers: readonly ["change:value"];
+                };
+                readonly name: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:name"];
+                };
+            };
+            readonly events: readonly ["change:value", "change:name"];
+        };
+    }>>;
+    readonly contribution: {
+        /**
+         * Панели у списка нет: выбор элемента не раскрывает содержимое, поэтому
+         * части `Content` здесь не существует — в отличие от Tabs и от слота
+         * `item-content` у Accordion. Слоты элементов статические и получают
+         * элемент через scope (см. Accordion).
+         *
+         * Каждый слот элемента есть у списка как `item-<слот>` (`default` —
+         * `item`), и scope у него — scope слота элемента плюс сам элемент:
+         * слот, перенесённый из разметки элемента в `items`, не теряет ни
+         * места, ни данных.
+         *
+         * `empty` показывается, пока элементов нет, — как у Select: пустой
+         * `listbox` для скринридера — тупик, а сообщение объясняет, что
+         * происходит.
+         */
+        readonly slots: {
+            readonly default: {
+                readonly description: "Элементы коллекции";
+            };
+            readonly header: {
+                readonly description: "Над списком";
+            };
+            readonly footer: {
+                readonly description: "Под списком";
+            };
+            readonly empty: {
+                readonly description: "Когда элементов нет";
+            };
+            readonly item: {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IListBoxItem<import("@soxa-ui/core").IListBoxItemProps, import("@soxa-ui/core").TListBoxItemEvents>>;
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly selected: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Содержимое элемента при работе через проп items";
+            };
+            readonly 'item-leading': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IListBoxItem<import("@soxa-ui/core").IListBoxItemProps, import("@soxa-ui/core").TListBoxItemEvents>>;
+                };
+                readonly description: "Перед содержимым элемента";
+            };
+            readonly 'item-trailing': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IListBoxItem<import("@soxa-ui/core").IListBoxItemProps, import("@soxa-ui/core").TListBoxItemEvents>>;
+                };
+                readonly description: "После содержимого элемента";
+            };
+            readonly 'item-indicator-icon': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IListBoxItem<import("@soxa-ui/core").IListBoxItemProps, import("@soxa-ui/core").TListBoxItemEvents>>;
+                    readonly selected: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Отметка выбранного элемента";
+            };
+        };
+        readonly props: {
+            readonly maxRows: {
+                type: NumberConstructor;
+                triggers: "change:maxRows"[];
+            };
+            readonly contentFit: {
+                type: StringConstructor;
+                triggers: "change:contentFit"[];
+            };
+            readonly scrollBehavior: {
+                type: StringConstructor;
+                triggers: "change:scrollBehavior"[];
+            };
+            readonly indicator: {
+                type: StringConstructor;
+                triggers: "change:indicator"[];
+            };
+            readonly groupSeparators: {
+                type: BooleanConstructor;
+                triggers: "change:groupSeparators"[];
+            };
+            readonly view: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:view"];
+            };
+        };
+        readonly events: readonly ["change:view", "change:maxRows", "change:contentFit", "change:scrollBehavior", "change:indicator", "change:groupSeparators"];
+    };
+    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").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").TListHeightPlugin, "height", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<TListKeyboardPlugin, "keyboard", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TListScrollPlugin, "scroll", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TDragPlugin, "drag", import("../../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/list-box/list-box.descriptor.js

@@ -0,0 +1,106 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { ActionPluginDescriptor } from "../../plugins/action.plugin.js";
+import { CollectionBundlesPluginDescriptor } from "../../plugins/collection-bundles.plugin.js";
+import { CollectionElementsPluginDescriptor } from "../../plugins/collection-elements.plugin.js";
+import { DragPluginDescriptor } from "../../plugins/drag.plugin.js";
+import { ListHeightPluginDescriptor } from "../../plugins/list-height.plugin.js";
+import { ListKeyboardPluginDescriptor } from "../../plugins/list-keyboard.plugin.js";
+import { ListScrollPluginDescriptor } from "../../plugins/list-scroll.plugin.js";
+import { ValueControlDescriptor } from "../value-control.descriptor.js";
+import { LIST_PROPS } from "../list.js";
+import { TListBox } from "@soxa-ui/core";
+import { TListKeyboardPlugin, listOf } from "@soxa-ui/plugins";
+//#region content/descriptors/components/list-box/list-box.descriptor.ts
+/**
+* Дескриптор ListBox (TListBox).
+*
+* Наследует `ValueControlDescriptor` и добавляет `view` плюс плагины коллекции,
+* списка и drag-and-drop.
+*
+* Именно `ValueControl`, а не `Control`: у списка есть значение — то, что
+* выбрано. Выбор был всегда, но отдавался наружу списком объектов
+* (`selected: TItem[]`), то есть внутренней моделью коллекции; потребителю
+* нужен ответ в значениях, и он же уходит в форму.
+*
+* Списочные свойства (`maxRows`, `contentFit`, `scrollBehavior`) приходят из
+* `LIST_PROPS` — общей с Select декларации. Общая там только декларация:
+* реализация у каждого своя, потому что предок занят.
+*/
+var ListBoxDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TListBox,
+	extends: ValueControlDescriptor(),
+	contribution: {
+		/**
+		* Панели у списка нет: выбор элемента не раскрывает содержимое, поэтому
+		* части `Content` здесь не существует — в отличие от Tabs и от слота
+		* `item-content` у Accordion. Слоты элементов статические и получают
+		* элемент через scope (см. Accordion).
+		*
+		* Каждый слот элемента есть у списка как `item-<слот>` (`default` —
+		* `item`), и scope у него — scope слота элемента плюс сам элемент:
+		* слот, перенесённый из разметки элемента в `items`, не теряет ни
+		* места, ни данных.
+		*
+		* `empty` показывается, пока элементов нет, — как у Select: пустой
+		* `listbox` для скринридера — тупик, а сообщение объясняет, что
+		* происходит.
+		*/
+		slots: {
+			default: { description: "Элементы коллекции" },
+			header: { description: "Над списком" },
+			footer: { description: "Под списком" },
+			empty: { description: "Когда элементов нет" },
+			item: {
+				scope: {
+					item: defineType(Object),
+					text: defineType(String),
+					selected: defineType(Boolean)
+				},
+				description: "Содержимое элемента при работе через проп items"
+			},
+			"item-leading": {
+				scope: { item: defineType(Object) },
+				description: "Перед содержимым элемента"
+			},
+			"item-trailing": {
+				scope: { item: defineType(Object) },
+				description: "После содержимого элемента"
+			},
+			"item-indicator-icon": {
+				scope: {
+					item: defineType(Object),
+					selected: defineType(Boolean)
+				},
+				description: "Отметка выбранного элемента"
+			}
+		},
+		props: {
+			view: {
+				type: String,
+				triggers: ["change:view"]
+			},
+			...LIST_PROPS
+		},
+		events: [
+			"change:view",
+			"change:maxRows",
+			"change:contentFit",
+			"change:scrollBehavior",
+			"change:indicator",
+			"change:groupSeparators"
+		]
+	},
+	plugins: [
+		ActionPluginDescriptor.with({ focusTarget: listOf }),
+		CollectionBundlesPluginDescriptor,
+		CollectionElementsPluginDescriptor,
+		ListHeightPluginDescriptor,
+		ListKeyboardPluginDescriptor,
+		ListScrollPluginDescriptor.with({ navigation: TListKeyboardPlugin }),
+		DragPluginDescriptor
+	]
+}));
+//#endregion
+export { ListBoxDescriptor };

package/dist/content/descriptors/components/list.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Shared list and grouping property declarations.
+ * Literal keys are preserved with `satisfies` so descriptor types retain each property.
+ * Public events are declared separately in each consuming descriptor.
+ */
+export declare const LIST_PROPS: {
+    maxRows: {
+        type: NumberConstructor;
+        triggers: "change:maxRows"[];
+    };
+    contentFit: {
+        type: StringConstructor;
+        triggers: "change:contentFit"[];
+    };
+    scrollBehavior: {
+        type: StringConstructor;
+        triggers: "change:scrollBehavior"[];
+    };
+    indicator: {
+        type: StringConstructor;
+        triggers: "change:indicator"[];
+    };
+    /** Рисовать ли разделитель между соседними секциями группировки */
+    groupSeparators: {
+        type: BooleanConstructor;
+        triggers: "change:groupSeparators"[];
+    };
+};
+export declare const GROUP_PROPS: {
+    /** Ключ группы элемента. Не задан — метка `_.group` из данных */
+    groupBy: {
+        type: FunctionConstructor;
+        triggers: "change:groupBy"[];
+    };
+    /** Порядок групп и их подписи. Сверка по содержимому */
+    groups: {
+        type: ArrayConstructor;
+        triggers: "change:groups"[];
+    };
+};

package/dist/content/descriptors/components/list.js

@@ -0,0 +1,38 @@
+//#region content/descriptors/components/list.ts
+var LIST_PROPS = {
+	maxRows: {
+		type: Number,
+		triggers: ["change:maxRows"]
+	},
+	contentFit: {
+		type: String,
+		triggers: ["change:contentFit"]
+	},
+	scrollBehavior: {
+		type: String,
+		triggers: ["change:scrollBehavior"]
+	},
+	indicator: {
+		type: String,
+		triggers: ["change:indicator"]
+	},
+	/** Рисовать ли разделитель между соседними секциями группировки */
+	groupSeparators: {
+		type: Boolean,
+		triggers: ["change:groupSeparators"]
+	}
+};
+var GROUP_PROPS = {
+	/** Ключ группы элемента. Не задан — метка `_.group` из данных */
+	groupBy: {
+		type: Function,
+		triggers: ["change:groupBy"]
+	},
+	/** Порядок групп и их подписи. Сверка по содержимому */
+	groups: {
+		type: Array,
+		triggers: ["change:groups"]
+	}
+};
+//#endregion
+export { GROUP_PROPS, LIST_PROPS };