@dxtmisha/constructor 0.23.0 → 0.39.3

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

@@ -0,0 +1,132 @@
+import { WindowClasses } from './WindowClasses';
+import { WindowElement } from './WindowElement';
+/**
+ * A class for working with coordinates.
+ *
+ * Класс для работы с координатами.
+ */
+export declare class WindowCoordinates {
+    protected readonly classes: WindowClasses;
+    protected readonly element: WindowElement;
+    protected top: number;
+    protected right: number;
+    protected bottom: number;
+    protected left: number;
+    protected width: number;
+    protected height: number;
+    protected innerWidth: number;
+    protected innerHeight: number;
+    protected controlWidth: number;
+    protected controlHeight: number;
+    protected padding: number;
+    protected location: string;
+    /**
+     * Constructor
+     * @param classes an object for working with classes and searching for elements/ объект для работы с классами и поиском элементов
+     * @param element an object of the class for working with elements/ объект класса для работы с элементами
+     */
+    constructor(classes: WindowClasses, element: WindowElement);
+    /**
+     * Returns the distance from the top point.
+     *
+     * Возвращает расстояние от верхней точки.
+     */
+    getTop(): number;
+    /**
+     * Returns the distance from the right point.
+     *
+     * Возвращает расстояние от правой точки.
+     */
+    getRight(): number;
+    /**
+     * Returns the distance from the lower point.
+     *
+     * Возвращает расстояние от нижней точки.
+     */
+    getBottom(): number;
+    /**
+     * Returns the distance from the left point.
+     *
+     * Возвращает расстояние от левой точки.
+     */
+    getLeft(): number;
+    /**
+     * Returns the width of the element.
+     *
+     * Возвращает ширину элемента.
+     */
+    getWidth(): number;
+    /**
+     * Returns the height of the element.
+     *
+     * Возвращает высоту элемента.
+     */
+    getHeight(): number;
+    /**
+     * Returns the width of the window.
+     *
+     * Возвращает ширину окна.
+     */
+    getInnerWidth(): number;
+    /**
+     * Returns the height of the window.
+     *
+     * Возвращает высоту окна.
+     */
+    getInnerHeight(): number;
+    /**
+     * Returns the width of the control element.
+     *
+     * Возвращает ширину элемента управления.
+     */
+    getControlWidth(): number;
+    /**
+     * Returns the height of the control element.
+     *
+     * Возвращает высоту элемента управления.
+     */
+    getControlHeight(): number;
+    /**
+     * Returns the margins of the element.
+     *
+     * Возвращает отступы у элемента.
+     */
+    getPadding(): number;
+    /**
+     * Returns the values of the element's position.
+     *
+     * Возвращает значения положения элемента.
+     */
+    getLocation(): string;
+    /**
+     * Returns the maximum height of the body.
+     *
+     * Возвращает максимальную высоту у body.
+     */
+    getMaxHeight(): number;
+    /**
+     * Data updates.
+     *
+     * Обновления данных.
+     */
+    update(): boolean;
+    /**
+     * Resets all data to initial values.
+     *
+     * Сбрасывает все данные к начальным значениям.
+     */
+    reset(): this;
+    /**
+     * Initializes padding value from computed styles.
+     *
+     * Инициализирует значение отступов из вычисленных стилей.
+     */
+    protected initPadding(): number;
+    /**
+     * Calculates control position values.
+     *
+     * Вычисляет значения положения контроля.
+     * @param top position of an element/ положение элемента
+     */
+    protected initLocation(top: number): string;
+}

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

@@ -0,0 +1,143 @@
+import { VNode, ComputedRef, Ref } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract, ConstrClass } from '@dxtmisha/functional';
+import { Window } from './Window';
+import { WindowPropsBasic } from './props';
+import { WindowClasses, WindowComponents, WindowEmits, WindowExpose, WindowSlots } from './types';
+import { RoleType, AriaTrueOrFalse } from '../../library';
+import { NumberOrString } from '@dxtmisha/functional-basic';
+/**
+ * WindowDesign
+ */
+export declare class WindowDesign<COMP extends WindowComponents, EXPOSE extends WindowExpose, CLASSES extends WindowClasses, P extends WindowPropsBasic> extends DesignConstructorAbstract<HTMLDivElement, COMP, WindowEmits, EXPOSE, WindowSlots, CLASSES, P> {
+    protected readonly item: Window;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, WindowEmits, 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 main window element.
+     *
+     * Рендер главного элемента окна.
+     */
+    readonly renderMain: () => VNode;
+    /**
+     * Render body element.
+     *
+     * Рендер элемента тела.
+     */
+    readonly renderBody: () => VNode;
+    /**
+     * Generates an element to group the displayed data.
+     *
+     * Генерирует элемент для группировки выводимых данных.
+     */
+    readonly renderBodyGroup: () => VNode[];
+    /**
+     * Render context element.
+     *
+     * Рендер элемента контекста.
+     */
+    readonly renderBodyContext: () => VNode[];
+    /**
+     * Generates an element to display the image.
+     *
+     * Генерирует элемент для вывода изображения
+     */
+    readonly renderBodyImage: () => VNode[];
+    /**
+     * Generates an element to display the close button.
+     *
+     * Генерирует элемент для вывода кнопки закрытия.
+     */
+    readonly renderBodyClose: () => VNode[];
+    /**
+     * Props for the main element.
+     *
+     * Свойства для главного элемента.
+     */
+    protected readonly propsMain: ComputedRef<{
+        id?: string;
+        role?: RoleType;
+        tabindex?: NumberOrString;
+        'aria-activedescendant'?: string;
+        'aria-atomic'?: AriaTrueOrFalse;
+        'aria-autocomplete'?: "none" | "inline" | "list" | "both";
+        'aria-busy'?: AriaTrueOrFalse;
+        'aria-checked'?: AriaTrueOrFalse | "mixed";
+        'aria-colcount'?: number;
+        'aria-colindex'?: number;
+        'aria-colspan'?: number;
+        'aria-controls'?: string;
+        'aria-current'?: AriaTrueOrFalse | "page" | "step" | "location" | "date" | "time";
+        'aria-describedby'?: string;
+        'aria-details'?: string;
+        'aria-disabled'?: AriaTrueOrFalse;
+        'aria-errormessage'?: string;
+        'aria-expanded'?: AriaTrueOrFalse;
+        'aria-flowto'?: string;
+        'aria-grabbed'?: AriaTrueOrFalse;
+        'aria-haspopup'?: AriaTrueOrFalse | "dialog" | "menu" | "listbox" | "tree" | "grid";
+        'aria-hidden'?: AriaTrueOrFalse;
+        'aria-invalid'?: AriaTrueOrFalse | "grammar" | "spelling";
+        'aria-keyshortcuts'?: string;
+        'aria-label'?: string;
+        'aria-labelledby'?: string;
+        'aria-level'?: number;
+        'aria-live'?: "off" | "polite" | "assertive";
+        'aria-modal'?: AriaTrueOrFalse;
+        'aria-multiline'?: AriaTrueOrFalse;
+        'aria-multiselectable'?: AriaTrueOrFalse;
+        'aria-orientation'?: "horizontal" | "vertical" | "undefined";
+        'aria-owns'?: string;
+        'aria-placeholder'?: string;
+        'aria-posinset'?: number;
+        'aria-pressed'?: AriaTrueOrFalse | "mixed";
+        'aria-readonly'?: AriaTrueOrFalse;
+        'aria-relevant'?: "additions" | "removals" | "text" | "all" | string;
+        'aria-required'?: AriaTrueOrFalse;
+        'aria-roledescription'?: string;
+        'aria-rowcount'?: number;
+        'aria-rowindex'?: number;
+        'aria-rowspan'?: number;
+        'aria-selected'?: AriaTrueOrFalse;
+        'aria-setsize'?: number;
+        'aria-sort'?: "none" | "ascending" | "descending" | "other";
+        'aria-valuemax'?: string | number;
+        'aria-valuemin'?: string | number;
+        'aria-valuenow'?: string | number;
+        'aria-valuetext'?: string;
+        key: string;
+        ref: Ref<HTMLDivElement | undefined, HTMLDivElement | undefined>;
+        class: ConstrClass | undefined;
+        style: ConstrStyles | undefined;
+        'data-window': string;
+        onTransitionend: () => void;
+    }>;
+}

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