@dxtmisha/constructor 0.23.0 → 0.39.3

package/dist/constructors/Window/WindowInclude.d.ts

@@ -0,0 +1,57 @@
+import { VNode, Ref, ComputedRef } from 'vue';
+import { ConstrBind, ConstrEmit, DesignComponents, RefOrNormal } from '@dxtmisha/functional';
+import { WindowProps } from './props';
+import { WindowExpose, WindowSlots } from './types';
+import { WindowComponentInclude, WindowEmitOptions, WindowEmitsInclude, WindowExposeInclude, WindowPropsInclude } from './basicTypes';
+import { NormalOrPromise } from '@dxtmisha/functional-basic';
+/**
+ * The class returns data for working with the Window component
+ *
+ * Класс возвращает данные для работы с компонентом Window
+ */
+export declare class WindowInclude<Props extends WindowPropsInclude = WindowPropsInclude, PropsExtra extends ConstrBind<WindowProps> = ConstrBind<WindowProps>> {
+    protected readonly props: Readonly<Props>;
+    protected readonly className: string;
+    protected readonly components?: DesignComponents<WindowComponentInclude, Props> | undefined;
+    protected readonly emits?: ConstrEmit<WindowEmitsInclude> | undefined;
+    protected readonly extra?: RefOrNormal<PropsExtra> | undefined;
+    protected readonly index?: string | undefined;
+    /**
+     * Constructor
+     * @param props input parameter/ входной параметр
+     * @param className class name/ название класса
+     * @param components object for working with components/ объект для работы с компонентами
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     * @param extra additional parameter or property name/ дополнительный параметр или имя свойства
+     * @param index index identifier/ идентификатор индекса
+     */
+    constructor(props: Readonly<Props>, className: string, components?: DesignComponents<WindowComponentInclude, Props> | undefined, emits?: ConstrEmit<WindowEmitsInclude> | undefined, extra?: RefOrNormal<PropsExtra> | undefined, index?: string | undefined);
+    /** Reference to window element expose/ Ссылка на expose элемента окна */
+    readonly element: Ref<ConstrBind<WindowExpose> | undefined, ConstrBind<WindowExpose> | undefined>;
+    /** Computed bindings for the window/ Вычисляемые привязки для окна */
+    readonly binds: ComputedRef<PropsExtra>;
+    /**
+     * Expose helpers for window state and actions/
+     * Вспомогательные методы expose для состояния и действий окна
+     */
+    readonly expose: WindowExposeInclude;
+    /**
+     * Render the Window component with slots/
+     * Рендер компонента Window со слотами
+     * @param slotsChildren slots passed to the window/ слоты, передаваемые окну
+     * @param attrs additional attributes/ дополнительные атрибуты
+     */
+    readonly render: (slotsChildren: WindowSlots, attrs?: Record<string, any>) => VNode[];
+    /** Returns preparation result/ Возвращает результат preparation */
+    protected readonly getPreparation: () => NormalOrPromise<void>;
+    /** Returns opening result/ Возвращает результат opening */
+    protected readonly getOpening: () => NormalOrPromise<boolean>;
+    /** Returns closing result/ Возвращает результат closing */
+    protected readonly getClosing: () => NormalOrPromise<boolean>;
+    /**
+     * Emits 'window' event upward/
+     * Поднимает событие 'window' наверх
+     * @param options event payload/ параметры события
+     */
+    protected readonly onWindow: (options: WindowEmitOptions) => void;
+}

package/dist/constructors/Window/WindowOpen.d.ts

@@ -0,0 +1,137 @@
+import { TabIndexInclude } from '../../classes/TabIndexInclude';
+import { WindowStatus } from './WindowStatus';
+import { WindowClient } from './WindowClient';
+import { WindowHook } from './WindowHook';
+import { WindowElement } from './WindowElement';
+import { WindowFlash } from './WindowFlash';
+import { WindowCoordinates } from './WindowCoordinates';
+import { WindowPosition } from './WindowPosition';
+import { WindowOrigin } from './WindowOrigin';
+import { WindowEmit } from './WindowEmit';
+import { WindowStyles } from './WindowStyles';
+import { WindowProps } from './props';
+import { Ref, ComputedRef } from 'vue';
+/**
+ * Class for managing the status of an open window.
+ *
+ * Класс для управления статусом открытого окна.
+ */
+export declare class WindowOpen {
+    protected readonly props: WindowProps;
+    protected readonly client: WindowClient;
+    protected readonly hook: WindowHook;
+    protected readonly element: WindowElement;
+    protected readonly tabIndex: TabIndexInclude;
+    protected readonly status: WindowStatus;
+    protected readonly flash: WindowFlash;
+    protected readonly coordinates: WindowCoordinates;
+    protected readonly position: WindowPosition;
+    protected readonly origin: WindowOrigin;
+    protected readonly emit: WindowEmit;
+    protected readonly styles: WindowStyles;
+    readonly item: Ref<boolean, boolean>;
+    protected readonly first: Ref<boolean, boolean>;
+    protected clicks: number;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param client object for working with mouse pointer coordinates/ объект для работы с координатами указателя мыши
+     * @param hook object for working with hooks/ объект для работы с хуками
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     * @param tabIndex class object for working with tab indices/ объект класса для работы с табуляцией
+     * @param status object for working with statuses/ объект для работы со статусами
+     * @param flash class object for working with fast window opening/ объект класса для работы с быстрым открытием окна
+     * @param coordinates object for working with coordinates/ объект для работы с координатами
+     * @param position object for working with the position of the element/ объект для работы с положением элемента
+     * @param origin the object for work is in the initial position upon opening/ объект для работы в начальной позиции при открытии
+     * @param emit the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     * @param styles an object for working with the styles of an element/ объект для работы со стилями элемента
+     */
+    constructor(props: WindowProps, client: WindowClient, hook: WindowHook, element: WindowElement, tabIndex: TabIndexInclude, status: WindowStatus, flash: WindowFlash, coordinates: WindowCoordinates, position: WindowPosition, origin: WindowOrigin, emit: WindowEmit, styles: WindowStyles);
+    /**
+     * Checks whether the element should be kept in the DOM.
+     *
+     * Проверяет, надо ли элемент оставить в DOM.
+     */
+    readonly inDom: ComputedRef<boolean>;
+    /**
+     * Checks if the window is open.
+     *
+     * Проверяет, открыто ли окно.
+     */
+    isClicks(): boolean;
+    /**
+     * Changes the current state.
+     *
+     * Изменяет текущее состояние.
+     * @param open the value of the current state/ значение текущего состояния
+     */
+    readonly set: (open?: boolean) => Promise<void>;
+    /**
+     * Opens the window.
+     *
+     * Открывает окно.
+     */
+    readonly open: () => Promise<void>;
+    /**
+     * Closes the window.
+     *
+     * Закрывает окно.
+     */
+    readonly close: () => Promise<void>;
+    /**
+     * Switches the state, that is, opens or closes the window, depending on the value of item.
+     *
+     * Переключает состояние, то есть открывает или закрывает окно, в зависимости от значения item.
+     */
+    readonly toggle: () => Promise<void>;
+    /**
+     * Close handler on animation end.
+     *
+     * Обработчик закрытия по окончании анимации.
+     */
+    closeForEvent(): void;
+    /**
+     * Resets all data to initial values.
+     *
+     * Сбрасывает все данные к начальным значениям.
+     */
+    reset(): this;
+    /**
+     * The method increases the number of clicks.
+     *
+     * Метод увеличивает количество кликов.
+     */
+    pressed(): this;
+    /**
+     * The method resets the number of clicks.
+     *
+     * Метод сбрасывает количество кликов.
+     */
+    resetClicks(): this;
+    /**
+     * The method updates the current position.
+     *
+     * Метод обновляет текущее положение.
+     */
+    watchPosition(): Promise<void>;
+    /**
+     * Changes values and triggers events.
+     *
+     * Изменяет значения и вызывает события.
+     * @param open the value of the current state/ значение текущего состояния
+     */
+    setOpen(open: boolean): Promise<this>;
+    /**
+     * Changing the location of the menu window.
+     *
+     * Изменение расположения окна меню.
+     */
+    protected watchCoordinates(): this;
+    /**
+     * Transition to the closing state.
+     *
+     * Переход в состояние закрытия.
+     */
+    protected toClose(): void;
+}

package/dist/constructors/Window/WindowOrigin.d.ts

@@ -0,0 +1,46 @@
+import { WindowClient } from './WindowClient';
+import { WindowElement } from './WindowElement';
+import { WindowPosition } from './WindowPosition';
+/**
+ * Class for defining the initial position for the animation.
+ *
+ * Класс для определения начального положения для анимации.
+ */
+export declare class WindowOrigin {
+    protected readonly client: WindowClient;
+    protected readonly element: WindowElement;
+    protected readonly position: WindowPosition;
+    protected x: number | null;
+    protected y: number | null;
+    /**
+     * Constructor
+     * @param client object for working with mouse pointer coordinates/ объект для работы с координатами указателя мыши
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     * @param position object for working with the position of the element/ объект для работы с положением элемента
+     */
+    constructor(client: WindowClient, element: WindowElement, position: WindowPosition);
+    /**
+     * Returns the initial X point for the start of the animation.
+     *
+     * Возвращает начальную точку X для начала анимации.
+     */
+    getStyleX(): string | null;
+    /**
+     * Returns the initial Y point for the start of the animation.
+     *
+     * Возвращает начальную точку Y для начала анимации.
+     */
+    getStyleY(): string | null;
+    /**
+     * Updating the initial position of the element for the animation.
+     *
+     * Обновление начального положения элемента для анимации.
+     */
+    update(): this;
+    /**
+     * Resets all data to initial values.
+     *
+     * Сбрасывает все данные к начальным значениям.
+     */
+    reset(): this;
+}

package/dist/constructors/Window/WindowPersistent.d.ts

@@ -0,0 +1,46 @@
+import { WindowClasses } from './WindowClasses';
+import { WindowElement } from './WindowElement';
+import { WindowProps } from './props';
+import { Ref } from 'vue';
+/**
+ * Class for managing the animation output before closing the window.
+ *
+ * Класс управления выводом анимации перед закрытием окна.
+ */
+export declare class WindowPersistent {
+    protected readonly props: WindowProps;
+    protected readonly classes: WindowClasses;
+    protected readonly element: WindowElement;
+    readonly item: Ref<boolean, boolean>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param classes an object for working with classes and searching for elements/ объект для работы с классами и поиском элементов
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     */
+    constructor(props: WindowProps, classes: WindowClasses, element: WindowElement);
+    /**
+     * Request to enable animation.
+     *
+     * Запрос на включение анимации.
+     */
+    on(): boolean;
+    /**
+     * Request to disable animation.
+     *
+     * Запрос на выключение анимации.
+     */
+    disabled(): this;
+    /**
+     * Event of the animation end of the closing prohibition.
+     *
+     * Событие окончания анимации запрета на закрытие.
+     */
+    protected readonly onTransitionend: () => void;
+    /**
+     * Removes the event of the end of the animation.
+     *
+     * Удаляет событие окончания анимации.
+     */
+    protected removeEvent(): void;
+}

package/dist/constructors/Window/WindowPosition.d.ts

@@ -0,0 +1,128 @@
+import { WindowClient } from './WindowClient';
+import { WindowElement } from './WindowElement';
+import { WindowCoordinates } from './WindowCoordinates';
+import { WindowProps } from './props';
+/**
+ * A class for working with position.
+ *
+ * Класс для работы с позицией.
+ */
+export declare class WindowPosition {
+    protected readonly props: WindowProps;
+    protected readonly client: WindowClient;
+    protected readonly element: WindowElement;
+    protected readonly coordinates: WindowCoordinates;
+    protected x: number;
+    protected y: number;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param client object for working with mouse pointer coordinates/ объект для работы с координатами указателя мыши
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     * @param coordinates object for working with coordinates/ объект для работы с координатами
+     */
+    constructor(props: WindowProps, client: WindowClient, element: WindowElement, coordinates: WindowCoordinates);
+    /**
+     * Checks if the alignment type is above the element.
+     *
+     * Проверяет, является ли тип выравнивания над элементом.
+     */
+    isOver(): boolean;
+    /**
+     * Returns the X position.
+     *
+     * Возвращает позицию X.
+     */
+    getX(): number;
+    /**
+     * Returns the Y position.
+     *
+     * Возвращает позицию Y.
+     */
+    getY(): number;
+    /**
+     * Returns the X position for styles.
+     *
+     * Возвращает позицию X для стилей.
+     */
+    getStyleX(): string;
+    /**
+     * Returns the Y position for styles.
+     *
+     * Возвращает позицию Y для стилей.
+     */
+    getStyleY(): string;
+    /**
+     * Update of the element's position coordinates.
+     *
+     * Обновление координаты положения элемента.
+     */
+    update(): boolean;
+    /**
+     * Updates the scroll position if an element is selected.
+     *
+     * Обновляет место скрола, если выбран элемент.
+     */
+    updateScroll(): void;
+    /**
+     * Updates the scroll display status of the element.
+     *
+     * Обновляет статус отображения скролла у элемента.
+     */
+    updateBody(): void;
+    /**
+     * Returns the axis alignment values.
+     *
+     * Возвращает значения оси выравнивания.
+     */
+    protected getAxis(): WindowProps['axis'];
+    /**
+     * Returns the margins from the control element.
+     *
+     * Возвращает отступы от элемента управления.
+     * @param axis the axis of alignment of the element/ ось выравнивания элемента
+     */
+    protected getIndent(axis: string): number;
+    /**
+     * Calculation of the position for window alignment.
+     *
+     * Вычисление места положения для выравнивания окна.
+     * @param rectTop high control coordinates/ высокие координаты контрола
+     * @param rectBottom lower control coordinates/ нижние координаты контрола
+     */
+    protected getOverHeight(rectTop: number, rectBottom: number): number;
+    /**
+     * Changes in position along the X coordinate.
+     *
+     * Изменения положения по координате X.
+     */
+    protected setX(): this;
+    /**
+     * Changes in position along the Y coordinate.
+     *
+     * Изменения положения по координате Y.
+     */
+    protected setY(): this;
+    /**
+     * Calculation of the element's position.
+     *
+     * Вычисление положения элемента.
+     * @param inValue initial values/ начальные значения
+     * @param outValue final values/ конечные значения
+     * @param length length of the object/ длина объекта
+     * @param innerLength length of the indentation/ длина отступа
+     * @param maxSize maximum length/ максимальная длина
+     */
+    protected calculationInner(inValue: number, outValue: number, length: number, innerLength: number, maxSize: number): number;
+    /**
+     * Calculation of the element's position.
+     *
+     * Вычисление положения над элемента.
+     * @param value initial values/ начальные значения
+     * @param top high control coordinates/ высокие координаты контрола
+     * @param bottom lower control coordinates/ нижние координаты контрола
+     * @param length length of the object/ длина объекта
+     * @param innerLength length of the indentation/ длина отступа
+     */
+    protected calculationOver(value: number, top: number, bottom: number, length: number, innerLength: number): number;
+}

package/dist/constructors/Window/WindowStatic.d.ts

@@ -0,0 +1,58 @@
+import { ToRefs, Ref } from 'vue';
+import { EventItem } from '@dxtmisha/functional';
+import { WindowElement } from './WindowElement';
+import { WindowProps } from './props';
+/**
+ * Class for working with a static window.
+ *
+ * Класс для работы со статичным окном.
+ */
+export declare class WindowStatic {
+    protected readonly props: WindowProps;
+    protected readonly element: WindowElement;
+    protected event?: EventItem<Window, Event>;
+    readonly item: Ref<boolean, boolean>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param refs input data in the form of reactive elements/ входные данные в виде реактивных элементов
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     */
+    constructor(props: WindowProps, refs: ToRefs<WindowProps>, element: WindowElement);
+    /**
+     * Checks if the static mode is enabled.
+     *
+     * Проверяет, включен ли режим статичности.
+     */
+    isStaticMod(): boolean;
+    /**
+     * Starts the status tracking event.
+     *
+     * Стартует событие слежения за статусами.
+     */
+    start(): void;
+    /**
+     * Restores the data to its previous state.
+     *
+     * Восстанавливает данные в прежнее состояние.
+     */
+    stop(): void;
+    /**
+     * Checks if the static window is active.
+     *
+     * Проверяет, активно ли статичное окно.
+     */
+    protected isStatic(): boolean;
+    /**
+     * The function called when an event is triggered.
+     *
+     * Вызываемая функция при срабатывании события.
+     */
+    protected readonly listener: () => void;
+    /**
+     * Performs status check and activates events when turned on.
+     *
+     * Выполняет проверку статуса и активизирует события при включении.
+     */
+    protected readonly make: () => void;
+}

package/dist/constructors/Window/WindowStatus.d.ts

@@ -0,0 +1,80 @@
+import { WindowElement } from './WindowElement';
+import { WindowStatusItem } from './basicTypes';
+import { Ref } from 'vue';
+/**
+ * A class that changes the status of the current component. This is needed for
+ * working with animation and behavior of the element when opening/closing.
+ *
+ * Класс, отвечающий за изменение статуса текущего компонента. Это нужно для работы
+ * с анимацией и поведением элемента при открытии/закрытии.
+ */
+export declare class WindowStatus {
+    protected readonly element: WindowElement;
+    readonly item: Ref<WindowStatusItem, WindowStatusItem>;
+    /**
+     * Constructor
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     */
+    constructor(element: WindowElement);
+    /**
+     * Checks if the current status is closed (hide).
+     *
+     * Проверяет, является ли текущий статус закрытым (hide).
+     */
+    isHide(): boolean;
+    /**
+     * Checks if the current status is open (open/flash).
+     *
+     * Проверяет, является ли текущий статус открытым (open/flash).
+     */
+    isOpen(): boolean;
+    /**
+     * Change the current status.
+     *
+     * Изменить текущий статус.
+     * @param value value/ значение
+     */
+    set(value: WindowStatusItem): this;
+    /**
+     * Translates status to display.
+     *
+     * Переводит статус в display.
+     */
+    toDisplay(): this;
+    /**
+     * Translates status to preparation.
+     *
+     * Переводит статус в preparation.
+     */
+    toPreparation(): this;
+    /**
+     * Translates status to flash.
+     *
+     * Переводит статус в flash.
+     */
+    toFlash(): this;
+    /**
+     * Translates status to open.
+     *
+     * Переводит статус в open.
+     */
+    toOpen(): this;
+    /**
+     * Translates status to hide.
+     *
+     * Переводит статус в hide.
+     */
+    toHide(): this;
+    /**
+     * Translates status to close.
+     *
+     * Переводит статус в close.
+     */
+    toClose(): this;
+    /**
+     * Updates the data-status attribute on the main element and teleport element.
+     *
+     * Обновляет атрибут data-status на основном элементе и элементе телепорта.
+     */
+    update(): void;
+}

package/dist/constructors/Window/WindowStyles.d.ts

@@ -0,0 +1,38 @@
+import { WindowElement } from './WindowElement';
+import { WindowCoordinates } from './WindowCoordinates';
+import { WindowPosition } from './WindowPosition';
+import { WindowOrigin } from './WindowOrigin';
+/**
+ * Style management class.
+ *
+ * Класс управления стилями.
+ */
+export declare class WindowStyles {
+    protected readonly element: WindowElement;
+    protected readonly coordinates: WindowCoordinates;
+    protected readonly position: WindowPosition;
+    protected readonly origin: WindowOrigin;
+    protected readonly className: string;
+    /**
+     * Constructor
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     * @param coordinates object for working with coordinates/ объект для работы с координатами
+     * @param position object for working with the position of the element/ объект для работы с положением элемента
+     * @param origin the object for work is in the initial position upon opening/ объект для работы в начальной позиции при открытии
+     * @param className class name/ название класса
+     */
+    constructor(element: WindowElement, coordinates: WindowCoordinates, position: WindowPosition, origin: WindowOrigin, className: string);
+    /**
+     * Data update.
+     *
+     * Обновление данных.
+     */
+    update(): void;
+    /**
+     * Updates the window type (menu or modal).
+     *
+     * Обновляет тип окна (меню или модальное).
+     * @param isMenu whether the window is a menu/ является ли окно меню
+     */
+    updateType(isMenu: boolean): void;
+}