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

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

@@ -0,0 +1,79 @@
+/**
+ * Дескрипторы коллекционной части Tags — фасады владельца и тега.
+ *
+ * Членство в коллекции отделено от собственных пропсов компонента
+ * (`TagsDescriptor`, `TagsItemDescriptor`): адаптер собирает компонент из обоих
+ * рантайм-списков.
+ */
+import { TTagsCollectionFacade, TTagsItemCollectionFacade } from '@soxa-ui/core';
+export declare const TagsCollectionDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTagsCollectionFacade;
+    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/events владельца Tags — то, что выводит фасад
+     * `TTagsCollectionFacade`: режим выбора и сам выбор (как у ListBox). Дефолт
+     * `mode` — `none`, задаётся в `tagsExtensions`, здесь только контракт.
+     */
+    readonly contribution: {
+        readonly props: {
+            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"];
+    };
+}>>;
+export declare const TagsCollectionItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTagsItemCollectionFacade;
+    /**
+     * Item-level пропсы элемента Tags — то, что выводит фасад
+     * `TTagsItemCollectionFacade`.
+     */
+    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"];
+            };
+            readonly tag_closable: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:closable"];
+            };
+        };
+        readonly events: readonly ["change:selected", "change:order"];
+    };
+}>>;

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

@@ -0,0 +1,63 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { CollectionDescriptor } from "../collection/collection.descriptor.js";
+import { TTagsCollectionFacade, TTagsItemCollectionFacade } from "@soxa-ui/core";
+//#region content/descriptors/components/tags/collection.descriptor.ts
+/**
+* Дескрипторы коллекционной части Tags — фасады владельца и тега.
+*
+* Членство в коллекции отделено от собственных пропсов компонента
+* (`TagsDescriptor`, `TagsItemDescriptor`): адаптер собирает компонент из обоих
+* рантайм-списков.
+*/
+var TagsCollectionDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTagsCollectionFacade,
+	extends: CollectionDescriptor(),
+	/**
+	* Коллекционные props/events владельца Tags — то, что выводит фасад
+	* `TTagsCollectionFacade`: режим выбора и сам выбор (как у ListBox). Дефолт
+	* `mode` — `none`, задаётся в `tagsExtensions`, здесь только контракт.
+	*/
+	contribution: {
+		props: {
+			mode: {
+				type: String,
+				triggers: ["change:mode"]
+			},
+			selected: {
+				type: Array,
+				protected: true,
+				triggers: ["change:selection"]
+			}
+		},
+		events: ["change:mode", "change:selection"]
+	}
+}));
+var TagsCollectionItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTagsItemCollectionFacade,
+	/**
+	* Item-level пропсы элемента Tags — то, что выводит фасад
+	* `TTagsItemCollectionFacade`.
+	*/
+	contribution: {
+		props: {
+			selected: {
+				type: Boolean,
+				triggers: ["change:selected"]
+			},
+			order: {
+				type: Number,
+				protected: true,
+				triggers: ["change:order"]
+			},
+			tag_closable: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:closable"]
+			}
+		},
+		events: ["change:selected", "change:order"]
+	}
+}));
+//#endregion
+export { TagsCollectionDescriptor, TagsCollectionItemDescriptor };

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

@@ -0,0 +1,3 @@
+export { TagsDescriptor } from './tags.descriptor';
+export { TagsItemDescriptor } from './item.descriptor';
+export { TagsCollectionDescriptor, TagsCollectionItemDescriptor } from './collection.descriptor';

package/dist/content/descriptors/components/tags/item.descriptor.d.ts

@@ -0,0 +1,216 @@
+/**
+ * Дескриптор TagsItem (TTagsItem).
+ *
+ * Наследует `ValueControlDescriptor` (value, name, disabled, focused, size,
+ * variant, ...), добавляет `text`, `closable`, `closeAria`. Имя крестика —
+ * шаблон локали с текстом тега: его пишет плагин имён.
+ * Плагина подсветки здесь нет: в отличие от ListBoxItem, по тегам ходит
+ * настоящий фокус, а не подсветка. Клавиатура набора — плагин владельца
+ * (`TagsKeyboardPluginDescriptor`), остановку Tab пишет коллекция.
+ *
+ * Размер тегу диктует набор, поэтому вход `size` снят. `variant` — вход, в
+ * отличие от остальных элементов коллекций (`OWNER_STYLE_PROPS`): вариант у
+ * тега свой, и в одном наборе бывают теги разного цвета. Набор его не пишет —
+ * тег без своего варианта тема красит вариантом набора.
+ *
+ * Строка тега (`row`) — не проп, а экземпляр, которым владеет тег, как поле
+ * Select: за жизнь тега он не меняется, и разметка отдаёт его кнопке через
+ * `ctrl`.
+ */
+import { TTagsItem } from '@soxa-ui/core';
+export declare const TagsItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TTagsItem;
+    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 selected: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Содержимое тега. Задано — переопределяет проп text";
+            };
+            readonly trailing: {
+                readonly description: "После текста тега";
+            };
+            readonly 'close-icon': {
+                readonly description: "Иконка кнопки закрытия";
+            };
+        };
+        readonly props: {
+            readonly size: {
+                readonly protected: true;
+            };
+            readonly text: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:text"];
+            };
+            readonly closable: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:closable"];
+            };
+            /**
+             * Атрибуты кнопки закрытия. Отдельный набор, а не часть `aria`:
+             * `aria` описывает сам тег, а это — кнопка рядом с ним. Набор
+             * живой, как `aria`: имя от локали пишет плагин имён, `tabindex` —
+             * коллекция по режиму выбора, и триггер один — набор сам
+             * сообщает, что изменился.
+             */
+            readonly closeAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:closeAria"];
+            };
+        };
+        readonly events: readonly ["change:text", "change:closable"];
+    };
+    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").TTagsItemNamesPlugin, "names", import("../../../..").IContribution>>];
+}>>;

package/dist/content/descriptors/components/tags/item.descriptor.js

@@ -0,0 +1,73 @@
+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 { TagsItemNamesPluginDescriptor } from "../../plugins/tags-item-names.plugin.js";
+import { ValueControlDescriptor } from "../value-control.descriptor.js";
+import { TTagsItem } from "@soxa-ui/core";
+import { tagStopIn } from "@soxa-ui/plugins";
+//#region content/descriptors/components/tags/item.descriptor.ts
+/**
+* Дескриптор TagsItem (TTagsItem).
+*
+* Наследует `ValueControlDescriptor` (value, name, disabled, focused, size,
+* variant, ...), добавляет `text`, `closable`, `closeAria`. Имя крестика —
+* шаблон локали с текстом тега: его пишет плагин имён.
+* Плагина подсветки здесь нет: в отличие от ListBoxItem, по тегам ходит
+* настоящий фокус, а не подсветка. Клавиатура набора — плагин владельца
+* (`TagsKeyboardPluginDescriptor`), остановку Tab пишет коллекция.
+*
+* Размер тегу диктует набор, поэтому вход `size` снят. `variant` — вход, в
+* отличие от остальных элементов коллекций (`OWNER_STYLE_PROPS`): вариант у
+* тега свой, и в одном наборе бывают теги разного цвета. Набор его не пишет —
+* тег без своего варианта тема красит вариантом набора.
+*
+* Строка тега (`row`) — не проп, а экземпляр, которым владеет тег, как поле
+* Select: за жизнь тега он не меняется, и разметка отдаёт его кнопке через
+* `ctrl`.
+*/
+var TagsItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TTagsItem,
+	extends: ValueControlDescriptor(),
+	contribution: {
+		slots: {
+			leading: { description: "Перед текстом тега" },
+			default: {
+				scope: {
+					text: defineType(String),
+					selected: defineType(Boolean)
+				},
+				description: "Содержимое тега. Задано — переопределяет проп text"
+			},
+			trailing: { description: "После текста тега" },
+			"close-icon": { description: "Иконка кнопки закрытия" }
+		},
+		props: {
+			size: { protected: true },
+			text: {
+				type: String,
+				triggers: ["change:text"]
+			},
+			closable: {
+				type: Boolean,
+				triggers: ["change:closable"]
+			},
+			/**
+			* Атрибуты кнопки закрытия. Отдельный набор, а не часть `aria`:
+			* `aria` описывает сам тег, а это — кнопка рядом с ним. Набор
+			* живой, как `aria`: имя от локали пишет плагин имён, `tabindex` —
+			* коллекция по режиму выбора, и триггер один — набор сам
+			* сообщает, что изменился.
+			*/
+			closeAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:closeAria"]
+			}
+		},
+		events: ["change:text", "change:closable"]
+	},
+	plugins: [ActionPluginDescriptor.with({ focusTarget: tagStopIn }), TagsItemNamesPluginDescriptor]
+}));
+//#endregion
+export { TagsItemDescriptor };