@dxtmisha/constructor 0.30.1 → 0.39.5

package/dist/constructors/List/ListDesign.d.ts

@@ -0,0 +1,142 @@
+import { VNode } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract, ListDataItem, ListList, ListType, ConstrBind } from '@dxtmisha/functional';
+import { List } from './List';
+import { ListPropsBasic } from './props';
+import { ListClasses, ListComponents, ListEmits, ListExpose, ListSlots } from './types';
+import { WindowControlItem } from '../Window';
+import { ListGroupSlotsPropsInclude } from '../ListGroup';
+import { ItemList } from '@dxtmisha/functional-basic';
+/**
+ * ListDesign
+ */
+export declare class ListDesign<COMP extends ListComponents, EXPOSE extends ListExpose, CLASSES extends ListClasses, P extends ListPropsBasic> extends DesignConstructorAbstract<HTMLDivElement, COMP, ListEmits, EXPOSE, ListSlots, CLASSES, P> {
+    protected readonly item: List;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, ListEmits, P>);
+    /**
+     * Initialization of all the necessary properties for work
+     *
+     * Инициализация всех необходимых свойств для работы.
+     */
+    protected initExpose(): EXPOSE;
+    /**
+     * Improvement of the obtained list of classes.
+     *
+     * Доработка полученного списка классов.
+     */
+    protected initClasses(): Partial<CLASSES>;
+    /**
+     * Refinement of the received list of styles.
+     *
+     * Доработка полученного списка стилей.
+     */
+    protected initStyles(): ConstrStyles;
+    /**
+     * A method for rendering.
+     *
+     * Метод для рендеринга.
+     */
+    protected initRender(): VNode;
+    /**
+     * Generates all elements from the list.
+     *
+     * Генерирует все элементы из списка.
+     */
+    readonly renderData: () => VNode[];
+    /**
+     * Generates an element.
+     *
+     * Генерирует элемент.
+     * @param type type of list/ тип списка
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderItem: (type: ListType, item: ListDataItem) => VNode;
+    /**
+     * Generates a group element.
+     *
+     * Генерирует групповой элемент.
+     * @param item selected element/ выбранный элемент
+     * @param props data for working with the group/ данные для работы с группой
+     */
+    readonly renderItemGroup: (item: ListDataItem, props: ListGroupSlotsPropsInclude) => VNode;
+    /**
+     * Generates a menu element.
+     *
+     * Генерирует элемент меню.
+     * @param item selected element/ выбранный элемент
+     * @param props data for working with the menu/ данные для работы с меню
+     */
+    readonly renderItemMenu: (item: ListDataItem, props: WindowControlItem) => VNode;
+    /**
+     * Generates a break between elements.
+     *
+     * Генерирует разрыв между элементами.
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderSpace: (item: ListDataItem) => VNode;
+    /**
+     * Generates a dividing line.
+     *
+     * Генерирует линию разделения.
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderLine: (item: ListDataItem) => VNode;
+    /**
+     * Generates a subtitle.
+     *
+     * Генерирует подзаголовок.
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderSubtitle: (item: ListDataItem) => VNode;
+    /**
+     * Generates HTML code by the slot name or the value of the `label` field.
+     *
+     * Генерирует HTML-код по названию слота или значению поля `label`.
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderHtml: (item: ListDataItem) => VNode;
+    /**
+     * Generates a group of lists.
+     *
+     * Генерирует группу списков.
+     * @param item selected element/ выбранный элемент
+     */
+    readonly renderGroup: (item: ListDataItem) => VNode;
+    /**
+     * Generates a menu of lists.
+     *
+     * Генерирует меню списков.
+     * @param item selected element/ выбранный элемент
+     * @param first is the first element/ является ли первым элементом
+     */
+    readonly renderMenu: (item: ListDataItem, first: boolean) => VNode;
+    /**
+     * Generates all elements from the list.
+     *
+     * Генерирует все элементы из списка.
+     * @param type type of list/ тип списка
+     * @param data selected element/ выбранный элемент
+     * @param first is the first element/ является ли первым элементом
+     */
+    protected renderDataByItem(type: ListType, data: ListList, first?: boolean): VNode[];
+    /**
+     * Determines if highlighting is required.
+     *
+     * Определяет, требуется ли выделение.
+     * @param item selected element/ выбранный элемент
+     */
+    protected isHighlight(item: ListDataItem): boolean;
+    /**
+     * Returns binding properties for the item.
+     *
+     * Возвращает привязочные свойства для элемента.
+     * @param type type of list/ тип списка
+     * @param item selected element/ выбранный элемент
+     */
+    protected getItemAttrs(type: ListType, item: ListDataItem): ConstrBind<ItemList>;
+}

package/dist/constructors/List/ListFocus.d.ts

@@ -0,0 +1,114 @@
+import { Ref, ComputedRef } from 'vue';
+import { ListDataItem } from '@dxtmisha/functional';
+import { ListProps } from './props';
+import { NumberOrStringOrBoolean } from '@dxtmisha/functional-basic';
+/**
+ * Class for working with element focus.
+ *
+ * Класс для работы с фокусировкой элемента.
+ */
+export declare class ListFocus {
+    protected readonly props: ListProps;
+    protected readonly element: Ref<HTMLElement | undefined>;
+    protected readonly listId: number;
+    readonly item: Ref<ListDataItem | undefined, ListDataItem | undefined>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param element input element/ элемент ввода
+     * @param listId unique list identifier/ уникальный идентификатор списка
+     */
+    constructor(props: ListProps, element: Ref<HTMLElement | undefined>, listId: number);
+    /** Returns the value of the selected element/ Возвращает значение выбранного элемента */
+    readonly focus: ComputedRef< NumberOrStringOrBoolean | undefined>;
+    /**
+     * Returns the selected element.
+     *
+     * Возвращает выбранный элемент.
+     * @param index element index/ индекс элемента
+     */
+    isElement(index?: string): boolean;
+    /**
+     * Checks if the element is an item.
+     *
+     * Проверяет, является ли элемент элементом.
+     */
+    isItem(): boolean;
+    /**
+     * Checks if the element is a group.
+     *
+     * Проверяет, является ли элемент группой.
+     */
+    isGroup(): boolean;
+    /**
+     * Checks if the element is a menu.
+     *
+     * Проверяет, является ли элемент меню.
+     */
+    isMenu(): boolean;
+    /**
+     * Checks if the group or menu is open.
+     *
+     * Проверяет, открыта ли группа или меню.
+     */
+    isOpen(): boolean;
+    /**
+     * Returns the selected element.
+     *
+     * Возвращает выбранный элемент.
+     */
+    get(): ListDataItem | undefined;
+    /**
+     * Returns the selector for the desired element by its index.
+     *
+     * Возвращает селектор нужного элемента по его индексу.
+     * @param index element index/ индекс элемента
+     */
+    getSelector(index?: string): string;
+    /**
+     * Returns the HTML element of the selected item.
+     *
+     * Возвращает HTML элемент выбранного элемента.
+     * @param index element index/ индекс элемента
+     */
+    getElement(index?: string): HTMLDivElement | undefined;
+    /**
+     * Changes the selected element.
+     *
+     * Изменяет выбранный элемент.
+     * @param item new value/ новое значение
+     */
+    set(item: ListDataItem | undefined): this;
+    /**
+     * Resets the selected element.
+     *
+     * Сбрасывает выбранный элемент.
+     */
+    reset(): this;
+    /**
+     * Performs a click on the selected element.
+     *
+     * Выполняет клик на выбранном элементе.
+     */
+    click(): void;
+    /**
+     * Moves to the value in focus.
+     *
+     * Перемещает к значению в фокусе.
+     */
+    toElementFocus(): boolean;
+    /**
+     * Scrolls to the desired element by its index.
+     *
+     * Скроллирует к нужному элементу по его индексу.
+     * @param index element index/ индекс элемента
+     */
+    toElementSelected(index: string): this;
+    /**
+     * Scrolls to the desired element.
+     *
+     * Скроллирует к нужному элементу.
+     * @param element the element to scroll to/ элемент, до которого надо проскроллить
+     */
+    protected toElement(element?: HTMLElement): void;
+}

package/dist/constructors/List/ListGo.d.ts

@@ -0,0 +1,111 @@
+import { ConstrEmit, ListDataRef } from '@dxtmisha/functional';
+import { ListFocus } from './ListFocus';
+import { ListProps } from './props';
+import { ListEmits } from './types';
+/**
+ * Class for working with element focus.
+ *
+ * Класс для работы с фокусировкой элемента.
+ */
+export declare class ListGo {
+    protected readonly props: ListProps;
+    protected readonly focus: ListFocus;
+    protected readonly data: ListDataRef;
+    protected readonly emits?: ConstrEmit<ListEmits> | undefined;
+    protected index: number;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param focus object of the class for working with focus/ объект класса для работы с фокусировкой
+     * @param data object of the class for working with the list/ объект класса для работы со списком
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     */
+    constructor(props: ListProps, focus: ListFocus, data: ListDataRef, emits?: ConstrEmit<ListEmits> | undefined);
+    /**
+     * Changing the index in focus by the number in the array.
+     *
+     * Изменение значения в фокусе по номеру в массиве.
+     * @param index number in the array/ номер в массиве
+     */
+    set(index: number): boolean;
+    /**
+     * Changes the selected element.
+     *
+     * Изменяет выбранный элемент.
+     * @param value new value/ новое значение
+     */
+    preparation(value: any): void;
+    /**
+     * Scrolls the element to the selected element
+     *
+     * Прокрутить элемент до выбранного элемента
+     */
+    preparationBySelected(): void;
+    /**
+     * Moves the selected value back.
+     *
+     * Перемещает выбранное значение назад.
+     */
+    previous(): void;
+    /**
+     * Moves the selected value forward.
+     *
+     * Перемещает выбранное значение вперед.
+     */
+    next(): void;
+    /**
+     * Reset all records to the initial state.
+     *
+     * Сброс всех записей до начального состояния.
+     */
+    reset(): void;
+    /**
+     * Opens the window if the element is in it.
+     *
+     * Открывает окно, если элемент в нем.
+     */
+    open(): void;
+    /**
+     * Closes the window if the element is in it.
+     *
+     * Закрывает окно, если элемент в нем.
+     */
+    close(): void;
+    /**
+     * Stops the event.
+     *
+     * Останавливает событие.
+     */
+    stop(): void;
+    /**
+     * Checks if the next element is in the same window.
+     *
+     * Проверяет, находится ли следующий элемент в том же окне.
+     */
+    protected isFirstByParent(): boolean;
+    /**
+     * Checks if the next element is in the same window.
+     *
+     * Проверяет, находится ли следующий элемент в том же окне.
+     */
+    protected isLastByParent(): boolean;
+    /**
+     * Checks if the element is in a window.
+     *
+     * Проверяет, находится ли элемент в окне.
+     */
+    protected getMainItem(): HTMLDivElement | undefined;
+    /**
+     * Changing the index in focus by the number in the array.
+     *
+     * Изменение значения в фокусе по номеру в массиве.
+     * @param index number in the array/ номер в массиве
+     */
+    protected setByIndex(index: number): void;
+    /**
+     * Moves the selected value forward by type.
+     *
+     * Перемещает выбранное значение вперед по типу.
+     */
+    protected nextByType(): void;
+}

package/dist/constructors/List/ListSearch.d.ts

@@ -0,0 +1,59 @@
+import { ListProps } from './props';
+import { Ref, ComputedRef } from 'vue';
+/**
+ * Class for working with search.
+ *
+ * Класс для работы с поиском.
+ */
+export declare class ListSearch {
+    protected readonly props: ListProps;
+    readonly item: Ref<string | undefined, string | undefined>;
+    protected timeout?: any;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     */
+    constructor(props: ListProps);
+    /** Current search string/ Текущая строка поиска */
+    readonly highlight: ComputedRef<string | undefined>;
+    /**
+     * Adds a new character to the search.
+     *
+     * Добавляет новый символ к поиску.
+     * @param char new character/ новый символ
+     */
+    add(char: string): void;
+    /**
+     * Sets the search string.
+     *
+     * Устанавливает строку поиска.
+     * @param value new value/ новое значение
+     */
+    set(value?: string): void;
+    /**
+     * Resets the search string.
+     *
+     * Сбрасывает строку поиска.
+     */
+    reset(): this;
+    /**
+     * Returns a processed value.
+     *
+     * Возвращает обработанное значение.
+     * @param value source value/ исходное значение
+     */
+    protected getValue(value?: string): string | undefined;
+    /**
+     * Appends a character to the search string.
+     *
+     * Добавляет символ к строке поиска.
+     * @param char new character/ новый символ
+     */
+    protected addChar(char: string): this;
+    /**
+     * Schedules reset to the initial state after a delay.
+     *
+     * Планирует сброс к исходному состоянию после задержки.
+     */
+    protected makeReset(): this;
+}

package/dist/constructors/List/basicTypes.d.ts

@@ -0,0 +1,3 @@
+export type ListComponentInclude = {
+    list?: object;
+};

package/dist/constructors/List/index.d.ts

@@ -0,0 +1,5 @@
+export * from './List';
+export * from './ListDesign';
+export * from './props';
+export * from './types';
+export * from './basicTypes';

package/dist/constructors/List/props.d.ts

@@ -0,0 +1,50 @@
+import { ConstrBind, ListRecord, ListSelectedItem, ListSelectedList } from '@dxtmisha/functional';
+import { IconPropsBasic, IconValue } from '../Icon';
+import { RoleType } from '../../types/roleTypes';
+import { ListItemPropsBasic } from '../ListItem';
+export type ListPropsToken = {
+    axis?: 'x' | 'y';
+    divider?: boolean;
+};
+export type ListPropsBasic<Icon extends IconPropsBasic = IconPropsBasic, ListItem extends ListItemPropsBasic = ListItemPropsBasic> = {
+    focus?: ListSelectedItem;
+    selected?: ListSelectedList;
+    disabled?: boolean;
+    lite?: boolean;
+    list?: ListRecord<ListItem>;
+    liteThreshold?: number;
+    highlight?: string;
+    highlightLengthStart?: number;
+    filterMode?: boolean;
+    keyLabel?: string;
+    keyValue?: string;
+    max?: string | number;
+    tag?: 'div' | 'button' | 'a' | 'span' | string;
+    axis?: 'x' | 'y';
+    divider?: boolean;
+    itemAttrs?: ConstrBind<ListItem>;
+    itemManagementAttrs?: ConstrBind<ListItem>;
+    itemGroupAttrs?: ConstrBind<ListItem>;
+    itemMenuAttrs?: ConstrBind<ListItem>;
+    iconArrowDown?: IconValue<Icon>;
+    iconArrowRight?: IconValue<Icon>;
+    roleItem?: RoleType;
+    control?: boolean;
+};
+/**
+ * Type describing incoming properties.
+ *
+ * Тип, описывающий входящие свойства.
+ */
+export type ListProps = ListPropsBasic & ListPropsToken;
+/**
+ * Default value for property.
+ *
+ * Значение по умолчанию для свойства.
+ */
+export declare const defaultsList: {
+    axis: string;
+    keyLabel: string;
+    keyValue: string;
+    tag: string;
+};

package/dist/constructors/List/types.d.ts

@@ -0,0 +1,53 @@
+import { ConstrClass, ListList, ListNames } from '@dxtmisha/functional';
+import { EventClickEmits } from '../../types/eventClickTypes';
+import { ListItemComponentInclude } from '../ListItem';
+import { ListGroupComponentInclude } from '../ListGroup';
+import { ListMenuComponentInclude } from '../ListMenu';
+import { ComputedRef } from 'vue';
+/**
+ * Interface for describing which components need to be connected for work.
+ *
+ * Интерфейс для описания, какие компоненты надо подключить для работы.
+ */
+export type ListComponents = ListItemComponentInclude & ListGroupComponentInclude & ListMenuComponentInclude;
+/**
+ * Type describing available events.
+ *
+ * Тип, описывающий доступные события.
+ */
+export type ListEmits = EventClickEmits & {
+    close: [];
+};
+/**
+ * Type describing available properties.
+ *
+ * Тип, описывающий доступные свойства.
+ */
+export interface ListExpose {
+    isSelected: ComputedRef<boolean>;
+    selectedList: ComputedRef<ListList>;
+    selectedNames: ComputedRef<ListNames>;
+    selectedValues: ComputedRef<any[]>;
+}
+/**
+ * Type describing available slots.
+ *
+ * Тип, описывающий доступные слоты.
+ */
+export type ListSlots = Record<string, (props: any) => any>;
+/**
+ * Type describing subclasses.
+ *
+ * Тип, описывающий подклассы.
+ */
+export type ListClasses = {
+    main: ConstrClass;
+    space: string;
+    line: string;
+    subtitle: string;
+    html: string;
+    management: string;
+    group: string;
+    menu: string;
+    menuGroup: string;
+};

package/dist/constructors/ListGroup/ListGroup.d.ts

@@ -0,0 +1,38 @@
+import { Ref, ToRefs } from 'vue';
+import { ConstrBind, ConstrEmit, DesignComp } from '@dxtmisha/functional';
+import { ListGroupOpen } from './ListGroupOpen';
+import { MotionTransformProps } from '../MotionTransform';
+import { ListGroupComponents, ListGroupEmits, ListGroupSlots } from './types';
+import { ListGroupProps } from './props';
+/**
+ * ListGroup
+ */
+export declare class ListGroup {
+    protected readonly props: ListGroupProps;
+    protected readonly refs: ToRefs<ListGroupProps>;
+    protected readonly element: Ref<HTMLElement | undefined>;
+    protected readonly classDesign: string;
+    protected readonly className: string;
+    protected readonly components?: DesignComp<ListGroupComponents, ListGroupProps> | undefined;
+    protected readonly slots?: ListGroupSlots | undefined;
+    protected readonly emits?: ConstrEmit<ListGroupEmits> | undefined;
+    readonly open: ListGroupOpen<ListGroupProps>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param refs input data in the form of reactive elements/ входные данные в виде реактивных элементов
+     * @param element input element/ элемент ввода
+     * @param classDesign design name/ название дизайна
+     * @param className class name/ название класса
+     * @param components object for working with components/ объект для работы с компонентами
+     * @param slots object for working with slots/ объект для работы со слотами
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     */
+    constructor(props: ListGroupProps, refs: ToRefs<ListGroupProps>, element: Ref<HTMLElement | undefined>, classDesign: string, className: string, components?: DesignComp<ListGroupComponents, ListGroupProps> | undefined, slots?: ListGroupSlots | undefined, emits?: ConstrEmit<ListGroupEmits> | undefined);
+    /**
+     * Returns the property for the transformation component.
+     *
+     * Возвращает свойство для компонента трансформации.
+     */
+    readonly transformBinds: () => ConstrBind<MotionTransformProps>;
+}

package/dist/constructors/ListGroup/ListGroupDesign.d.ts

@@ -0,0 +1,62 @@
+import { VNode } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract } from '@dxtmisha/functional';
+import { ListGroup } from './ListGroup';
+import { ListGroupPropsBasic } from './props';
+import { ListGroupClasses, ListGroupComponents, ListGroupEmits, ListGroupExpose, ListGroupSlots } from './types';
+import { MotionTransformControlItem } from '../MotionTransform';
+/**
+ * ListGroupDesign
+ */
+export declare class ListGroupDesign<COMP extends ListGroupComponents, EXPOSE extends ListGroupExpose, CLASSES extends ListGroupClasses, P extends ListGroupPropsBasic> extends DesignConstructorAbstract<HTMLDivElement, COMP, ListGroupEmits, EXPOSE, ListGroupSlots, CLASSES, P> {
+    protected readonly item: ListGroup;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, ListGroupEmits, P>);
+    /**
+     * Initialization of all the necessary properties for work
+     *
+     * Инициализация всех необходимых свойств для работы.
+     */
+    protected initExpose(): EXPOSE;
+    /**
+     * Improvement of the obtained list of classes.
+     *
+     * Доработка полученного списка классов.
+     */
+    protected initClasses(): Partial<CLASSES>;
+    /**
+     * Refinement of the received list of styles.
+     *
+     * Доработка полученного списка стилей.
+     */
+    protected initStyles(): ConstrStyles;
+    /**
+     * A method for rendering.
+     *
+     * Метод для рендеринга.
+     */
+    protected initRender(): VNode;
+    /**
+     * Render transformation element.
+     *
+     * Рендер элемента трансформации.
+     */
+    readonly renderTransform: () => VNode[];
+    /**
+     * Render title element.
+     *
+     * Рендер элемента заголовка.
+     * @param item motion transform item/ элемент движения трансформации
+     */
+    readonly renderHead: (item: MotionTransformControlItem) => VNode;
+    /**
+     * Render list element.
+     *
+     * Рендер элемента списка.
+     */
+    readonly renderList: () => VNode;
+}