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

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

@@ -0,0 +1,454 @@
+/**
+ * Дескриптор Select (TSelect).
+ *
+ * Наследует InputControlDescriptor: value, name, readonly, required, плюс всё
+ * от Control (disabled, focused, size, variant) и ComponentView. Добавляет
+ * состояние панели, жест и плагины оверлея.
+ */
+import { TSelect } from '@soxa-ui/core';
+import type { IInput, ISelectItem, ITags, TTagsCollection } from '@soxa-ui/core';
+import { TSelectKeyboardPlugin } from '@soxa-ui/plugins';
+export declare const SelectDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TSelect;
+    readonly extends: import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+        readonly ctor: typeof import("@soxa-ui/core").TInputControl;
+        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 props: {
+                readonly readonly: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:readonly"];
+                };
+                readonly required: {
+                    readonly type: BooleanConstructor;
+                    readonly triggers: readonly ["change:required"];
+                };
+            };
+            readonly events: readonly ["change:readonly", "change:required"];
+        };
+        readonly plugins: readonly [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"];
+        }>>];
+    }>>;
+    readonly contribution: {
+        /**
+         * `field` и `clear` отделены от `default` структурно, а не по вкусу:
+         * `default` кладётся внутрь `[role=listbox]`, и всё, что туда попадёт,
+         * скринридер сочтёт опцией. Поле и кнопка очистки живут снаружи панели.
+         *
+         * `empty` показывается вместо списка, когда опций нет: пустой `listbox`
+         * для скринридера — тупик, а сообщение хотя бы объясняет, что происходит.
+         *
+         * `field` отдаёт сам `field` — экземпляр `TInput`, единственный держатель
+         * текста, плейсхолдера и ARIA поля (тем же приёмом, что `:ctrl="field"` у
+         * встроенной разметки, см. `TSelect.field`, `TSelectExtension`). Второго
+         * пути к тем же данным больше нет: раньше слот отдавал `text`/`placeholder`
+         * отдельными пропами, а они дублировали то, что уже есть у `field`, и
+         * `placeholder` при этом расходился с ним — не учитывал теги.
+         */
+        readonly slots: {
+            readonly field: {
+                readonly scope: {
+                    readonly field: import("../../../..").TPropType<IInput>;
+                };
+                readonly description: "Содержимое поля вместо встроенного Input";
+            };
+            /**
+             * Ряд тегов в поле, пока выбор множественный. Scope — инстанс тегов и
+             * его коллекция, те же, что встроенный `Tags` берёт `:ctrl` и
+             * `:engine`: связка «опция ⇄ тег» живёт в `TSelectTagsExtension`, и
+             * своя разметка ряда получает её готовой. Так ряд раскладывают
+             * иначе, чем `wrap` и `scroll`, — в ленту или с хвостом в панели, —
+             * не трогая Select.
+             */
+            readonly tags: {
+                readonly scope: {
+                    readonly tags: import("../../../..").TPropType<ITags<import("@soxa-ui/core").ITagsProps, import("@soxa-ui/core").TTagsEvents>>;
+                    readonly engine: import("../../../..").TPropType<TTagsCollection>;
+                };
+                readonly description: "Ряд тегов в поле при множественном выборе вместо встроенного Tags";
+            };
+            /**
+             * `leading` и `trailing` — проброс одноимённых слотов Input: у него
+             * они уже есть, и заводить своё было бы вторым способом делать то же
+             * самое. `trailing` идёт после кнопки очистки и стрелки, то есть
+             * дополняет их, а не заменяет.
+             */
+            readonly leading: {
+                readonly description: "Перед полем";
+            };
+            /**
+             * Проброс слота `clear` поля: кнопку очистки рисует поле, а своя
+             * кнопка заменяет её целиком. Scope — команда поля `clear`: она
+             * очищает поле, а выбор Select снимает по её событию.
+             */
+            readonly clear: {
+                readonly scope: {
+                    readonly clear: import("../../../..").TPropType<() => void>;
+                };
+                readonly description: "Кнопка очистки значения";
+            };
+            readonly 'arrow-icon': {
+                readonly description: "Стрелка состояния панели";
+            };
+            readonly trailing: {
+                readonly description: "После стрелки";
+            };
+            readonly default: {
+                readonly description: "Опции — элементы коллекции";
+            };
+            readonly empty: {
+                readonly description: "Когда опций нет";
+            };
+            /**
+             * Слоты опций при работе через проп `items` — проброс слотов опции:
+             * `item-<слот>` (`default` — `item`), scope — scope слота опции плюс
+             * сама опция.
+             */
+            readonly item: {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<ISelectItem<import("@soxa-ui/core").ISelectItemProps, import("@soxa-ui/core").TSelectItemEvents>>;
+                    readonly text: import("../../../..").TPropType<string>;
+                    readonly selected: import("../../../..").TPropType<boolean>;
+                };
+                readonly description: "Содержимое опции при работе через проп items";
+            };
+            readonly 'item-leading': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<ISelectItem<import("@soxa-ui/core").ISelectItemProps, import("@soxa-ui/core").TSelectItemEvents>>;
+                };
+                readonly description: "Перед содержимым опции";
+            };
+            readonly 'item-trailing': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<ISelectItem<import("@soxa-ui/core").ISelectItemProps, import("@soxa-ui/core").TSelectItemEvents>>;
+                };
+                readonly description: "После содержимого опции";
+            };
+            readonly 'item-indicator-icon': {
+                readonly scope: {
+                    readonly item: import("../../../..").TPropType<ISelectItem<import("@soxa-ui/core").ISelectItemProps, import("@soxa-ui/core").TSelectItemEvents>>;
+                    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 open: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:open"];
+            };
+            readonly placeholder: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:placeholder"];
+            };
+            readonly closeOnSelect: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:closeOnSelect"];
+            };
+            /**
+             * Кнопку очистки рисует поле: `clearable` Select отдаёт ему, как
+             * `name` и `size`, а имя кнопке пишет плагин имён самого поля.
+             */
+            readonly clearable: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:clearable"];
+            };
+            readonly editable: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:editable"];
+            };
+            readonly editableMode: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:editableMode"];
+            };
+            readonly removeOnBackspace: {
+                readonly type: BooleanConstructor;
+                readonly triggers: readonly ["change:removeOnBackspace"];
+            };
+            readonly placement: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:placement"];
+            };
+            /** За что панель смахивают, чтобы закрыть. По умолчанию — ни за что. */
+            readonly swipe: {
+                readonly type: StringConstructor;
+                readonly triggers: readonly ["change:swipe"];
+            };
+            /**
+             * Роль, `id` и множественность списка. Набор Select'а, а не свой:
+             * список — разметка внутри шаблона, экземпляра у него нет.
+             */
+            readonly listAria: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:listAria"];
+            };
+            /** Можно ли открыть панель: запрещает только `disabled`. */
+            readonly openable: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:disabled"];
+            };
+            /**
+             * Подгонять ли ширину панели под поле — производное от `contentFit`.
+             *
+             * Вычисляет ядро, шаблон только пробрасывает в `anchor_matchWidth`.
+             * Оставь выражение `contentFit !== 'expand'` в разметке — и оно
+             * повторится в каждом из шести адаптеров.
+             */
+            readonly autoFitWidth: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:contentFit"];
+            };
+            /**
+             * Сторона панели и разрешение flip для плагина якоря — производные от
+             * `placement`, как `autoFitWidth` от `contentFit`. Вычисляет ядро,
+             * шаблон только пробрасывает в `anchor_placement` и `anchor_flip`.
+             */
+            readonly panelPlacement: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:placement"];
+            };
+            readonly panelFlip: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:placement"];
+            };
+            /**
+             * `data-*` панели: тянут ли её. Панель — Frame без экземпляра в ядре,
+             * и набор для неё — Select'а, как `listAria` списка. Открытость панели
+             * (`data-open`) пишет её слой, сторону (`data-placement`) — плагин
+             * якоря.
+             */
+            readonly panelDataset: {
+                readonly type: ObjectConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:swiping"];
+            };
+            /**
+             * Рисовать ли полосу, за которую тянут. Вычисляет ядро: разметка
+             * без экземпляра формулу не повторяет.
+             */
+            readonly handleRendered: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:swipe"];
+            };
+            /**
+             * Whether the panel's options from data are mounted: from the first
+             * opening on. Options in markup are the consumer's content and are
+             * mounted from the start.
+             */
+            readonly contentRendered: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:open"];
+            };
+        };
+        readonly events: readonly ["open", "close", "change:open", "change:placeholder", "change:closeOnSelect", "change:clearable", "change:editable", "change:editableMode", "change:removeOnBackspace", "change:placement", "change:swipe", "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<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").TSelectPointerPlugin, "pointer", {}>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<TSelectKeyboardPlugin, "keyboard", {
+        readonly events: readonly ["change:highlight"];
+        readonly props: {
+            readonly highlightedUid: {
+                readonly protected: true;
+                readonly triggers: readonly ["change:highlight"];
+            };
+        };
+    }>>, 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").TEditablePlugin, "editable", {
+        readonly events: readonly ["change:query"];
+        readonly props: {
+            readonly query: {
+                readonly protected: true;
+                readonly triggers: readonly ["change:query"];
+            };
+        };
+    }>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TSelectBackspacePlugin, "backspace", {}>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TSelectIdsPlugin, "ids", import("../../../..").IContribution>>, import("../../../..").IPluginDefinition<import("../../../../protected/define/inference.types").TPluginContractFrom<import("@soxa-ui/plugins").TSwipePlugin, "swipe", import("../../../..").IContribution>>];
+}>>;