@central-design-system/components 4.0.0-alpha.4 → 4.0.0-alpha.5

package/dist/esm-node/src/composables/useForm/useForm.mjs

@@ -7,11 +7,23 @@ import { F as FormKey } from "./internal/useForm.constants.mjs";
 import { w as warn } from "../../utils/dom/console.mjs";
 const defineFormProps = propsFactory(
   {
+    /**
+     * Останавливает валидацию на первом же невалидном поле — остальные поля не проверяются
+     * @en Stops the validation at the very first invalid field — the remaining fields are not checked
+     */
     firstFail: Boolean,
+    /**
+     * Итоговая валидность формы: `true` — все поля прошли проверку, `false` — есть ошибки, `null` — форма ещё не валидировалась
+     * @en Resulting validity of the form: `true` — every field passed the check, `false` — there are errors, `null` — the form has not been validated yet
+     */
     modelValue: {
       type: Boolean,
       default: null
     },
+    /**
+     * Когда запускать валидацию полей формы: при вводе, потере фокуса или только вручную
+     * @en When to run the validation of the form fields: on input, on blur or manually only
+     */
     validateOn: {
       type: String,
       default: "input"
@@ -106,14 +118,47 @@ function createForm(props) {
     validateOn: toRef(() => props.validateOn)
   });
   return {
+    /**
+     * Ошибки валидации полей формы: идентификатор поля и его сообщения об ошибках.
+     * @en Validation errors of the form fields: the identifier of a field and its error messages.
+     */
     errors,
+    /**
+     * Заблокированы ли все поля формы.
+     * @en Whether all the fields of the form are blocked.
+     */
     isDisabled,
+    /**
+     * Доступны ли поля формы только для чтения.
+     * @en Whether the fields of the form are read-only.
+     */
     isReadonly,
+    /**
+     * Идёт ли сейчас валидация формы.
+     * @en Whether the form is being validated right now.
+     */
     isValidating,
+    /**
+     * Валидность формы: `true` — все поля прошли проверку, `false` — есть ошибки, `null` — форма ещё не валидировалась.
+     * @en Validity of the form: `true` — every field passed the check, `false` — there are errors, `null` — the form has not been validated yet.
+     */
     isValid: model,
+    /**
+     * Зарегистрированные в форме поля с их состоянием валидации.
+     * @en The fields registered in the form together with their validation state.
+     */
     items,
+    /**
+     * Запускает валидацию всех полей формы и возвращает результат вместе со списком ошибок.
+     * @en Runs the validation of all the form fields and returns the result together with the list of errors.
+     */
     validate,
+    /** Сбрасывает значения всех полей формы и их валидацию. */
     reset,
+    /**
+     * Сбрасывает только состояние валидации, сохраняя введённые значения.
+     * @en Resets the validation state only, keeping the entered values.
+     */
     resetValidation
   };
 }

package/dist/esm-node/src/composables/useGroup/useGroup.mjs

@@ -7,20 +7,38 @@ import { x as deepEqual, ac as wrapInArray, F as findChildrenWithProvide } from
 import { w as warn } from "../../utils/dom/console.mjs";
 const defineGroupProps = propsFactory(
   {
-    /** Значение выбранных элементов группы */
+    /**
+     * Значение выбранных элементов группы
+     * @en Value of the selected items of the group
+     */
     modelValue: {
       type: null,
       default: void 0
     },
-    /** Разрешить множественный выбор */
+    /**
+     * Разрешить множественный выбор
+     * @en Allows selecting several items at once
+     */
     multiple: Boolean,
-    /** Обязательный выбор хотя бы одного элемента */
+    /**
+     * Обязательный выбор хотя бы одного элемента
+     * @en Requires at least one item to stay selected
+     */
     required: [Boolean, String],
-    /** Обязательный выбор хотя бы одного элемента */
+    /**
+     * Обязательный выбор хотя бы одного элемента
+     * @en Requires at least one item to stay selected
+     */
     mandatory: [Boolean, String],
-    /** Максимальное количество выбираемых элементов */
+    /**
+     * Максимальное количество выбираемых элементов
+     * @en Maximum number of items that can be selected
+     */
     max: Number,
-    /** CSS класс для выбранного состояния */
+    /**
+     * CSS класс для выбранного состояния
+     * @en CSS class applied in the selected state
+     */
     selectedClass: String,
     ...defineDisabledProps()
   },

package/dist/esm-node/src/composables/useGroup/useGroupItem.mjs

@@ -4,9 +4,15 @@ import { p as propsFactory } from "../../core/propsFactory.mjs";
 import { useId, provide, inject, toRef, computed, unref, onBeforeUnmount, watch } from "vue";
 const defineGroupItemProps = propsFactory(
   {
-    /** Значение компонента в группе */
+    /**
+     * Значение компонента в группе
+     * @en Value of the component within the group
+     */
     value: null,
-    /** CSS класс для выбранного состояния */
+    /**
+     * CSS класс для выбранного состояния
+     * @en CSS class applied in the selected state
+     */
     selectedClass: String,
     ...defineDisabledProps()
   },

package/dist/esm-node/src/composables/useItems/useItems.mjs

@@ -3,39 +3,63 @@ import { computed, shallowRef, watchEffect } from "vue";
 import { W as isPrimitive, a7 as pick, x as deepEqual, M as getPropertyFromItem, a3 as omit } from "../../utils/helpers.mjs";
 const defineItemsProps = propsFactory(
   {
-    /** Массив элементов для отображения */
+    /**
+     * Массив элементов для отображения
+     * @en Array of items to display
+     */
     items: {
       type: Array,
       default: () => []
     },
-    /** Свойство объекта, используемое как заголовок элемента, либо функция для его получения */
+    /**
+     * Свойство объекта, используемое как заголовок элемента, либо функция для его получения
+     * @en Object field used as the item title, or a function that returns it
+     */
     itemTitle: {
       type: [String, Array, Function],
       default: "title"
     },
-    /** Свойство объекта, используемое как значение элемента, либо функция для его получения */
+    /**
+     * Свойство объекта, используемое как значение элемента, либо функция для его получения
+     * @en Object field used as the item value, or a function that returns it
+     */
     itemValue: {
       type: [String, Array, Function],
       default: "value"
     },
-    /** Свойство объекта, содержащее дочерние элементы, либо функция для их получения */
+    /**
+     * Свойство объекта, содержащее дочерние элементы, либо функция для их получения
+     * @en Object field that holds the child items, or a function that returns them
+     */
     itemChildren: {
       type: [Boolean, String, Array, Function],
       default: "children"
     },
-    /** Свойство объекта, содержащее пропсы для элемента, либо функция для их получения */
+    /**
+     * Свойство объекта, содержащее пропсы для элемента, либо функция для их получения
+     * @en Object field that holds the props of the item, or a function that returns them
+     */
     itemProps: {
       type: [Boolean, String, Array, Function],
       default: "props"
     },
-    /** Свойство объекта, определяющее тип элемента (`item`, `divider`, `subheader`), либо функция для его получения */
+    /**
+     * Свойство объекта, определяющее тип элемента (`item`, `divider`, `subheader`), либо функция для его получения
+     * @en Object field that defines the item type (`item`, `divider`, `subheader`), or a function that returns it
+     */
     itemType: {
       type: [Boolean, String, Array, Function],
       default: "type"
     },
-    /** Возвращать в значении модели объект вместо массива */
+    /**
+     * Возвращать в значении модели объект вместо массива
+     * @en Return an object in the model value instead of an array
+     */
     returnObject: Boolean,
-    /** Функция сравнения значений элементов для определения выбранного состояния */
+    /**
+     * Функция сравнения значений элементов для определения выбранного состояния
+     * @en Function that compares item values to determine the selected state
+     */
     valueComparator: Function
   },
   "list-items"

package/dist/esm-node/src/composables/useLayout/useLayout.mjs

@@ -5,32 +5,50 @@ import { u as useDisplay } from "../useDisplay/useDisplay.mjs";
 import { a as IN_BROWSER } from "../../utils/dom/globals.mjs";
 const defineLayoutProps = propsFactory(
   {
-    /** Видимость элемента в макете. */
+    /**
+     * Видимость элемента в макете.
+     * @en Visibility of the element in the layout.
+     */
     modelValue: {
       type: Boolean,
       default: true
     },
-    /** Плавающий режим: элемент появляется/скрывается при скролле. */
+    /**
+     * Плавающий режим: элемент появляется/скрывается при скролле.
+     * @en Floating mode: the element appears/hides on scroll.
+     */
     reveal: {
       type: Boolean,
       default: false
     },
-    /** Порог скролла (px), до которого плавающий элемент остаётся видимым. */
+    /**
+     * Порог скролла (px), до которого плавающий элемент остаётся видимым.
+     * @en Scroll threshold (px) up to which the floating element stays visible.
+     */
     revealOffset: {
       type: Number,
       default: 250
     },
-    /** Отображение границы. */
+    /**
+     * Отображение границы.
+     * @en Shows the border.
+     */
     bordered: {
       type: Boolean,
       default: false
     },
-    /** Отображение тени. */
+    /**
+     * Отображение тени.
+     * @en Shows the shadow.
+     */
     elevated: {
       type: Boolean,
       default: false
     },
-    /** Высота элемента. */
+    /**
+     * Высота элемента.
+     * @en Height of the element.
+     */
     height: {
       type: [String, Number],
       default: 50

package/dist/esm-node/src/composables/useLazy/useLazy.mjs

@@ -5,6 +5,7 @@ const defineLazyProps = propsFactory(
     /**
      * Принудительно рендерит содержимое компонента при его использовании.
      * Это полезно, если у вас есть контент, который не отображается в DOM, но который необходимо проиндексировать для SEO.
+     * @en Renders the content of the component right away. Useful when you have content that is not in the DOM but has to be indexed for SEO.
      */
     eager: Boolean
   },

package/dist/esm-node/src/composables/useLoader/index.mjs

@@ -1,2 +1,2 @@
-
+import "vue";
 //# sourceMappingURL=index.mjs.map

package/dist/esm-node/src/composables/useLoader/useLoader.mjs

@@ -3,7 +3,10 @@ import { p as propsFactory } from "../../core/propsFactory.mjs";
 import { toRef, toValue } from "vue";
 const defineLoaderProps = propsFactory(
   {
-    /** Индикатор загрузки для компонента */
+    /**
+     * Индикатор загрузки для компонента
+     * @en Loading indicator for the component
+     */
     loading: {
       type: [Boolean, String],
       default: void 0

package/dist/esm-node/src/composables/useLocation/index.mjs

@@ -1,2 +1,2 @@
-
+import "vue";
 //# sourceMappingURL=index.mjs.map

package/dist/esm-node/src/composables/useLocation/useLocation.mjs

@@ -11,7 +11,10 @@ const oppositeMap = {
 };
 const defineLocationProps = propsFactory(
   {
-    /** Позиционирование элемента относительно его контейнера. Например, "top left", "center", "bottom right" и т.д. */
+    /**
+     * Позиционирование элемента относительно его контейнера. Например, "top left", "center", "bottom right" и т.д.
+     * @en Position of the element relative to its container, for example "top left", "center", "bottom right".
+     */
     location: String
   },
   "location"

package/dist/esm-node/src/composables/useNested/useNested.mjs

@@ -10,27 +10,60 @@ import { t as throttle } from "../../utils/throttle.mjs";
 import { e as error } from "../../utils/dom/console.mjs";
 const defineNestedProps = propsFactory(
   {
-    /** Разрешает активацию элементов (выделение текущего элемента без режима выбора) */
+    /**
+     * Разрешает активацию элементов (выделение текущего элемента без режима выбора)
+     * @en Allows items to be activated (highlighting the current item without selection mode)
+     */
     activatable: Boolean,
-    /** Разрешает выбор элементов */
+    /**
+     * Разрешает выбор элементов
+     * @en Allows items to be selected
+     */
     selectable: Boolean,
-    /** Стратегия активации элементов (одиночная, множественная и т.д.) */
+    /**
+     * Стратегия активации элементов (одиночная, множественная и т.д.)
+     * @en Activation strategy for items (single, multiple, and so on)
+     */
     activeStrategy: [String, Function, Object],
-    /** Стратегия выбора элементов (`single-leaf`, `leaf`, `independent`, `classic` и т.д.) */
+    /**
+     * Стратегия выбора элементов (`single-leaf`, `leaf`, `independent`, `classic` и т.д.)
+     * @en Selection strategy for items (`single-leaf`, `leaf`, `independent`, `classic`, and so on)
+     */
     selectStrategy: [String, Function, Object],
-    /** Стратегия раскрытия групп (`list`, `single`, `multiple`) */
+    /**
+     * Стратегия раскрытия групп (`list`, `single`, `multiple`)
+     * @en Expansion strategy for groups (`list`, `single`, `multiple`)
+     */
     openStrategy: [String, Object],
-    /** Идентификаторы раскрытых групп (поддерживает v-model через `update:opened`) */
+    /**
+     * Идентификаторы раскрытых групп (поддерживает v-model через `update:opened`)
+     * @en Identifiers of the expanded groups (supports v-model through `update:opened`)
+     */
     opened: null,
-    /** Идентификаторы активных элементов (поддерживает v-model через `update:activated`) */
+    /**
+     * Идентификаторы активных элементов (поддерживает v-model через `update:activated`)
+     * @en Identifiers of the active items (supports v-model through `update:activated`)
+     */
     activated: null,
-    /** Идентификаторы выбранных элементов (поддерживает v-model через `update:selected`) */
+    /**
+     * Идентификаторы выбранных элементов (поддерживает v-model через `update:selected`)
+     * @en Identifiers of the selected items (supports v-model through `update:selected`)
+     */
     selected: null,
-    /** Делает выбор обязательным: запрещает снимать выбор с последнего элемента */
+    /**
+     * Делает выбор обязательным: запрещает снимать выбор с последнего элемента
+     * @en Makes the selection mandatory: forbids clearing the selection of the last item
+     */
     mandatory: Boolean,
-    /** Делает выбор обязательным: запрещает снимать выбор с последнего элемента */
+    /**
+     * Делает выбор обязательным: запрещает снимать выбор с последнего элемента
+     * @en Makes the selection mandatory: forbids clearing the selection of the last item
+     */
     required: Boolean,
-    /** Стратегия регистрации элементов: `render` — по мере рендеринга, иначе единоразово */
+    /**
+     * Стратегия регистрации элементов: `render` — по мере рендеринга, иначе единоразово
+     * @en Item registration strategy: `render` — as they are rendered, otherwise all at once
+     */
     itemsRegistration: {
       type: String,
       default: "render"

package/dist/esm-node/src/composables/usePosition/usePosition.mjs

@@ -4,6 +4,10 @@ import { toRef } from "vue";
 const positionValues = ["static", "relative", "fixed", "absolute", "sticky"];
 const definePositionProps = propsFactory(
   {
+    /**
+     * CSS-позиционирование компонента — значение свойства `position`
+     * @en CSS positioning of the component — the value of the `position` property
+     */
     position: {
       type: String,
       validator: (v) => positionValues.includes(v)

package/dist/esm-node/src/composables/useReadonly/useReadonly.mjs

@@ -2,7 +2,10 @@ import { p as propsFactory } from "../../core/propsFactory.mjs";
 import "vue";
 const defineReadonlyProps = propsFactory(
   {
-    /** Только для чтения */
+    /**
+     * Только для чтения
+     * @en Read-only state
+     */
     readonly: {
       type: Boolean,
       default: null

package/dist/esm-node/src/composables/useReveal/useReveal.mjs

@@ -2,7 +2,10 @@ import { p as propsFactory } from "../../core/propsFactory.mjs";
 import { toRef, shallowRef, onMounted } from "vue";
 const defineRevealProps = propsFactory(
   {
-    /** Анимирует индикатор от нуля до текущего значения при появлении компонента. Объект `{ duration }` задаёт длительность анимации в миллисекундах */
+    /**
+     * Анимирует индикатор от нуля до текущего значения при появлении компонента. Объект `{ duration }` задаёт длительность анимации в миллисекундах
+     * @en Animates the indicator from zero to the current value when the component appears. The `{ duration }` object sets the animation duration in milliseconds
+     */
     reveal: {
       type: [Boolean, Object],
       default: false

package/dist/esm-node/src/composables/useRouter/index.mjs

@@ -1,2 +1,2 @@
-
+import "vue";
 //# sourceMappingURL=index.mjs.map

package/dist/esm-node/src/composables/useRouter/useRouter.mjs

@@ -5,22 +5,34 @@ import { N as hasEvent, x as deepEqual } from "../../utils/helpers.mjs";
 import { a as IN_BROWSER } from "../../utils/dom/globals.mjs";
 const defineRouterProps = propsFactory(
   {
-    /** Атрибут href для ссылки. Если указан, компонент будет вести себя как обычная ссылка */
+    /**
+     * Атрибут href для ссылки. Если указан, компонент будет вести себя как обычная ссылка
+     * @en The `href` attribute of the link. When set, the component behaves as a regular link
+     */
     href: {
       type: String,
       default: void 0
     },
-    /** Если true, навигация по маршруту будет заменять текущую запись в истории вместо добавления новой */
+    /**
+     * Если true, навигация по маршруту будет заменять текущую запись в истории вместо добавления новой
+     * @en If true, navigation replaces the current history entry instead of pushing a new one
+     */
     replace: {
       type: Boolean,
       default: void 0
     },
-    /** Маршрут назначения или объект для RouterLink. Если указан, компонент будет вести себя как RouterLink */
+    /**
+     * Маршрут назначения или объект для RouterLink. Если указан, компонент будет вести себя как RouterLink
+     * @en Target route or route location object for RouterLink. When set, the component behaves as a RouterLink
+     */
     to: {
       type: [String, Object],
       default: void 0
     },
-    /** Если true, активное состояние будет применяться только при точном совпадении маршрута */
+    /**
+     * Если true, активное состояние будет применяться только при точном совпадении маршрута
+     * @en If true, the active state applies only on an exact route match
+     */
     exact: {
       type: Boolean,
       default: void 0

package/dist/esm-node/src/composables/useSize/useSize.mjs

@@ -5,7 +5,10 @@ import { z as destructComputed, e as includes, u as convertToUnit } from "../../
 const availableSizes = ["xs", "sm", "md", "lg", "xl"];
 const defineSizeProps = propsFactory(
   {
-    /** Размер компонента */
+    /**
+     * Размер компонента
+     * @en Size of the component
+     */
     size: {
       type: [String, Number],
       default: "md",

package/dist/esm-node/src/composables/useStatus/useStatus.mjs

@@ -3,7 +3,10 @@ import { computed } from "vue";
 import { s as statusIcons } from "./internal/useStatus.constants.mjs";
 const defineStatusProps = propsFactory(
   {
-    /** Семантический статус — определяет цвет и дефолтную иконку. */
+    /**
+     * Семантический статус — определяет цвет и дефолтную иконку.
+     * @en Semantic status — drives the color and the default icon.
+     */
     status: {
       type: String,
       default: "info"

package/dist/esm-node/src/composables/useText/useText.mjs

@@ -2,9 +2,15 @@ import { p as propsFactory } from "../../core/propsFactory.mjs";
 import { computed, toDisplayString } from "vue";
 const defineTextProps = propsFactory(
   {
-    /** Текст, отображаемый в компоненте. */
+    /**
+     * Текст, отображаемый в компоненте.
+     * @en Text displayed in the component.
+     */
     text: [String, Number],
-    /** Контент, отображаемый в компоненте. */
+    /**
+     * Контент, отображаемый в компоненте.
+     * @en Content displayed in the component.
+     */
     content: [String, Number]
   },
   "text"

package/dist/esm-node/src/composables/useTheme/useTheme.mjs

@@ -7,7 +7,10 @@ import { a1 as mergeDeep } from "../../utils/helpers.mjs";
 import { a as IN_BROWSER } from "../../utils/dom/globals.mjs";
 const defineThemeProps = propsFactory(
   {
-    /** Тема компонента */
+    /**
+     * Тема компонента
+     * @en Component theme
+     */
     theme: {
       type: String,
       default: void 0

package/dist/esm-node/src/composables/useTransition/useTransition.mjs

@@ -22,7 +22,10 @@ const easingPatterns = {
 };
 const defineTransitionProps = propsFactory(
   {
-    /** Анимация перехода */
+    /**
+     * Анимация перехода
+     * @en Transition animation
+     */
     transition: {
       type: null,
       default: "fade-transition",

package/dist/esm-node/src/composables/useValidation/useValidation.mjs

@@ -12,35 +12,55 @@ import { ac as wrapInArray } from "../../utils/helpers.mjs";
 import { w as warn } from "../../utils/dom/console.mjs";
 const defineValidationProps = propsFactory(
   {
-    /** Имя поля ввода */
+    /**
+     * Имя поля ввода
+     * @en Name of the input
+     */
     name: String,
-    /** Значение компонента в v-model. Если компонент поддерживает свойство multiple, по умолчанию используется пустой массив. */
+    /**
+     * Значение компонента в v-model. Если компонент поддерживает свойство multiple, по умолчанию используется пустой массив.
+     * @en Value of the component in v-model. If the component supports the multiple prop, an empty array is used by default.
+     */
     modelValue: null,
     /**
      * Принимает массив, состоящий из элементов различных типов: функций, логических значений и строк.
      * Функции принимают входное значение в качестве аргумента и должны возвращать либо true / false, либо строку, содержащую сообщение об ошибке.
      * Поле ввода перейдет в состояние ошибки, если функция возвращает значение false (или любое значение в массиве содержит false) либо является строкой.
+     * @en Accepts an array of items of different types: functions, booleans and strings. Functions take the input value as an argument and must return either true / false, or a string with an error message. The input goes into the error state if a function returns false (or any value in the array is false) or is a string.
      */
     rules: {
       type: Array,
       default: () => []
     },
-    /** Изменяет тип события, при котором запускается валидация */
+    /**
+     * Изменяет тип события, при котором запускается валидация
+     * @en Changes the type of the event that triggers validation
+     */
     validateOn: String,
-    /** Значение, используемое при применении правил валидации */
+    /**
+     * Значение, используемое при применении правил валидации
+     * @en Value used when applying the validation rules
+     */
     validationValue: null,
-    /** Отображает компонент в состояние ошибки */
+    /**
+     * Отображает компонент в состояние ошибки
+     * @en Puts the component into the error state
+     */
     error: Boolean,
     /**
      * Отображает компонент в состояние ошибки и передает пользовательские сообщения об ошибках.
      * Будет объединяться с любыми проверками, заданными в свойстве `rules`.
      * Это поле не запускает валидацию.
+     * @en Puts the component into the error state and passes custom error messages. They are merged with any checks defined in the `rules` prop. This field does not trigger validation.
      */
     errorMessages: {
       type: [Array, String],
       default: () => []
     },
-    /** Максимальное число отображаемых ошибок при валидации */
+    /**
+     * Максимальное число отображаемых ошибок при валидации
+     * @en Maximum number of validation errors shown
+     */
     maxErrors: {
       type: [Number, String],
       default: 1

package/dist/esm-node/src/composables/useVirtual/useVirtual.mjs

@@ -6,17 +6,26 @@ import { w as debounce, c as clamp, M as getPropertyFromItem } from "../../utils
 import { a as IN_BROWSER } from "../../utils/dom/globals.mjs";
 const defineVirtualProps = propsFactory(
   {
-    /** Высота одного элемента в пикселях. Если не задана — высота измеряется автоматически. */
+    /**
+     * Высота одного элемента в пикселях. Если не задана — высота измеряется автоматически.
+     * @en Height of a single item in pixels. When omitted, the height is measured automatically.
+     */
     itemHeight: {
       type: [Number, String],
       default: null
     },
-    /** Ключ элемента для идентификации (имя поля, путь или функция). По умолчанию используется индекс. */
+    /**
+     * Ключ элемента для идентификации (имя поля, путь или функция). По умолчанию используется индекс.
+     * @en Key that identifies an item (a field name, a path or a function). The index is used by default.
+     */
     itemKey: {
       type: [String, Array, Function],
       default: null
     },
-    /** Высота области просмотра виртуального списка. */
+    /**
+     * Высота области просмотра виртуального списка.
+     * @en Height of the viewport of the virtual list.
+     */
     height: [Number, String]
   },
   "virtual"

package/dist/esm-node/src/core/defineComponent.mjs

@@ -16,7 +16,10 @@ const defineComponentProps = propsFactory(
 );
 const defineTagProps = propsFactory(
   {
-    /** Пользовательский HTML-тег для отображения */
+    /**
+     * Пользовательский HTML-тег для отображения
+     * @en Custom HTML tag or component to render
+     */
     tag: {
       type: [String, Object, Function],
       default: "div"