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

package/dist/content/descriptors/components/menu/submenu.descriptor.d.ts

@@ -0,0 +1,336 @@
+/**
+ * Дескриптор пункта с подменю (TMenuSubmenu).
+ *
+ * Пропсы, события и плагины пункта — от `MenuItemDescriptor`: в меню над ним
+ * это обычный пункт — строка, подсветка, размер меню. Сверх них — открытость,
+ * разделители секций своих пунктов, наборы панели и плагины владельца своих
+ * пунктов: коллекция, нажатие и уход фокуса мимо, клавиши уровня, прокрутка
+ * списка пунктов, указатель, модель фокуса и связки. Членство в меню над ним
+ * — фасад пункта (`MenuCollectionItemDescriptor`), свои пункты — фасад меню
+ * (`MenuCollectionDescriptor`): у каждого уровня меню своя коллекция.
+ *
+ * Слоты объявлены заново — они не наследуются, а разметка у пункта с подменю
+ * своя: текст строки — слот `header` (`default` занят пунктами подменю, имя —
+ * как у секции Accordion), у конца строки — стрелка, подсказки сочетания нет.
+ * Слоты пунктов из `items` — те же, что у меню (`item`, `item-*`): подменю
+ * из данных пункт отдаёт их под теми же именами, и они одни на все уровни.
+ */
+import { TMenuSubmenu } from '@soxa-ui/core';
+import type { IMenuItem } from '@soxa-ui/core';
+import { TMenuSubmenuKeyboardPlugin } from '@soxa-ui/plugins';
+export declare const MenuSubmenuDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TMenuSubmenu;
+    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 item: {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                    readonly text: import("../../../..").TPropType<string>;
+                };
+                readonly description: "Содержимое пункта-действия подменю при работе через проп items";
+            };
+            readonly 'item-leading': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                };
+                readonly description: "Значок пункта подменю — действия и подменю — при работе через проп items";
+            };
+            readonly 'item-trailing': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                };
+                readonly description: "Подсказка сочетания клавиш при работе через проп items";
+            };
+            readonly 'item-header': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly open: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Текст строки вложенного подменю при работе через проп items";
+            };
+            readonly 'item-arrow-icon': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                };
+                readonly description: "Стрелка вложенного подменю при работе через проп items";
+            };
+            readonly 'item-content': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<IMenuItem<import("@soxa-ui/core").IMenuItemProps, any>>;
+                };
+                readonly description: "Пункты вложенного подменю разметкой вместо его items. Пусто — оно рисует свои пункты из данных";
+            };
+        };
+        readonly props: {
+            readonly open: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:open"];
+            };
+            /**
+             * Рисовать ли разделитель между соседними секциями группировки своих
+             * пунктов из данных — как у меню: свои секции рисует разметка
+             * подменю.
+             */
+            readonly groupSeparators: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:groupSeparators"];
+            };
+            /**
+             * Набор панели подменю — разметки без своего экземпляра: роль
+             * `menu`, `id` и имя от строки (`TMenuPopupIdsPlugin`).
+             */
+            readonly panelAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:panelAria"];
+            };
+            /**
+             * Классы панели — блок `so-menu__panel` с размером подменю и
+             * вариантом его панели: своим вариантом подменю, а без него
+             * вариантом меню над ним. Панель телепортирована, и модификаторы
+             * пункта до неё не доходят.
+             */
+            readonly panelClasses: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:panelClasses"];
+            };
+            /** Whether the panel's items are mounted: from the first opening on. */
+            readonly contentRendered: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:open"];
+            };
+        };
+        readonly events: readonly ["change:open", "change:groupSeparators"];
+    };
+    readonly plugins: readonly [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").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<TMenuSubmenuKeyboardPlugin, "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").TMenuHoverPlugin, "hover", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TMenuSubmenuFocusPlugin, "focus", 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/submenu.descriptor.js

@@ -0,0 +1,144 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { MenuHoverPluginDescriptor } from "../../plugins/menu-hover.plugin.js";
+import { MenuSubmenuKeyboardPluginDescriptor } from "../../plugins/menu-submenu-keyboard.plugin.js";
+import { MenuSubmenuFocusPluginDescriptor } from "../../plugins/menu-submenu-focus.plugin.js";
+import { DismissPluginDescriptor } from "../../plugins/dismiss.plugin.js";
+import { IdPluginDescriptor } from "../../plugins/id.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 { MenuPopupIdsPluginDescriptor } from "../../plugins/menu-popup-ids.plugin.js";
+import { MenuItemDescriptor } from "./item.descriptor.js";
+import { TMenuSubmenu } from "@soxa-ui/core";
+import { TMenuSubmenuKeyboardPlugin } from "@soxa-ui/plugins";
+//#region content/descriptors/components/menu/submenu.descriptor.ts
+/**
+* Дескриптор пункта с подменю (TMenuSubmenu).
+*
+* Пропсы, события и плагины пункта — от `MenuItemDescriptor`: в меню над ним
+* это обычный пункт — строка, подсветка, размер меню. Сверх них — открытость,
+* разделители секций своих пунктов, наборы панели и плагины владельца своих
+* пунктов: коллекция, нажатие и уход фокуса мимо, клавиши уровня, прокрутка
+* списка пунктов, указатель, модель фокуса и связки. Членство в меню над ним
+* — фасад пункта (`MenuCollectionItemDescriptor`), свои пункты — фасад меню
+* (`MenuCollectionDescriptor`): у каждого уровня меню своя коллекция.
+*
+* Слоты объявлены заново — они не наследуются, а разметка у пункта с подменю
+* своя: текст строки — слот `header` (`default` занят пунктами подменю, имя —
+* как у секции Accordion), у конца строки — стрелка, подсказки сочетания нет.
+* Слоты пунктов из `items` — те же, что у меню (`item`, `item-*`): подменю
+* из данных пункт отдаёт их под теми же именами, и они одни на все уровни.
+*/
+var MenuSubmenuDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TMenuSubmenu,
+	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: "Пункты подменю, группы и разделители" },
+			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"]
+			},
+			/**
+			* Рисовать ли разделитель между соседними секциями группировки своих
+			* пунктов из данных — как у меню: свои секции рисует разметка
+			* подменю.
+			*/
+			groupSeparators: {
+				type: Boolean,
+				triggers: ["change:groupSeparators"]
+			},
+			/**
+			* Набор панели подменю — разметки без своего экземпляра: роль
+			* `menu`, `id` и имя от строки (`TMenuPopupIdsPlugin`).
+			*/
+			panelAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:panelAria"]
+			},
+			/**
+			* Классы панели — блок `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:groupSeparators"]
+	},
+	plugins: [
+		CollectionBundlesPluginDescriptor,
+		CollectionElementsPluginDescriptor,
+		DismissPluginDescriptor.with({ focusOutside: true }),
+		MenuSubmenuKeyboardPluginDescriptor,
+		ListScrollPluginDescriptor.with({ navigation: TMenuSubmenuKeyboardPlugin }),
+		MenuHoverPluginDescriptor,
+		MenuSubmenuFocusPluginDescriptor,
+		IdPluginDescriptor,
+		MenuPopupIdsPluginDescriptor
+	]
+}));
+//#endregion
+export { MenuSubmenuDescriptor };