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

package/dist/content/descriptors/components/number-input.descriptor.js

@@ -0,0 +1,209 @@
+import { defineComponent } from "../../../protected/define/component.js";
+import { defineDescriptor } from "../../../protected/define/descriptor.js";
+import { defineType } from "../../../protected/define/prop-type.js";
+import { LocalePluginDescriptor } from "../plugins/locale.plugin.js";
+import { ActionPluginDescriptor } from "../plugins/action.plugin.js";
+import { NumberInputTypingPluginDescriptor } from "../plugins/number-input-typing.plugin.js";
+import { NumberInputKeyboardPluginDescriptor } from "../plugins/number-input-keyboard.plugin.js";
+import { NumberInputStepperPluginDescriptor } from "../plugins/number-input-stepper.plugin.js";
+import { NumberInputTouchPluginDescriptor } from "../plugins/number-input-touch.plugin.js";
+import { NumberInputNamesPluginDescriptor } from "../plugins/number-input-names.plugin.js";
+import { ClearableDescriptor } from "./clearable.descriptor.js";
+import { TNumberInput } from "@soxa-ui/core";
+import { fieldOf } from "@soxa-ui/plugins";
+//#region content/descriptors/components/number-input.descriptor.ts
+/**
+* Дескриптор NumberInput (TNumberInput) — поле числа.
+*
+* Наследует `ClearableDescriptor` (кнопка очистки — clearable, clearAria — поверх
+* value, name, readonly, required, id, disabled, size, variant, ...) и
+* добавляет границы и шаг, крупный шаг, формат числа (`formatOptions`:
+* процент, валюта, единица, точность), подсказку пустого поля, слоты
+* `leading`, `clear`, `trailing` и значков кнопок шага и событие `commit` —
+* конец действия. Язык формата — тег локали поддерева: его пишет плагин
+* языка, имена кнопок очистки и шага — плагин имён поля.
+*
+* Число набирают в поле текстом в формате локали: что набирается, решает ядро,
+* а правку браузера до него доводит плагин набора; клавиши шага и кнопки шага
+* с удержанием переводят в команды ядра свои плагины.
+*
+* Разметка: корень — коробка поля, в нём слоты, ввод `<input type="text">` с
+* ролью `spinbutton`, кнопки «меньше» и «больше» — не остановки Tab — и
+* скрытое поле формы. См. AGENTS.md, «Готовые паттерны», NumberInput.
+*/
+/**
+* Поводы перечитать, выключена ли кнопка шага: итог значения, шкала, выключенное
+* поле и только для чтения.
+*/
+var STEPPER_TRIGGERS = [
+	"change:value",
+	"change:min",
+	"change:max",
+	"change:step",
+	"change:disabled",
+	"change:readonly"
+];
+var NumberInputDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TNumberInput,
+	extends: ClearableDescriptor(),
+	contribution: {
+		/**
+		* Слоты стоят по сторонам ввода, как у Input: содержимое получает сам
+		* инстанс поля — кнопке рядом нужны его значение и команды. Кнопка
+		* очистки стоит в обёртке `trailing` перед его содержимым; кнопки шага —
+		* после слотов, у конца поля.
+		*
+		* Своя кнопка очистки (`clear`) заменяет встроенную целиком и рисуется,
+		* когда задана, без `clearable`. Значки кнопок шага — свои слоты: кнопка с
+		* удержанием остаётся своей, меняется значок.
+		*/
+		slots: {
+			leading: {
+				scope: { ctrl: defineType(Object) },
+				description: "Перед числом"
+			},
+			clear: {
+				scope: { clear: defineType(Function) },
+				description: "Кнопка очистки значения"
+			},
+			trailing: {
+				scope: { ctrl: defineType(Object) },
+				description: "После числа и кнопки очистки"
+			},
+			"decrement-icon": { description: "Значок кнопки «меньше». По умолчанию — иконка роли minus" },
+			"increment-icon": { description: "Значок кнопки «больше». По умолчанию — иконка роли plus" }
+		},
+		props: {
+			/**
+			* Числом: значение поля — число, а не текст; пусто — не задано.
+			* Триггер остаётся у ValueControl.
+			*/
+			value: { type: Number },
+			min: {
+				type: Number,
+				triggers: ["change:min"]
+			},
+			max: {
+				type: Number,
+				triggers: ["change:max"]
+			},
+			step: {
+				type: Number,
+				triggers: ["change:step"]
+			},
+			largeStep: {
+				type: Number,
+				triggers: ["change:largeStep"]
+			},
+			/**
+			* Опции `Intl.NumberFormat` — процент, валюта, единица, точность.
+			* Сверяются по содержимому: литерал в разметке на каждом проходе — не
+			* смена.
+			*/
+			formatOptions: {
+				type: Object,
+				triggers: ["change:formatOptions"]
+			},
+			placeholder: {
+				type: String,
+				triggers: ["change:placeholder"]
+			},
+			/**
+			* Язык формата — не вход: его задаёт приложение на всю библиотеку,
+			* и пишет плагин языка.
+			*/
+			locale: {
+				type: String,
+				protected: true,
+				triggers: ["change:locale"]
+			},
+			/** Текст ввода — буфер правки ядра: набранное или число строкой формата. */
+			text: {
+				type: String,
+				protected: true,
+				triggers: ["change:text"]
+			},
+			decrementDisabled: {
+				type: Boolean,
+				protected: true,
+				triggers: [...STEPPER_TRIGGERS]
+			},
+			incrementDisabled: {
+				type: Boolean,
+				protected: true,
+				triggers: [...STEPPER_TRIGGERS]
+			},
+			/** Наборы кнопок шага: `tabindex` — ядро, имя — плагин имён. */
+			decrementAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:decrementAria"]
+			},
+			incrementAria: {
+				type: Object,
+				protected: true,
+				triggers: ["change:incrementAria"]
+			},
+			/** Наборы темы кнопок шага: `data-pressed`, пока кнопку держат. */
+			decrementDataset: {
+				type: Object,
+				protected: true,
+				triggers: ["change:decrementDataset"]
+			},
+			incrementDataset: {
+				type: Object,
+				protected: true,
+				triggers: ["change:incrementDataset"]
+			},
+			/**
+			* ARIA ввода: роль счётчика, число и его строка, заданные границы;
+			* поверх — набор поля от плагинов. Перечитывается на значение,
+			* границы, формат и смену набора.
+			*/
+			inputAria: {
+				type: Object,
+				protected: true,
+				triggers: [
+					"change:inputSets",
+					"change:value",
+					"change:min",
+					"change:max",
+					"change:locale",
+					"change:formatOptions"
+				]
+			},
+			/** `dir`, `lang` и `inputmode` ввода — по формату; поверх — набор поля. */
+			inputAttrs: {
+				type: Object,
+				protected: true,
+				triggers: [
+					"change:inputSets",
+					"change:locale",
+					"change:formatOptions"
+				]
+			}
+		},
+		events: [
+			"commit",
+			"change:min",
+			"change:max",
+			"change:step",
+			"change:largeStep",
+			"change:formatOptions",
+			"change:placeholder",
+			"change:locale",
+			"change:text"
+		]
+	},
+	plugins: [
+		ActionPluginDescriptor.with({ focusTarget: fieldOf }),
+		NumberInputNamesPluginDescriptor,
+		LocalePluginDescriptor,
+		NumberInputTypingPluginDescriptor,
+		NumberInputKeyboardPluginDescriptor,
+		NumberInputStepperPluginDescriptor,
+		NumberInputTouchPluginDescriptor
+	]
+}));
+//#endregion
+export { NumberInputDescriptor };

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

@@ -0,0 +1,54 @@
+/**
+ * Дескрипторы коллекционной части Pagination — фасады владельца и страницы.
+ *
+ * Членство в коллекции отделено от собственных пропсов компонента
+ * (`PaginationDescriptor`, `PaginationItemDescriptor`): адаптер собирает
+ * компонент из обоих рантайм-списков.
+ *
+ * Базы `CollectionDescriptor` здесь нет, как у календаря: её `items` и
+ * `trackBy` пагинации не положены. Страницы окна кладёт в коллекцию
+ * расширение пагинации, ключ сверки — ключ страницы, и чужой `trackBy`
+ * сломал бы её. Движок снаружи (`engine`) — положен, как у остальных
+ * коллекций.
+ */
+import { TPaginationCollectionFacade, TPaginationItemCollectionFacade } from '@soxa-ui/core';
+export declare const PaginationCollectionDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TPaginationCollectionFacade;
+    /**
+     * Коллекционные props владельца Pagination — то, что выводит фасад
+     * `TPaginationCollectionFacade`: окно. Текущую страницу наружу отдаёт
+     * `value` пагинации, поэтому событий активации здесь нет.
+     */
+    readonly contribution: {
+        readonly props: {
+            /**
+             * Готовая коллекция снаружи — аналог `ctrl` у компонента, как у
+             * остальных коллекций (`CollectionDescriptor`). Без триггеров: это
+             * вход, а не наблюдаемое значение. Собирает её
+             * `createEnginePagination`; чего движку не хватает, фасад
+             * доустановит при привязке.
+             */
+            readonly engine: {
+                readonly type: ObjectConstructor;
+            };
+            /**
+             * Окно по порядку: страницы (элементы коллекции) и пропуски между
+             * ними. Разметка — одна петля по нему, ключ места — `key`.
+             */
+            readonly cells: {
+                readonly type: ArrayConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:cells"];
+            };
+        };
+    };
+}>>;
+export declare const PaginationCollectionItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TPaginationItemCollectionFacade;
+    /**
+     * Пропсов нет. Текущую страницу отмечают расширения коллекции прямо в её
+     * наборах — `data-selected` и `aria-current`, — и разметке читать
+     * `active` незачем.
+     */
+    readonly contribution: {};
+}>>;

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

@@ -0,0 +1,55 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { TPaginationCollectionFacade, TPaginationItemCollectionFacade } from "@soxa-ui/core";
+//#region content/descriptors/components/pagination/collection.descriptor.ts
+/**
+* Дескрипторы коллекционной части Pagination — фасады владельца и страницы.
+*
+* Членство в коллекции отделено от собственных пропсов компонента
+* (`PaginationDescriptor`, `PaginationItemDescriptor`): адаптер собирает
+* компонент из обоих рантайм-списков.
+*
+* Базы `CollectionDescriptor` здесь нет, как у календаря: её `items` и
+* `trackBy` пагинации не положены. Страницы окна кладёт в коллекцию
+* расширение пагинации, ключ сверки — ключ страницы, и чужой `trackBy`
+* сломал бы её. Движок снаружи (`engine`) — положен, как у остальных
+* коллекций.
+*/
+var PaginationCollectionDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TPaginationCollectionFacade,
+	/**
+	* Коллекционные props владельца Pagination — то, что выводит фасад
+	* `TPaginationCollectionFacade`: окно. Текущую страницу наружу отдаёт
+	* `value` пагинации, поэтому событий активации здесь нет.
+	*/
+	contribution: { props: {
+		/**
+		* Готовая коллекция снаружи — аналог `ctrl` у компонента, как у
+		* остальных коллекций (`CollectionDescriptor`). Без триггеров: это
+		* вход, а не наблюдаемое значение. Собирает её
+		* `createEnginePagination`; чего движку не хватает, фасад
+		* доустановит при привязке.
+		*/
+		engine: { type: Object },
+		/**
+		* Окно по порядку: страницы (элементы коллекции) и пропуски между
+		* ними. Разметка — одна петля по нему, ключ места — `key`.
+		*/
+		cells: {
+			type: Array,
+			protected: true,
+			triggers: ["change:cells"]
+		}
+	} }
+}));
+var PaginationCollectionItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TPaginationItemCollectionFacade,
+	/**
+	* Пропсов нет. Текущую страницу отмечают расширения коллекции прямо в её
+	* наборах — `data-selected` и `aria-current`, — и разметке читать
+	* `active` незачем.
+	*/
+	contribution: {}
+}));
+//#endregion
+export { PaginationCollectionDescriptor, PaginationCollectionItemDescriptor };

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

@@ -0,0 +1,3 @@
+export { PaginationDescriptor } from './pagination.descriptor';
+export { PaginationItemDescriptor } from './item.descriptor';
+export { PaginationCollectionDescriptor, PaginationCollectionItemDescriptor, } from './collection.descriptor';

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

@@ -0,0 +1,156 @@
+/**
+ * Дескриптор PaginationItem (TPaginationItem) — страница пагинации.
+ *
+ * Внутренняя часть, как тост у Toasts: страницу в разметку не ставят, её
+ * рисует пагинация, по одной на место окна, и наружу адаптеров она не
+ * выходит (см. «Часть или слот»).
+ *
+ * Наследует `StylableDescriptor`, а не `ControlDescriptor`, как день
+ * календаря: входов у страницы нет. Ключ и текст кладёт в коллекцию
+ * расширение пагинации, «выключена», размер и вариант — пагинации; всё это
+ * только читается, поэтому объявлено защищённым. Защищены и `name` с
+ * `focused` класса: ни в форму, ни в фокус разметка их не пишет. Плагины
+ * Control странице не нужны: нажатие — активация коллекции из разметки, имя —
+ * её текст.
+ */
+import { TPaginationItem } from '@soxa-ui/core';
+export declare const PaginationItemDescriptor: () => import("../../../..").IComponentDescriptor<import("../../../../protected/define/inference.types").TContractFrom<{
+    readonly ctor: typeof TPaginationItem;
+    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 slots: {
+            readonly default: {
+                readonly scope: {
+                    readonly text: import("../../../..").TPropType<string>;
+                };
+                readonly description: "Содержимое страницы. Без него — номер или текст страницы";
+            };
+        };
+        readonly props: {
+            readonly disabled: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:disabled"];
+            };
+            readonly focused: {
+                readonly type: BooleanConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:focused"];
+            };
+            readonly value: {
+                readonly type: readonly [StringConstructor, NumberConstructor];
+                readonly protected: true;
+                readonly triggers: readonly ["change:value"];
+            };
+            readonly name: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:name"];
+            };
+            readonly text: {
+                readonly type: StringConstructor;
+                readonly protected: true;
+                readonly triggers: readonly ["change:text"];
+            };
+            readonly size: {
+                readonly protected: true;
+            };
+            readonly variant: {
+                readonly protected: true;
+            };
+        };
+        readonly events: readonly ["change:disabled", "change:focused", "change:value", "change:name", "change:text"];
+    };
+}>>;

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

@@ -0,0 +1,68 @@
+import { defineComponent } from "../../../../protected/define/component.js";
+import { defineDescriptor } from "../../../../protected/define/descriptor.js";
+import { defineType } from "../../../../protected/define/prop-type.js";
+import { OWNER_STYLE_PROPS, StylableDescriptor } from "../stylable.descriptor.js";
+import { TPaginationItem } from "@soxa-ui/core";
+//#region content/descriptors/components/pagination/item.descriptor.ts
+/**
+* Дескриптор PaginationItem (TPaginationItem) — страница пагинации.
+*
+* Внутренняя часть, как тост у Toasts: страницу в разметку не ставят, её
+* рисует пагинация, по одной на место окна, и наружу адаптеров она не
+* выходит (см. «Часть или слот»).
+*
+* Наследует `StylableDescriptor`, а не `ControlDescriptor`, как день
+* календаря: входов у страницы нет. Ключ и текст кладёт в коллекцию
+* расширение пагинации, «выключена», размер и вариант — пагинации; всё это
+* только читается, поэтому объявлено защищённым. Защищены и `name` с
+* `focused` класса: ни в форму, ни в фокус разметка их не пишет. Плагины
+* Control странице не нужны: нажатие — активация коллекции из разметки, имя —
+* её текст.
+*/
+var PaginationItemDescriptor = defineDescriptor(() => defineComponent({
+	ctor: TPaginationItem,
+	extends: StylableDescriptor(),
+	contribution: {
+		slots: { default: {
+			scope: { text: defineType(String) },
+			description: "Содержимое страницы. Без него — номер или текст страницы"
+		} },
+		props: {
+			...OWNER_STYLE_PROPS,
+			disabled: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:disabled"]
+			},
+			focused: {
+				type: Boolean,
+				protected: true,
+				triggers: ["change:focused"]
+			},
+			value: {
+				type: [String, Number],
+				protected: true,
+				triggers: ["change:value"]
+			},
+			name: {
+				type: String,
+				protected: true,
+				triggers: ["change:name"]
+			},
+			text: {
+				type: String,
+				protected: true,
+				triggers: ["change:text"]
+			}
+		},
+		events: [
+			"change:disabled",
+			"change:focused",
+			"change:value",
+			"change:name",
+			"change:text"
+		]
+	}
+}));
+//#endregion
+export { PaginationItemDescriptor };