@dxtmisha/constructor 0.30.1 → 0.39.3

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

@@ -0,0 +1,59 @@
+import { Ref } from 'vue';
+import { WindowClasses } from './WindowClasses';
+/**
+ * A class for working with elements.
+ *
+ * Класс для работы с элементами.
+ */
+export declare class WindowElement {
+    protected readonly classes: WindowClasses;
+    readonly element: Ref<HTMLDivElement | undefined>;
+    /**
+     * Constructor
+     * @param classes an object for working with classes and searching for elements/ объект для работы с классами и поиском элементов
+     * @param element the element of the window itself/ элемент самого окна
+     */
+    constructor(classes: WindowClasses, element: Ref<HTMLDivElement | undefined>);
+    /**
+     * Checks if the main element exists.
+     *
+     * Проверяет, есть ли главный элемент.
+     */
+    isMain(): boolean;
+    /**
+     * Returns the main element.
+     *
+     * Возвращает главного элемента.
+     */
+    getMain(): HTMLDivElement | undefined;
+    /**
+     * Returns the control element of the current component.
+     *
+     * Возвращает элемент управления текущего компонента.
+     */
+    getControl(): HTMLElement | undefined;
+    /**
+     * Returns the dimensions of the control element.
+     *
+     * Возвращает размеры элемента управления.
+     */
+    getControlRect(): DOMRect | undefined;
+    /**
+     * Returns the body element of the window.
+     *
+     * Возвращает элемент тела окна.
+     */
+    getBody(): HTMLDivElement | undefined;
+    /**
+     * Returns the dimensions of the window's body element.
+     *
+     * Возвращает размеры элемента тела окна.
+     */
+    getBodyRect(): DOMRect | undefined;
+    /**
+     * Returns the window context element.
+     *
+     * Возвращает элемент контекста окна.
+     */
+    getBodyContext(): HTMLDivElement | undefined;
+}

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

@@ -0,0 +1,36 @@
+import { ConstrEmit } from '@dxtmisha/functional';
+import { WindowClasses } from './WindowClasses';
+import { WindowElement } from './WindowElement';
+import { WindowEmits } from './types';
+import { WindowEmitOptions } from './basicTypes';
+/**
+ * Class triggering a click status change event.
+ *
+ * Класс, вызывающий событие изменения статуса клика.
+ */
+export declare class WindowEmit {
+    protected readonly classes: WindowClasses;
+    protected readonly element: WindowElement;
+    protected readonly emits?: ConstrEmit<WindowEmits> | undefined;
+    /**
+     * Constructor
+     * @param classes an object for working with classes and searching for elements/ объект для работы с классами и поиском элементов
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     */
+    constructor(classes: WindowClasses, element: WindowElement, emits?: ConstrEmit<WindowEmits> | undefined);
+    /**
+     * Perform events.
+     *
+     * Выполнить события.
+     * @param open current state of the window/ текущее состояние окна
+     */
+    on(open: boolean): void;
+    /**
+     * Returns an object for calling the event handler.
+     *
+     * Возвращает объект для вызова обработчика события.
+     * @param open current state of the window/ текущее состояние окна
+     */
+    protected getEmitOptions(open: boolean): WindowEmitOptions;
+}

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

@@ -0,0 +1,52 @@
+import { Ref } from 'vue';
+import { EventItem, RefOrNormal } from '@dxtmisha/functional';
+/**
+ * Class for handling Escape key press to close windows.
+ *
+ * Класс для обработки нажатия клавиши Escape для закрытия окон.
+ */
+export declare class WindowEsc {
+    protected readonly open: Ref<boolean>;
+    protected readonly on?: (() => void) | undefined;
+    protected readonly active: RefOrNormal<boolean | (() => boolean)>;
+    /** Event handler instance/ Экземпляр обработчика событий */
+    protected event?: EventItem<HTMLElement, any>;
+    /**
+     * Constructor
+     * @param open Reference to the open state/ Ссылка на состояние открытия
+     * @param on Optional callback function when Escape is pressed/ Необязательная функция обратного вызова при нажатии Escape
+     * @param active Reference to the active state/ Ссылка на состояние активности
+     */
+    constructor(open: Ref<boolean>, on?: (() => void) | undefined, active?: RefOrNormal<boolean | (() => boolean)>);
+    /**
+     * Start listening for Escape key press.
+     *
+     * Начать прослушивание нажатия клавиши Escape.
+     */
+    start(): this;
+    /**
+     * Stop listening for Escape key press.
+     *
+     * Остановить прослушивание нажатия клавиши Escape.
+     */
+    stop(): this;
+    /**
+     * Check if the pressed key is Escape.
+     *
+     * Проверяет, является ли нажатая клавиша Escape.
+     * @param event Keyboard event/ Событие клавиатуры
+     */
+    protected isEsc(event: KeyboardEvent): boolean;
+    /**
+     * Event listener for keyboard events.
+     *
+     * Обработчик событий клавиатуры.
+     */
+    protected readonly listener: (event: KeyboardEvent) => void;
+    /**
+     * Create and initialize the event handler.
+     *
+     * Создать и инициализировать обработчик событий.
+     */
+    protected make(): void;
+}

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

@@ -0,0 +1,83 @@
+import { EventItem } from '@dxtmisha/functional';
+import { WindowStatus } from './WindowStatus';
+import { WindowClient } from './WindowClient';
+import { WindowFlash } from './WindowFlash';
+import { WindowOpen } from './WindowOpen';
+import { WindowVerification } from './WindowVerification';
+import { WindowProps } from './props';
+/**
+ * A class for working with events.
+ *
+ * Класс для работы с событиями.
+ */
+export declare class WindowEvent {
+    protected readonly props: WindowProps;
+    protected readonly status: WindowStatus;
+    protected readonly client: WindowClient;
+    protected readonly flash: WindowFlash;
+    protected readonly open: WindowOpen;
+    protected readonly verification: WindowVerification;
+    protected readonly event: EventItem<HTMLBodyElement, MouseEvent>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param status object for working with statuses/ объект для работы со статусами
+     * @param client object for working with mouse pointer coordinates/ объект для работы с координатами указателя мыши
+     * @param flash class object for working with fast window opening/ объект класса для работы с быстрым открытием окна
+     * @param open the class object for working with the status of closing or opening the window/ объект класса для работы со статусом закрытия или открытия окна
+     * @param verification an object for working with the check for changing the status of opening or closing/ объект для работы с проверкой изменения статуса открытия или закрытия
+     */
+    constructor(props: WindowProps, status: WindowStatus, client: WindowClient, flash: WindowFlash, open: WindowOpen, verification: WindowVerification);
+    /**
+     * Events of pressing a control element.
+     *
+     * События нажатия на элемент управления.
+     * @param event event object/ объект события
+     */
+    readonly onClick: (event: MouseEvent & TouchEvent) => Promise<void>;
+    /**
+     * Events of pressing the right mouse button on a control element.
+     *
+     * События нажатия на правую кнопку мыши на элемент управления.
+     * @param event event object/ объект события
+     */
+    readonly onContextmenu: (event: MouseEvent & TouchEvent) => Promise<void>;
+    /**
+     * Event of animation end when closing the window.
+     *
+     * Событие окончания анимации при закрытии окна.
+     */
+    readonly onTransition: () => void;
+    /**
+     * Starts listening to global events.
+     *
+     * Стартует прослушивание глобальных событий.
+     */
+    start(): this;
+    /**
+     * Stop the global event.
+     *
+     * Остановить глобальное событие.
+     */
+    stop(): this;
+    /**
+     * Changes the event listening status depending on the window's open status.
+     *
+     * Изменяет статус прослушивания события в зависимости от статуса открытия окна.
+     */
+    toggle(): this;
+    /**
+     * Event activation.
+     *
+     * Активация события.
+     * @param event event object/ объект события
+     */
+    protected on(event: MouseEvent & TouchEvent): Promise<void>;
+    /**
+     * Callback of the event when pressing any area for checking and changing the opening state.
+     *
+     * Callback события при нажатии на любую область для проверки и изменения состояния открытия.
+     * @param event event instance/ экземпляр события
+     */
+    protected readonly onGlobal: (event?: Event) => Promise<void>;
+}

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

@@ -0,0 +1,47 @@
+import { WindowClasses } from './WindowClasses';
+import { WindowProps } from './props';
+/**
+ * The class for working with the flash parameter. The flash property is
+ * responsible for disabling the animation when opening the window. Also,
+ * the animation is disabled when there are already open windows.
+ *
+ * Класс для работы с параметром flash. Свойство flash отвечает за отключение
+ * анимации при открытии окна. А также отключается анимация, когда уже есть
+ * открытые окна.
+ */
+export declare class WindowFlash {
+    protected readonly props: WindowProps;
+    protected readonly classes: WindowClasses;
+    protected control: boolean;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param classes an object for working with classes and searching for elements/ объект для работы с классами и поиском элементов
+     */
+    constructor(props: WindowProps, classes: WindowClasses);
+    /**
+     * Is the flash property active.
+     *
+     * Активно ли свойство flash.
+     */
+    is(): boolean;
+    /**
+     * Checks whether the animation needs to be disabled.
+     *
+     * Проверяет, надо ли отключить анимацию.
+     */
+    isOpen(): boolean;
+    /**
+     * Checks whether the animation needs to be disabled when closing.
+     *
+     * Проверяет, надо ли отключить анимацию при закрытии.
+     */
+    isClose(): boolean;
+    /**
+     * Change the value of the control parameter.
+     *
+     * Изменить значение параметра control.
+     * @param target the element that gets focus on click/ элемент, который получает фокус при клике
+     */
+    setControl(target?: HTMLElement): this;
+}

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

@@ -0,0 +1,45 @@
+import { WindowClasses } from './WindowClasses';
+import { WindowOpen } from './WindowOpen';
+/**
+ * A class for managing the hiding of elements outside the window when it is open.
+ *
+ * Класс для управления скрытием элементов вне окна при его открытии.
+ */
+export declare class WindowHidden {
+    protected classes: WindowClasses;
+    protected open: WindowOpen;
+    protected elements: HTMLElement[];
+    /**
+     * Constructor
+     * @param classes an object for working with class names / объект для работы с названиями классов
+     * @param open an object for working with the open state of the window / объект для работы с состоянием открытия окна
+     */
+    constructor(classes: WindowClasses, open: WindowOpen);
+    /**
+     * Returns the aria attribute data for hiding elements.
+     *
+     * Возвращает данные aria-атрибута для скрытия элементов.
+     */
+    protected getAriaData(): {
+        key: any;
+        value: any;
+    };
+    /**
+     * Finds all elements outside the window that need to be hidden.
+     *
+     * Находит все элементы вне окна, которые нужно скрыть.
+     */
+    protected findElements(): NodeListOf<HTMLElement> | undefined;
+    /**
+     * Hides elements outside the window by adding aria-hidden attribute.
+     *
+     * Скрывает элементы вне окна, добавляя атрибут aria-hidden.
+     */
+    protected toHidden(): void;
+    /**
+     * Shows previously hidden elements by removing aria-hidden attribute.
+     *
+     * Показывает ранее скрытые элементы, удаляя атрибут aria-hidden.
+     */
+    protected toShow(): void;
+}

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

@@ -0,0 +1,58 @@
+import { WindowProps } from './props';
+/**
+ * A class for working with hooks when opening and closing a window.
+ *
+ * Класс для работы с хуками при открытии и закрытии окна.
+ */
+export declare class WindowHook {
+    protected readonly props: WindowProps;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     */
+    constructor(props: WindowProps);
+    /**
+     * Hook for preparing elements before opening/closing.
+     *
+     * Хук для подготовки элементов перед открытием/закрытием.
+     */
+    preparation(): Promise<void>;
+    /**
+     * Hook before opening/closing.
+     *
+     * Хук перед открытием/закрытием.
+     * @param open current state of the window/ текущее состояние окна
+     */
+    before(open: boolean): Promise<boolean>;
+    /**
+     * Hook before opening.
+     *
+     * Хук перед открытием.
+     */
+    beforeOpening(): Promise<boolean>;
+    /**
+     * Hook before closing.
+     *
+     * Хук перед закрытием.
+     */
+    beforeClosing(): Promise<boolean>;
+    /**
+     * Hook after opening/closing.
+     *
+     * Хук после открытия/закрытия.
+     * @param open current state of the window/ текущее состояние окна
+     */
+    after(open: boolean): Promise<boolean>;
+    /**
+     * Hook after opening.
+     *
+     * Хук после открытия.
+     */
+    opening(): Promise<boolean>;
+    /**
+     * Hook after closing.
+     *
+     * Хук после закрытия.
+     */
+    closing(): Promise<boolean>;
+}

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;
+}