@dxtmisha/constructor 0.30.1 → 0.39.3

package/dist/constructors/Mask/MaskValue.d.ts

@@ -0,0 +1,89 @@
+import { MaskType } from './MaskType';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { MaskItem } from './MaskItem';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskValueBasic } from './MaskValueBasic';
+import { FieldMaskItem, FieldMasks } from '../../types/fieldTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for transforming the entered data into the final result.
+ *
+ * Класс для преобразования введенных данных в конечный результат.
+ */
+export declare class MaskValue {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    protected readonly mask: MaskItem;
+    protected readonly special: MaskSpecial;
+    protected readonly valueBasic: MaskValueBasic;
+    protected infoCache?: FieldMasks;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     * @param mask object for managing masks/ объект управления маской
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, format: MaskFormat, mask: MaskItem, special: MaskSpecial, valueBasic: MaskValueBasic);
+    /**
+     * Receiving a list with information about standard values/
+     * Получение списка с информацией о стандартных значениях
+     */
+    readonly info: ComputedRef<FieldMasks>;
+    /** Final value (shortcut)/ Финальное значение (ярлык) */
+    readonly item: ComputedRef<string>;
+    /** Checks if the mask is fully filled/ Проверяет, полностью ли заполнена маска */
+    readonly isFull: ComputedRef<boolean>;
+    /** Checks if the mask is fully filled by length/ Проверяет, полностью ли заполнена маска по длине */
+    readonly isEnd: ComputedRef<boolean>;
+    /**
+     * Returns old values.
+     *
+     * Возвращает старые значения.
+     */
+    getValueCache(): string;
+    /**
+     * Getting full information for global verification.
+     *
+     * Получение полной информации для глобальной проверки.
+     */
+    getForCheck(): FieldMaskItem;
+    /**
+     * Getting information for a specific group.
+     *
+     * Получение информации для конкретной группы.
+     * @param groupName group name/ название группы
+     */
+    getInfoItem(groupName: string): FieldMaskItem | undefined;
+    /** Returns the final form of the value/ Возвращает финальный вид значения */
+    protected readonly valueFinal: ComputedRef<string>;
+    /**
+     * Checks if there is a value by the key number in the basic values.
+     *
+     * Проверяет, есть ли значение по номеру ключа в базовых значениях.
+     * @param index key number/ номер ключа
+     */
+    protected isStandard(index: number): boolean;
+    /**
+     * Returns values based on the specified data information structure.
+     *
+     * Возвращает значения по указанной структуре информации о данных.
+     * @param info data information/ информация о данных
+     */
+    protected getValue(info: FieldMasks): string;
+    /**
+     * Adding a new character to the list divided by groups if it is not there and returning the property of the given group.
+     *
+     * Добавление нового символа в список, разделенный по группам, если его там нет, и возвращение свойства данной группы.
+     * @param data data for verification/ данные для проверки
+     * @param groupName group name/ название группы
+     */
+    protected add(data: FieldMasks, groupName: string): FieldMaskItem;
+}

package/dist/constructors/Mask/MaskValueBasic.d.ts

@@ -0,0 +1,49 @@
+import { MaskRubberTransition } from './MaskRubberTransition';
+import { MaskItem } from './MaskItem';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskCharacter } from './MaskCharacter';
+import { ComputedRef } from 'vue';
+/**
+ * Class for getting basic input values.
+ *
+ * Класс для получения базовых вводимых значений.
+ */
+export declare class MaskValueBasic {
+    protected readonly rubberTransition: MaskRubberTransition;
+    protected readonly mask: MaskItem;
+    protected readonly special: MaskSpecial;
+    protected readonly character: MaskCharacter;
+    /**
+     * Constructor
+     * @param rubberTransition object for managing the transition character/ объект для управления символом перехода
+     * @param mask object for managing masks/ объект управления маской
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param character object for managing entered character/ объект для управления введённым символом
+     */
+    constructor(rubberTransition: MaskRubberTransition, mask: MaskItem, special: MaskSpecial, character: MaskCharacter);
+    /**
+     * Receiving basic standard values.
+     *
+     * Получение базовых стандартных значений.
+     */
+    readonly item: ComputedRef<string>;
+    /**
+     * Checks if the values are filled in.
+     *
+     * Проверяет, заполнены ли значения.
+     */
+    is(): boolean;
+    /**
+     * Getting the character from the basic standard values by its key number.
+     *
+     * Получение символа из базовых стандартных значений по его номеру ключа.
+     * @param index key number/ номер ключа
+     */
+    getChar(index: number): string | undefined;
+    /**
+     * Getting the length of basic standard values.
+     *
+     * Получение длины базовых стандартных значений.
+     */
+    getLength(): number;
+}

package/dist/constructors/Mask/MaskView.d.ts

@@ -0,0 +1,84 @@
+import { MaskType } from './MaskType';
+import { MaskDate } from './MaskDate';
+import { MaskFormat } from './MaskFormat';
+import { MaskSpecial } from './MaskSpecial';
+import { MaskRubber } from './MaskRubber';
+import { MaskItem } from './MaskItem';
+import { MaskValueBasic } from './MaskValueBasic';
+import { MaskValidation } from './MaskValidation';
+import { MaskViewList } from './basicTypes';
+import { MaskProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with data to output to the screen.
+ *
+ * Класс для работы с данными для вывода на экран.
+ */
+export declare class MaskView {
+    protected readonly props: MaskProps;
+    protected readonly type: MaskType;
+    protected readonly date: MaskDate;
+    protected readonly format: MaskFormat;
+    protected readonly special: MaskSpecial;
+    protected readonly rubber: MaskRubber;
+    protected readonly mask: MaskItem;
+    protected readonly valueBasic: MaskValueBasic;
+    protected readonly validation: MaskValidation;
+    /** Class name prefix for item/ Класс для элемента */
+    protected classNameItem: string;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type object for working with the mask type/ объект для работы с типом маски
+     * @param date object for working with date types/ объект для работы с типом даты
+     * @param format object for managing numeric mask types/ объект для управления числовыми типами масок
+     * @param special object for working with special characters/ объект для работы со специальными символами
+     * @param rubber object for working with rubber types/ объект для работы с резиновыми типами
+     * @param mask object for managing masks/ объект управления маской
+     * @param valueBasic object for working with base values/ объект для работы с базовыми значениями
+     * @param validation object for working with validation/ объект для работы с валидацией
+     * @param className define class names for each symbol/ определить название класса для каждого символа
+     */
+    constructor(props: MaskProps, type: MaskType, date: MaskDate, format: MaskFormat, special: MaskSpecial, rubber: MaskRubber, mask: MaskItem, valueBasic: MaskValueBasic, validation: MaskValidation, className: string);
+    /** View items list/ Список данных для отображения */
+    readonly item: ComputedRef<MaskViewList>;
+    /** Input value with special view characters/ Значение ввода со спецсимволами отображения */
+    readonly input: ComputedRef<string>;
+    /**
+     * Checks if the value is filled in.
+     *
+     * Проверяет, заполнено ли значение.
+     * @param value checked value/ проверяемое значение
+     */
+    protected isValue(value?: string): value is string;
+    /**
+     * Returns the status by mask symbol and its position.
+     *
+     * Возвращает статус по символу маски и месту его расположения.
+     * @param char mask symbol/ символ маски
+     * @param value entered value for this position/ введённое значение для позиции
+     */
+    protected getStatus(char: string, value?: string): string;
+    /**
+     * Returns symbol for rendering: real value or placeholder.
+     *
+     * Возвращает символ для отображения: реальное значение или плейсхолдер.
+     * @param char mask symbol/ символ маски
+     * @param value entered value for position/ введённое значение позиции
+     */
+    protected getValue(char: string, value?: string): string;
+    /**
+     * Returns display version of special mask symbol (placeholder).
+     *
+     * Возвращает отображаемую версию специального символа маски (плейсхолдер).
+     * @param char mask symbol/ символ маски
+     */
+    protected getSpecialToView(char: string): string;
+    /**
+     * Returns special character for view by its group name.
+     *
+     * Возвращает специальный символ для отображения по имени группы.
+     * @param groupName group name/ имя группы
+     */
+    protected getViewChar(groupName: string): string | undefined;
+}

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

@@ -0,0 +1,52 @@
+import { ConstrBind, GeoDate } from '@dxtmisha/functional';
+import { FieldPatternItemOrFunction, FieldValidationItem } from '../../types/fieldTypes';
+import { MaskPropsBasic } from './props';
+export type MaskTypeItem = GeoDate | 'text' | 'number' | 'number-format' | 'currency';
+export type MaskElementInput = HTMLInputElement | undefined;
+export type MaskMatchItem = RegExp | string;
+export type MaskFractionItem = string | boolean | number;
+export type MaskSpecialItem = {
+    defaultValue?: string;
+    rubber?: boolean;
+    transitionChar?: string | string[];
+    minLength?: number;
+    maxLength?: number;
+    match?: MaskMatchItem;
+    pattern?: FieldPatternItemOrFunction;
+    view?: string;
+};
+export type MaskSpecialInfo = {
+    index: number;
+    key: number;
+    char: string;
+};
+export type MaskSpecialList = Record<string, MaskSpecialItem>;
+export type MaskSpecialProp = string | string[] | MaskSpecialList;
+export type MaskViewItem = {
+    className: string;
+    value: string;
+};
+export type MaskViewList = MaskViewItem[];
+export type MaskList = string | string[];
+export type MaskEventData = FieldValidationItem;
+export type MaskEventSelection = {
+    target: HTMLInputElement;
+    start: number;
+    end: number;
+    length: number;
+};
+export type MaskComponentInclude = {
+    mask?: object;
+};
+export type MaskPropsInclude<Mask extends MaskPropsBasic = MaskPropsBasic> = {
+    name?: string;
+    mask?: string | ConstrBind<Mask>;
+    maskVisible?: boolean;
+    maskNone?: boolean;
+    currency?: string;
+    currencyHide?: boolean;
+    fraction?: MaskFractionItem;
+    maskAttrs?: ConstrBind<Mask>;
+};
+export declare const MASK_CHAR_DELETE = "~";
+export declare const MASK_VIEW_DEFAULT = "_";

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

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

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

@@ -0,0 +1,48 @@
+import { FieldPatternItemOrFunction } from '../../types/fieldTypes';
+import { MaskFractionItem, MaskList, MaskMatchItem, MaskSpecialProp, MaskTypeItem } from './basicTypes';
+interface MaskPropsToken {
+    visible?: boolean;
+    visiblePartly?: boolean;
+    align?: 'center' | 'left' | 'right';
+    dir?: 'ltr' | 'rtl';
+}
+export interface MaskPropsBasic {
+    name?: string;
+    value?: string | number;
+    valueDefault?: string | number;
+    currency?: string;
+    currencyHide?: boolean;
+    fullOnly?: boolean;
+    mask?: MaskList;
+    special?: MaskSpecialProp;
+    match?: MaskMatchItem;
+    groupSave?: boolean;
+    pattern?: FieldPatternItemOrFunction;
+    check?: FieldPatternItemOrFunction;
+    fraction?: MaskFractionItem;
+    type?: MaskTypeItem;
+    view?: string;
+    inputAttrs?: Partial<HTMLInputElement>;
+    language?: string;
+}
+/**
+ * Type describing incoming properties.
+ *
+ * Тип, описывающий входящие свойства.
+ */
+export interface MaskProps extends MaskPropsBasic, MaskPropsToken {
+}
+/**
+ * Default value for property.
+ *
+ * Значение по умолчанию для свойства.
+ */
+export declare const defaultsMask: {
+    visible: boolean;
+    special: string;
+    match: RegExp;
+    type: string;
+    groupSave: boolean;
+    view: string;
+};
+export {};

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

@@ -0,0 +1,62 @@
+import { ComputedRef } from 'vue';
+import { ConstrClass } from '@dxtmisha/functional';
+import { FieldValidationItem } from '../../types/fieldTypes';
+/**
+ * Interface for describing which components need to be connected for work.
+ *
+ * Интерфейс для описания, какие компоненты надо подключить для работы.
+ */
+export type MaskComponents = {};
+/**
+ * Type describing available events.
+ *
+ * Тип, описывающий доступные события.
+ */
+export type MaskEmits = {
+    focus: [event: FocusEvent];
+    blur: [event: FocusEvent];
+    keydown: [event: KeyboardEvent];
+    keyup: [event: KeyboardEvent];
+    beforeinput: [event: InputEvent];
+    input: [
+        event: InputEvent,
+        value: FieldValidationItem
+    ];
+    inputLite: [value: FieldValidationItem];
+    change: [
+        event: InputEvent,
+        value: FieldValidationItem
+    ];
+    changeLite: [value: FieldValidationItem];
+    paste: [event: ClipboardEvent];
+    reset: [event: Event];
+};
+/**
+ * Type describing available properties.
+ *
+ * Тип, описывающий доступные свойства.
+ */
+export interface MaskExpose {
+    valueBasic: ComputedRef<string>;
+    value: ComputedRef<string>;
+    setValue(value: string): boolean;
+    clear(): boolean;
+}
+/**
+ * Type describing available slots.
+ *
+ * Тип, описывающий доступные слоты.
+ */
+export interface MaskSlots {
+}
+/**
+ * Type describing subclasses.
+ *
+ * Тип, описывающий подклассы.
+ */
+export type MaskClasses = {
+    main: ConstrClass;
+    input: string;
+    character: string;
+    characterItem: string;
+};

package/dist/constructors/Menu/Menu.d.ts

@@ -0,0 +1,92 @@
+import { Ref, ToRefs, ComputedRef } from 'vue';
+import { ConstrEmit, DesignComp, ListDataRef } from '@dxtmisha/functional';
+import { EventClickInclude } from '../../classes/EventClickInclude';
+import { BarsInclude } from '../Bars';
+import { WindowInclude } from '../Window';
+import { MenuRequest } from './MenuRequest';
+import { MenuSearch } from './MenuSearch';
+import { MenuWindow } from './MenuWindow';
+import { MenuValue } from './MenuValue';
+import { MenuGo } from './MenuGo';
+import { MenuComponents, MenuEmits, MenuSlots } from './types';
+import { MenuProps } from './props';
+import { MenuControlBasic } from './basicTypes';
+import { ListPropsBasic } from '../List';
+import { EventClickValue } from '../../types/eventClickTypes';
+import { IconPropsBasic } from '../Icon';
+import { ImagePropsBasic } from '../Image';
+import { ListItemPropsBasic } from '../ListItem';
+import { BadgePropsBasic } from '../Badge';
+import { ProgressPropsBasic } from '../Progress';
+/**
+ * Menu
+ */
+export declare class Menu {
+    protected readonly props: MenuProps;
+    protected readonly refs: ToRefs<MenuProps>;
+    protected readonly element: Ref<HTMLElement | undefined>;
+    protected readonly classDesign: string;
+    protected readonly className: string;
+    protected readonly components?: DesignComp<MenuComponents, MenuProps> | undefined;
+    protected readonly slots?: MenuSlots | undefined;
+    protected readonly emits?: ConstrEmit<MenuEmits> | undefined;
+    /** Request handler for list data/ Обработчик запросов данных списка */
+    readonly request: MenuRequest;
+    /** Search helper for menu filtering/ Вспомогательный класс поиска для фильтрации меню */
+    readonly search: MenuSearch;
+    /** Value manager for selected handling/ Менеджер выбранного значения */
+    readonly value: MenuValue;
+    /** Data manager for list selection and mapping/ Менеджер данных списка для выбора и сопоставления */
+    readonly data: ListDataRef;
+    readonly go: MenuGo;
+    /** Include for working with the Bars component/ Подключение для работы с компонентом Bars */
+    readonly bars: BarsInclude;
+    /** Include for working with the Window component/ Подключение для работы с компонентом Window */
+    readonly window: WindowInclude;
+    /** Window manager for Menu/ Класс управления окном Menu */
+    readonly menuWindow: MenuWindow;
+    /** Click event helper to unify click emissions/ Вспомогательный класс кликов для унифицированной отправки событий */
+    readonly event: EventClickInclude;
+    /** Data for binding to controls/ Данные для привязки к контролам */
+    readonly slotData: MenuControlBasic;
+    /**
+     * 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: MenuProps, refs: ToRefs<MenuProps>, element: Ref<HTMLElement | undefined>, classDesign: string, className: string, components?: DesignComp<MenuComponents, MenuProps> | undefined, slots?: MenuSlots | undefined, emits?: ConstrEmit<MenuEmits> | undefined);
+    /**
+     * Getting data for binding to the List component.
+     *
+     * Получение данных для привязки к компоненту List.
+     */
+    readonly binds: ComputedRef<ListPropsBasic< IconPropsBasic<ImagePropsBasic>, ListItemPropsBasic<IconPropsBasic<ImagePropsBasic>, BadgePropsBasic<IconPropsBasic<ImagePropsBasic>>, ProgressPropsBasic>>>;
+    /**
+     * Getting data for binding to controls.
+     *
+     * Получение данных для привязки к контролам.
+     * @returns data for binding to controls/ данные для привязки к контролам
+     */
+    getControlBinds(): MenuControlBasic;
+    /**
+     * Click handler.
+     *
+     * Обработчик клика.
+     * @param event event object/ объект события
+     * @param options data object/ объект с данными
+     */
+    readonly onClick: (event: MouseEvent, options?: EventClickValue) => void;
+    /**
+     * Click on the slot handler.
+     *
+     * Обработчик клика по слоту.
+     * @param event event object/ объект события
+     */
+    readonly onClickSlot: (event: Event) => void;
+}

package/dist/constructors/Menu/MenuDesign.d.ts

@@ -0,0 +1,79 @@
+import { VNode } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract } from '@dxtmisha/functional';
+import { Menu } from './Menu';
+import { WindowControlItem } from '../Window';
+import { MenuControlItem } from './basicTypes';
+import { MenuPropsBasic } from './props';
+import { MenuClasses, MenuComponents, MenuEmits, MenuExpose, MenuSlots } from './types';
+/**
+ * MenuDesign
+ */
+export declare class MenuDesign<COMP extends MenuComponents, EXPOSE extends MenuExpose, CLASSES extends MenuClasses, P extends MenuPropsBasic> extends DesignConstructorAbstract<HTMLDivElement, COMP, MenuEmits, EXPOSE, MenuSlots, CLASSES, P> {
+    protected readonly item: Menu;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, MenuEmits, 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 data for control.
+     *
+     * Генерирует данные для контроля.
+     * @param props data for the transferable property/ данные для передаваемого свойства
+     */
+    readonly renderControl: (props: WindowControlItem) => VNode | undefined;
+    /**
+     * Render title element.
+     *
+     * Рендер элемента заголовка.
+     * @param props data for the transferable property/ данные для передаваемого свойства
+     */
+    readonly renderTitle: (props: WindowControlItem) => VNode[];
+    /**
+     * Render list element.
+     *
+     * Рендер элемента списка.
+     * @param props data for the transferable property/ данные для передаваемого свойства
+     */
+    readonly renderList: (props: WindowControlItem) => VNode | undefined;
+    /**
+     * Render footer element.
+     *
+     * Рендер элемента футера.
+     * @param props data for the transferable property/ данные для передаваемого свойства
+     */
+    readonly renderFooter: (props: WindowControlItem) => VNode | undefined;
+    /**
+     * Generates data for control.
+     *
+     * Генерирует данные для контроля.
+     * @param props data for the transferable property/ данные для передаваемого свойства
+     */
+    protected getBinds(props: WindowControlItem): MenuControlItem;
+}

package/dist/constructors/Menu/MenuGo.d.ts

@@ -0,0 +1,49 @@
+import { ListDataRef, NumberOrStringOrBoolean } from '@dxtmisha/functional';
+import { MenuValue } from './MenuValue';
+import { MenuProps } from './props';
+/**
+ * Navigation manager for Menu component
+ *
+ * Менеджер навигации для компонента Menu
+ */
+export declare class MenuGo {
+    protected readonly props: MenuProps;
+    protected readonly value: MenuValue;
+    protected readonly data: ListDataRef;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param value value manager/ менеджер значений
+     * @param data data manager for list/ менеджер данных списка
+     */
+    constructor(props: MenuProps, value: MenuValue, data: ListDataRef);
+    /**
+     * Navigates to the previous item in the menu
+     *
+     * Переходит к предыдущему элементу меню
+     * @returns value of the previous item or undefined/ значение предыдущего элемента или undefined
+     */
+    readonly previous: () => NumberOrStringOrBoolean | undefined;
+    /**
+     * Navigates to the next item in the menu
+     *
+     * Переходит к следующему элементу меню
+     * @returns value of the next item or undefined/ значение следующего элемента или undefined
+     */
+    readonly next: () => NumberOrStringOrBoolean | undefined;
+    /**
+     * Returns the step value for navigation
+     *
+     * Возвращает значение шага для навигации
+     * @returns step value/ значение шага
+     */
+    protected getStep(): number;
+    /**
+     * Navigates through the menu items by the specified direction
+     *
+     * Перемещается по элементам меню в указанном направлении
+     * @param directions direction multiplier (-1 for previous, 1 for next)/ множитель направления (-1 для предыдущего, 1 для следующего)
+     * @returns value of the selected item or undefined/ значение выбранного элемента или undefined
+     */
+    protected go(directions: number): NumberOrStringOrBoolean | undefined;
+}