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

package/dist/types/components/CdsUploader/CdsUploader.vue.d.ts

@@ -215,7 +215,15 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
     onSuccess: typeof onSuccess;
     onProgress: typeof onProgress;
     onError: typeof onError;
+    /**
+     * Текущий список файлов со статусами загрузки.
+     * @en Current list of files together with their upload statuses.
+     */
     fileList: import("vue").ComputedRef<NUploader.IUploadFile<any>[]>;
+    /**
+     * Ссылка на внутренний элемент загрузки — даёт доступ к программному выбору файлов и прерыванию.
+     * @en Ref to the inner upload element — gives access to choosing files programmatically and to aborting.
+     */
     uploadRef: Ref<({
         $: import("vue").ComponentInternalInstance;
         $data: {};

package/dist/types/components/CdsUploader/api/CdsUploader.types.d.ts

@@ -89,42 +89,93 @@ export declare namespace NUploader {
 }
 export type CdsUploaderProps = ExtractPublicPropTypes<ReturnType<typeof defineCdsUploaderProps>>;
 export interface CdsUploaderEvents {
-    /** Событие при изменении значения (v-model) */
+    /**
+     * Событие при изменении значения (v-model)
+     * @en Fires when the value changes (v-model)
+     */
     (e: 'update:modelValue', fileList: NUploader.IUploadChangeParam<NUploader.IUploadFile>['fileList']): void;
-    /** Событие изменения поля ввода */
+    /**
+     * Событие изменения поля ввода
+     * @en Fires when the field changes
+     */
     (e: 'change', info: NUploader.IUploadChangeParam<NUploader.IUploadFile>): void;
-    /** Событие процесса загрузки файла */
+    /**
+     * Событие процесса загрузки файла
+     * @en Fires while a file is being uploaded
+     */
     (e: 'progress', event: NUploader.IUploadChangeParam['event'], file: NUploader.IUploadFile): void;
-    /** Событие успешной загрузки файла */
+    /**
+     * Событие успешной загрузки файла
+     * @en Fires when a file has been uploaded successfully
+     */
     (e: 'success', response: Record<string, unknown>, file: NUploader.IUploadFile): void;
-    /** Событие ошибки загрузки файла */
+    /**
+     * Событие ошибки загрузки файла
+     * @en Fires when a file upload fails
+     */
     (e: 'error', error: NUploader.IUploadRequestError | ProgressEvent, response: any, file: NUploader.IUploadFile): void;
-    /** Событие при удалении файла */
+    /**
+     * Событие при удалении файла
+     * @en Fires when a file is removed
+     */
     (e: 'remove', file: NUploader.IUploadFile): void | boolean | Promise<void | boolean>;
-    /** Событие при drag-n-drop файла */
+    /**
+     * Событие при drag-n-drop файла
+     * @en Fires when a file is dropped
+     */
     (e: 'drop', event: DragEvent): void;
-    /** Событие при отклонении загрузки файла */
+    /**
+     * Событие при отклонении загрузки файла
+     * @en Fires when a file upload is rejected
+     */
     (e: 'reject', fileList: NUploader.IUploadFile[]): void;
-    /** Событие при скачивании файла */
+    /**
+     * Событие при скачивании файла
+     * @en Fires when a file is downloaded
+     */
     (e: 'download', file: NUploader.IUploadFile): void;
-    /** Событие при просмотре превью файла */
+    /**
+     * Событие при просмотре превью файла
+     * @en Fires when a file preview is opened
+     */
     (e: 'preview', file: NUploader.IUploadFile): void;
 }
 export interface CdsUploaderSlots {
-    /** Метка (label) поля загрузки. */
+    /**
+     * Метка (label) поля загрузки.
+     * @en Label of the upload field.
+     */
     label?: () => any;
-    /** Описание под меткой. */
+    /**
+     * Описание под меткой.
+     * @en Description under the label.
+     */
     description?: () => any;
-    /** Контент в слоте prepend перед кнопкой загрузки. */
+    /**
+     * Контент в слоте prepend перед кнопкой загрузки.
+     * @en Content of the prepend slot before the upload button.
+     */
     prepend?: () => any;
-    /** Кнопка/активатор загрузки. Получает props для CdsButton. */
+    /**
+     * Кнопка/активатор загрузки. Получает props для CdsButton.
+     * @en The upload button or activator. Receives the props for CdsButton.
+     */
     default?: (scope: {
         props: Record<string, unknown>;
     }) => any;
-    /** Контент в слоте append после кнопки загрузки. */
+    /**
+     * Контент в слоте append после кнопки загрузки.
+     * @en Content of the append slot after the upload button.
+     */
     append?: () => any;
-    /** Сообщения подсказки/ошибки. */
+    /**
+     * Сообщения подсказки/ошибки.
+     * @en Hint and error messages.
+     */
     messages?: () => any;
-    /** Кастомный рендер элемента списка загружаемых файлов. */
+    /**
+     * Кастомный рендер элемента списка загружаемых файлов.
+     * @en Custom rendering of an item of the uploaded file list.
+     */
     itemRender?: (scope: Parameters<NUploader.TItemRender>[0]) => any;
 }

package/dist/types/components/CdsVirtualScroll/CdsVirtualScroll.vue.d.ts

@@ -45,7 +45,15 @@ declare const __VLS_base: import("vue").DefineComponent<import("vue").ExtractPro
     };
     renderless: BooleanConstructor;
 }>, {
+    /**
+     * Пересчитывает окно видимых элементов — нужно после изменения их высоты вне цикла обновления.
+     * @en Recalculates the window of visible items — needed after their height changes outside the update cycle.
+     */
     calculateVisibleItems: () => void;
+    /**
+     * Прокручивает список к элементу с указанным индексом.
+     * @en Scrolls the list to the item with the given index.
+     */
     scrollToIndex: (index: number) => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     class: import("vue").PropType<import("../../core").ClassValue>;

package/dist/types/components/CdsVirtualScroll/api/CdsVirtualScroll.types.d.ts

@@ -4,13 +4,22 @@ import type { defineCdsVirtualScrollItemProps, defineCdsVirtualScrollProps } fro
 export interface CdsVirtualScrollProps extends ExtractPublicPropTypes<ReturnType<typeof defineCdsVirtualScrollProps>> {
 }
 export interface CdsVirtualScrollSlot<T> {
-    /** Сырой элемент массива `items`. */
+    /**
+     * Сырой элемент массива `items`.
+     * @en Raw element of the `items` array.
+     */
     item: T;
-    /** Индекс элемента в исходном массиве `items`. */
+    /**
+     * Индекс элемента в исходном массиве `items`.
+     * @en Index of the item in the original `items` array.
+     */
     index: number;
 }
 export interface CdsVirtualScrollSlots<T, Renderless> {
-    /** Содержимое одного элемента списка. В режиме `renderless` дополнительно получает `itemRef`. */
+    /**
+     * Содержимое одного элемента списка. В режиме `renderless` дополнительно получает `itemRef`.
+     * @en Content of a single list item. In `renderless` mode it additionally receives `itemRef`.
+     */
     default?: (props: CdsVirtualScrollSlot<T> & (Renderless extends true ? {
         itemRef: TemplateRef;
     } : {})) => any;
@@ -18,12 +27,18 @@ export interface CdsVirtualScrollSlots<T, Renderless> {
 export interface CdsVirtualScrollItemProps extends ExtractPublicPropTypes<ReturnType<typeof defineCdsVirtualScrollItemProps>> {
 }
 export interface CdsVirtualScrollItemSlots {
-    /** Содержимое элемента. В режиме `renderless` получает `itemRef` для измерения высоты. */
+    /**
+     * Содержимое элемента. В режиме `renderless` получает `itemRef` для измерения высоты.
+     * @en Content of the item. In `renderless` mode it receives `itemRef` to measure the height.
+     */
     default?: (props: {
         itemRef: TemplateRef;
     }) => any;
 }
 export interface CdsVirtualScrollItemEvents {
-    /** Сообщает виртуальному списку об изменении высоты элемента. */
+    /**
+     * Сообщает виртуальному списку об изменении высоты элемента.
+     * @en Tells the virtual list that the height of the item has changed.
+     */
     (e: 'update:height', height: number): void;
 }

package/dist/types/composables/useForm/useForm.d.ts

@@ -56,6 +56,10 @@ export declare const defineFormProps: <Defaults extends {
 export interface FormProps extends ExtractPublicPropTypes<ReturnType<typeof defineFormProps>> {
 }
 export declare function createForm(props: FormProps): {
+    /**
+     * Ошибки валидации полей формы: идентификатор поля и его сообщения об ошибках.
+     * @en Validation errors of the form fields: the identifier of a field and its error messages.
+     */
     errors: import("vue").Ref<{
         id: number | string;
         errorMessages: string[];
@@ -63,12 +67,32 @@ export declare function createForm(props: FormProps): {
         id: number | string;
         errorMessages: string[];
     }[]>;
+    /**
+     * Заблокированы ли все поля формы.
+     * @en Whether all the fields of the form are blocked.
+     */
     isDisabled: Readonly<import("vue").Ref<boolean | null | undefined, boolean | null | undefined>>;
+    /**
+     * Доступны ли поля формы только для чтения.
+     * @en Whether the fields of the form are read-only.
+     */
     isReadonly: Readonly<import("vue").Ref<boolean | null | undefined, boolean | null | undefined>>;
+    /**
+     * Идёт ли сейчас валидация формы.
+     * @en Whether the form is being validated right now.
+     */
     isValidating: import("vue").ShallowRef<boolean, boolean>;
+    /**
+     * Валидность формы: `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: import("vue").Ref<boolean | null | undefined, boolean | null | undefined> & {
         readonly externalValue: boolean | null | undefined;
     };
+    /**
+     * Зарегистрированные в форме поля с их состоянием валидации.
+     * @en The fields registered in the form together with their validation state.
+     */
     items: import("vue").Ref<{
         id: number | string;
         validate: () => Promise<string[]>;
@@ -86,6 +110,10 @@ export declare function createForm(props: FormProps): {
         isValid: boolean | null;
         errorMessages: string[];
     }[]>;
+    /**
+     * Запускает валидацию всех полей формы и возвращает результат вместе со списком ошибок.
+     * @en Runs the validation of all the form fields and returns the result together with the list of errors.
+     */
     validate: () => Promise<{
         valid: boolean;
         errors: FieldValidationResult[] | {
@@ -93,7 +121,12 @@ export declare function createForm(props: FormProps): {
             errorMessages: string[];
         }[];
     }>;
+    /** Сбрасывает значения всех полей формы и их валидацию. */
     reset: () => void;
+    /**
+     * Сбрасывает только состояние валидации, сохраняя введённые значения.
+     * @en Resets the validation state only, keeping the entered values.
+     */
     resetValidation: () => void;
 };
 export declare function useForm(props?: {

package/dist/types/composables/useLayout/context.d.ts

@@ -34,25 +34,86 @@ export interface LayoutPart {
  * `CdsHeader`, `CdsFooter`, `CdsDrawer`, `CdsMain`, `CdsPage`.
  */
 export interface LayoutContext {
+    /**
+     * Зарегистрированные в макете компоненты по идентификаторам — шапка, подвал, панели, контент.
+     * @en Components registered in the layout by their identifiers — the header, the footer, the drawers, the content.
+     */
     instances: Record<string, unknown>;
+    /** Текущая раскладка макета — какие части занимают верх, низ и бока. */
     view: ComputedRef<string>;
+    /**
+     * Ограничен ли макет по ширине контейнером (`container`) вместо растягивания на весь экран.
+     * @en Whether the layout is limited in width by a container (`container`) instead of stretching across the whole screen.
+     */
     isContainer: ComputedRef<boolean>;
+    /**
+     * Ссылка на корневой DOM-элемент макета.
+     * @en Ref to the root DOM element of the layout.
+     */
     rootRef: Ref<HTMLElement | undefined>;
+    /**
+     * Полная высота макета в пикселях.
+     * @en Full height of the layout in pixels.
+     */
     height: Ref<number>;
+    /**
+     * Высота области контента без шапки и подвала, в пикселях.
+     * @en Height of the content area without the header and the footer, in pixels.
+     */
     containerHeight: Ref<number>;
+    /**
+     * Ширина системной полосы прокрутки в пикселях — учитывается при блокировке скролла.
+     * @en Width of the system scrollbar in pixels — taken into account when the scroll is locked.
+     */
     scrollbarWidth: Ref<number>;
+    /**
+     * Полная ширина макета в пикселях.
+     * @en Full width of the layout in pixels.
+     */
     totalWidth: ComputedRef<number>;
+    /**
+     * Идентификаторы компонентов, распределённые по рядам макета: сверху, посередине и снизу.
+     * @en Identifiers of the components distributed across the rows of the layout: top, middle and bottom.
+     */
     rows: ComputedRef<{
         top: string[];
         middle: string[];
         bottom: string[];
     }>;
+    /**
+     * Размеры и смещение шапки макета.
+     * @en Size and offset of the layout header.
+     */
     header: LayoutPart;
+    /**
+     * Размеры и смещение правой панели макета.
+     * @en Size and offset of the right drawer of the layout.
+     */
     right: LayoutPart;
+    /**
+     * Размеры и смещение подвала макета.
+     * @en Size and offset of the layout footer.
+     */
     footer: LayoutPart;
+    /**
+     * Размеры и смещение левой панели макета.
+     * @en Size and offset of the left drawer of the layout.
+     */
     left: LayoutPart;
+    /**
+     * Состояние прокрутки макета: позиция, направление и дельта.
+     * @en Scroll state of the layout: position, direction and delta.
+     */
     scroll: Ref<ScrollObserver>;
+    /**
+     * Включает анимацию перестроения макета на время ближайшего обновления размеров.
+     * @en Turns on the rebuild animation of the layout for the duration of the next size update.
+     */
     animate: () => void;
+    /**
+     * Обновляет размер, смещение или резервирование места для части макета.
+     * @en Updates the size, the offset or the space reservation for a part of the layout.
+     */
     update: (part: 'header' | 'footer' | 'left' | 'right', prop: keyof LayoutPart, value: number | boolean) => void;
 }
 export declare const CDS_LAYOUT_CONTEXT_KEY = "cds:layout";

package/dist/types/composables/useNested/useNested.d.ts

@@ -99,7 +99,10 @@ export declare function useNested(props: NestedProps, { items, returnObject, scr
     register: (id: unknown, parentId: unknown, isDisabled: boolean, isGroup?: boolean) => void;
     unregister: (id: unknown) => void;
     updateDisabled: (id: unknown, isDisabled: boolean) => void;
-    open: (id: unknown, value: boolean, event? /** Стратегия выбора элементов (`single-leaf`, `leaf`, `independent`, `classic` и т.д.) */: Event) => void;
+    open: (id: unknown, value: boolean, event? /**
+     * Стратегия активации элементов (одиночная, множественная и т.д.)
+     * @en Activation strategy for items (single, multiple, and so on)
+     */: Event) => void;
     activate: (id: unknown, value: boolean, event?: Event) => void;
     select: (id: unknown, value: boolean, event?: Event) => void;
     openOnSelect: (id: unknown, value: boolean, event?: Event) => void;
@@ -167,7 +170,10 @@ export declare const useNestedItem: (id: MaybeRefOrGetter<unknown>, isDisabled:
         register: (id: unknown, parentId: unknown, isDisabled: boolean, isGroup?: boolean) => void;
         unregister: (id: unknown) => void;
         updateDisabled: (id: unknown, isDisabled: boolean) => void;
-        open: (id: unknown, value: boolean, event? /** Стратегия выбора элементов (`single-leaf`, `leaf`, `independent`, `classic` и т.д.) */: Event) => void;
+        open: (id: unknown, value: boolean, event? /**
+         * Стратегия активации элементов (одиночная, множественная и т.д.)
+         * @en Activation strategy for items (single, multiple, and so on)
+         */: Event) => void;
         activate: (id: unknown, value: boolean, event?: Event) => void;
         select: (id: unknown, value: boolean, event?: Event) => void;
         openOnSelect: (id: unknown, value: boolean, event?: Event) => void;

package/dist/types/entry.d.ts

@@ -74,6 +74,7 @@ interface CdsGlobalComponents {
     CdsListItemTitle: typeof components.CdsListItemTitle;
     CdsListItemDivider: typeof components.CdsListItemDivider;
     CdsListGroup: typeof components.CdsListGroup;
+    CdsListSubheader: typeof components.CdsListSubheader;
     CdsLoader: typeof components.CdsLoader;
     CdsMain: typeof components.CdsMain;
     CdsMenu: typeof components.CdsMenu;

package/dist/types/themes/lumaDark.d.ts

@@ -1,5 +1,9 @@
 declare const _default: {
     colors: {
+        'surface-secondary': string;
+        'surface-primary': string;
+        'surface-elevated': string;
+        'page-primary': string;
         'brand-secondary-hover': string;
         'brand-secondary-border': string;
         'brand-secondary-active': string;
@@ -9,11 +13,8 @@ declare const _default: {
         'brand-primary-border': string;
         'brand-primary-active': string;
         'brand-primary': string;
-        'surface-secondary': "#33373F";
-        'surface-primary': "#272A30";
         'surface-overlay': "#272A30CC";
         'surface-inverse': "#DCDDE3";
-        'surface-elevated': "#33373F";
         'status-warning-surface': "#C9A449";
         'status-warning-line': "#BE9737";
         'status-warning-fill-hover': "#8A6502";
@@ -44,7 +45,6 @@ declare const _default: {
         'status-danger-fill-hover': "#B8423D";
         'status-danger-fill': "#822825";
         'status-danger-content': "#FFD2CC";
-        'page-primary': "#1A1A1A";
         'other-teal-surface': "#0ABACE";
         'other-teal-line': "#01ACBF";
         'other-teal-fill-hover': "#007886";

package/dist/types/utils/date/date.d.ts

@@ -118,7 +118,7 @@ export declare function startOfDate(date: Date, unit: string, utc?: boolean): Da
  * @param unit
  * @param utc
  */
-export declare function endOfDate(date: Date, unit: string, utc: boolean): Date;
+export declare function endOfDate(date: Date, unit: string, utc?: boolean): Date;
 /**
  * Get the maximum date from a given date and other dates.
  * @param date