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

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

@@ -0,0 +1,177 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { MenuKeyboardPluginDescriptor } from "../../plugins/menu-keyboard.plugin.js";
+import { MenuPointerPluginDescriptor } from "../../plugins/menu-pointer.plugin.js";
+import { MenuHoverPluginDescriptor } from "../../plugins/menu-hover.plugin.js";
+import { MenuFocusPluginDescriptor } from "../../plugins/menu-focus.plugin.js";
+import { DismissPluginDescriptor } from "../../plugins/dismiss.plugin.js";
+import { CollectionBundlesPluginDescriptor } from "../../plugins/collection-bundles.plugin.js";
+import { CollectionElementsPluginDescriptor } from "../../plugins/collection-elements.plugin.js";
+import { ListScrollPluginDescriptor } from "../../plugins/list-scroll.plugin.js";
+import { MenuIdsPluginDescriptor } from "../../plugins/menu-ids.plugin.js";
+import { StylableDescriptor } from "../stylable.descriptor.js";
+import { TMenu } from "@soxa-ui/core";
+import { TMenuKeyboardPlugin } from "@soxa-ui/plugins";
+//#region content/descriptors/components/menu/menu.descriptor.ts
+/**
+* Дескриптор Menu (TMenu) — меню действий у кнопки (APG Menu Button) или
+* контекстное меню области (`openOn: 'contextmenu'`).
+*
+* Наследует StylableDescriptor (size, variant, rendered, visible, tag, наборы и
+* плагины element/ready) и добавляет открытость, сторону панели, способ
+* открытия, разделители секций группировки, выходы для разметки и плагины:
+* коллекцию пунктов, нажатие мимо, клавиатуру, прокрутку списка пунктов,
+* открытие и указатель, модель фокуса и связки.
+*/
+var MenuDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TMenu,
+	extends: StylableDescriptor(),
+	contribution: {
+		/**
+		* Триггер — слот внутри корня, как у Popover: корень служит панели
+		* якорем, а нажатие по открытому триггеру остаётся нажатием внутри
+		* владельца. Своей ARIA у содержимого слота нет, поэтому сторону
+		* связки компонент отдаёт ему в scope. У контекстного меню в слоте —
+		* область, по которой его вызывают, и связки у неё нет.
+		*
+		* Пункты — слот `default`; без него меню рисует пункты из `items` —
+		* действия, а пункт с вложенным `items` — подменю. Каждый слот строки
+		* есть у меню как `item-<слот>`, и scope у него — scope слота строки
+		* плюс сам пункт. `default` у действия — `item`, у подменю —
+		* `item-content`, как панель у Accordion. Подменю из данных меню
+		* отдаёт свои `item` и `item-*` под теми же именами, поэтому слоты
+		* одни на все уровни.
+		*/
+		slots: {
+			trigger: {
+				scope: {
+					triggerAria: defineType(Object),
+					triggerDataset: defineType(Object)
+				},
+				description: "Кнопка, которая открывает меню, а у контекстного меню — область. ARIA и data-* для кнопки — в scope"
+			},
+			default: { description: "Пункты меню, группы и разделители" },
+			item: {
+				scope: {
+					item: defineType(Object),
+					text: defineType(String)
+				},
+				description: "Содержимое пункта-действия при работе через проп items"
+			},
+			"item-leading": {
+				scope: { item: defineType(Object) },
+				description: "Значок пункта — действия и подменю — при работе через проп items"
+			},
+			"item-trailing": {
+				scope: { item: defineType(Object) },
+				description: "Подсказка сочетания клавиш при работе через проп items"
+			},
+			"item-header": {
+				scope: {
+					item: defineType(Object),
+					text: defineType(String),
+					open: defineType(Boolean)
+				},
+				description: "Текст строки подменю при работе через проп items"
+			},
+			"item-arrow-icon": {
+				scope: { item: defineType(Object) },
+				description: "Стрелка подменю при работе через проп items"
+			},
+			"item-content": {
+				scope: { item: defineType(Object) },
+				description: "Пункты подменю разметкой вместо его items. Пусто — подменю рисует свои пункты из данных"
+			}
+		},
+		props: {
+			open: {
+				type: Boolean,
+				triggers: ["change:open"]
+			},
+			placement: {
+				type: String,
+				triggers: ["change:placement"]
+			},
+			/**
+			* Чем меню открывают: кнопкой (`press`) или как контекстное меню
+			* области в слоте `trigger` (`contextmenu`).
+			*/
+			openOn: {
+				type: String,
+				triggers: ["change:openOn"]
+			},
+			/**
+			* Рисовать ли разделитель между соседними секциями группировки
+			* пунктов из данных. Свойство меню, а не фасада: секции отдаёт
+			* коллекция, разделитель рисует разметка. Ручной `Menu.Separator`
+			* оно не трогает.
+			*/
+			groupSeparators: {
+				type: Boolean,
+				triggers: ["change:groupSeparators"]
+			},
+			/**
+			* Точка вызова контекстного меню в координатах окна. Пишет её плагин
+			* открытия, шаблон отдаёт якорю панели (`anchor_point`): панель
+			* встаёт у неё, а не у корня.
+			*/
+			point: {
+				type: Object,
+				protected: true,
+				triggers: ["change:point"]
+			},
+			/**
+			* Сторона триггера в связке с панелью и его вид «нажат». Вычисляют
+			* ядро и `TMenuIdsPlugin` (`id`, `aria-controls`), шаблон
+			* раскладывает в scope слота `trigger`. У области контекстного
+			* меню связки нет — набор пуст.
+			*/
+			triggerAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:triggerAria"]
+			},
+			triggerDataset: {
+				type: Object,
+				protected: true,
+				triggers: ["change:open"]
+			},
+			/**
+			* Классы панели — блок `so-menu__panel` с размером и вариантом
+			* меню: панель телепортирована, и модификаторы корня до неё не
+			* доходят.
+			*/
+			panelClasses: {
+				type: Object,
+				protected: true,
+				triggers: ["change:panelClasses"]
+			},
+			/** Whether the panel's items are mounted: from the first opening on. */
+			contentRendered: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:open"]
+			}
+		},
+		events: [
+			"change:open",
+			"change:placement",
+			"change:openOn",
+			"change:groupSeparators"
+		]
+	},
+	plugins: [
+		CollectionBundlesPluginDescriptor,
+		CollectionElementsPluginDescriptor,
+		DismissPluginDescriptor.with({ focusOutside: true }),
+		MenuKeyboardPluginDescriptor,
+		ListScrollPluginDescriptor.with({ navigation: TMenuKeyboardPlugin }),
+		MenuPointerPluginDescriptor,
+		MenuHoverPluginDescriptor,
+		MenuFocusPluginDescriptor,
+		MenuIdsPluginDescriptor
+	]
+}));
+//#endregion
+export { MenuDescriptor };

package/dist/content/descriptors/components/menu/popover-item.descriptor.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Дескриптор пункта с панелью (TMenuPopoverItem).
+ *
+ * Пропсы, события и плагины пункта — от `MenuItemDescriptor`: в меню это
+ * обычный пункт — строка, подсветка, размер меню. Сверх них — открытость
+ * панели, `lazyMount` её содержимого, выходы для разметки панели и плагины
+ * немодальной панели у строки: нажатие и уход фокуса мимо, модель фокуса,
+ * клавиша строки и связки. Членство в меню — фасад пункта
+ * (`MenuCollectionItemDescriptor`): своей коллекции у пункта с панелью нет,
+ * в панели лежит что угодно.
+ *
+ * Слоты объявлены заново — они не наследуются, а разметка у пункта с панелью
+ * своя: текст строки — слот `header` (`default` занят содержимым панели, имя
+ * — как у секции Accordion и у подменю), у конца строки — стрелка, подсказки
+ * сочетания нет.
+ */
+import { TMenuPopoverItem } from '@soxa-ui/core';
+export declare const MenuPopoverItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TMenuPopoverItem;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TMenuItem;
+        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: {
+            readonly slots: {
+                readonly leading: {
+                    readonly description: "Значок пункта";
+                };
+                readonly default: {
+                    readonly scope: {
+                        readonly text: import("../../../..").TPropType<string>;
+                    };
+                    readonly description: "Содержимое пункта. Задано — переопределяет проп text";
+                };
+                readonly trailing: {
+                    readonly description: "Подсказка сочетания клавиш у конца строки";
+                };
+            };
+            readonly props: {
+                readonly size: {
+                    readonly protected: true;
+                };
+                readonly text: {
+                    readonly type: StringConstructor;
+                    readonly triggers: readonly ["change:text"];
+                };
+            };
+            readonly events: readonly ["change:text"];
+        };
+        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").TListItemPlugin, "listItem", {
+            readonly props: {
+                readonly highlighted: {
+                    readonly protected: true;
+                    readonly triggers: readonly ["change:highlighted"];
+                };
+            };
+        }>>];
+    }>>;
+    readonly contribution: {
+        readonly slots: {
+            readonly leading: {
+                readonly description: "Значок пункта";
+            };
+            readonly header: {
+                readonly scope: {
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly open: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Текст строки пункта. Задан — переопределяет проп text";
+            };
+            /**
+             * Подмена стрелки в одном месте; по умолчанию она берётся из пакета
+             * иконок по роли `arrowRight`. Обёртка вокруг слота остаётся за
+             * компонентом: она держит место у конца строки, зеркалит стрелку в
+             * RTL и уносит её из дерева доступности — панель объявляет
+             * `aria-haspopup`.
+             */
+            readonly 'arrow-icon': {
+                readonly description: "Стрелка пункта у конца строки";
+            };
+            readonly default: {
+                readonly description: "Содержимое панели: календарь, поля, палитра";
+            };
+        };
+        readonly props: {
+            readonly open: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:open"];
+            };
+            readonly lazyMount: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:lazyMount"];
+            };
+            /**
+             * Набор панели — разметки без своего экземпляра: роль `dialog`,
+             * `id` и имя от строки (`TMenuPopupIdsPlugin`).
+             */
+            readonly panelAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:panelAria"];
+            };
+            /** Смонтировано ли содержимое: `lazyMount` прячет его до первого открытия. */
+            readonly contentRendered: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:open", "change:lazyMount"];
+            };
+        };
+        readonly events: readonly ["change:open", "change:lazyMount"];
+    };
+    readonly plugins: readonly [import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TDismissPlugin, "dismiss", {
+        readonly events: readonly ["dismiss", "change:enabled"];
+        readonly props: {
+            readonly enabled: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:enabled"];
+            };
+            readonly ownerAttribute: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["create"];
+            };
+        };
+    }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TMenuPopoverItemFocusPlugin, "focus", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TMenuPopoverItemKeyboardPlugin, "keyboard", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TIdPlugin, undefined, {
+        readonly props: {
+            readonly id: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:id"];
+            };
+        };
+        readonly events: readonly ["change:id"];
+    }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TMenuPopupIdsPlugin, "ids", import("../../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/menu/popover-item.descriptor.js

@@ -0,0 +1,87 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { MenuPopoverItemKeyboardPluginDescriptor } from "../../plugins/menu-popover-item-keyboard.plugin.js";
+import { MenuPopoverItemFocusPluginDescriptor } from "../../plugins/menu-popover-item-focus.plugin.js";
+import { DismissPluginDescriptor } from "../../plugins/dismiss.plugin.js";
+import { IdPluginDescriptor } from "../../plugins/id.plugin.js";
+import { MenuPopupIdsPluginDescriptor } from "../../plugins/menu-popup-ids.plugin.js";
+import { MenuItemDescriptor } from "./item.descriptor.js";
+import { TMenuPopoverItem } from "@soxa-ui/core";
+//#region content/descriptors/components/menu/popover-item.descriptor.ts
+/**
+* Дескриптор пункта с панелью (TMenuPopoverItem).
+*
+* Пропсы, события и плагины пункта — от `MenuItemDescriptor`: в меню это
+* обычный пункт — строка, подсветка, размер меню. Сверх них — открытость
+* панели, `lazyMount` её содержимого, выходы для разметки панели и плагины
+* немодальной панели у строки: нажатие и уход фокуса мимо, модель фокуса,
+* клавиша строки и связки. Членство в меню — фасад пункта
+* (`MenuCollectionItemDescriptor`): своей коллекции у пункта с панелью нет,
+* в панели лежит что угодно.
+*
+* Слоты объявлены заново — они не наследуются, а разметка у пункта с панелью
+* своя: текст строки — слот `header` (`default` занят содержимым панели, имя
+* — как у секции Accordion и у подменю), у конца строки — стрелка, подсказки
+* сочетания нет.
+*/
+var MenuPopoverItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TMenuPopoverItem,
+	extends: MenuItemDescriptor(),
+	contribution: {
+		slots: {
+			leading: { description: "Значок пункта" },
+			header: {
+				scope: {
+					text: defineType(String),
+					open: defineType(Boolean)
+				},
+				description: "Текст строки пункта. Задан — переопределяет проп text"
+			},
+			/**
+			* Подмена стрелки в одном месте; по умолчанию она берётся из пакета
+			* иконок по роли `arrowRight`. Обёртка вокруг слота остаётся за
+			* компонентом: она держит место у конца строки, зеркалит стрелку в
+			* RTL и уносит её из дерева доступности — панель объявляет
+			* `aria-haspopup`.
+			*/
+			"arrow-icon": { description: "Стрелка пункта у конца строки" },
+			default: { description: "Содержимое панели: календарь, поля, палитра" }
+		},
+		props: {
+			open: {
+				type: Boolean,
+				triggers: ["change:open"]
+			},
+			lazyMount: {
+				type: Boolean,
+				triggers: ["change:lazyMount"]
+			},
+			/**
+			* Набор панели — разметки без своего экземпляра: роль `dialog`,
+			* `id` и имя от строки (`TMenuPopupIdsPlugin`).
+			*/
+			panelAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:panelAria"]
+			},
+			/** Смонтировано ли содержимое: `lazyMount` прячет его до первого открытия. */
+			contentRendered: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:open", "change:lazyMount"]
+			}
+		},
+		events: ["change:open", "change:lazyMount"]
+	},
+	plugins: [
+		DismissPluginDescriptor.with({ focusOutside: true }),
+		MenuPopoverItemFocusPluginDescriptor,
+		MenuPopoverItemKeyboardPluginDescriptor,
+		IdPluginDescriptor,
+		MenuPopupIdsPluginDescriptor
+	]
+}));
+//#endregion
+export { MenuPopoverItemDescriptor };