@dxtmisha/constructor 0.30.1 → 0.39.5

package/dist/constructors/Image/ImageBackground.d.ts

@@ -0,0 +1,67 @@
+import { NumberOrString } from '@dxtmisha/functional';
+import { ImageData } from './ImageData';
+import { ImageCoordinator } from './ImageCoordinator';
+import { ImageAdaptiveItem } from './ImageAdaptiveItem';
+import { ImageProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * A class for getting the value of background.
+ *
+ * Класс для получения значения background.
+ */
+export declare class ImageBackground {
+    protected readonly props: ImageProps;
+    protected readonly data: ImageData;
+    protected readonly coordinator: ImageCoordinator;
+    protected readonly adaptive: ImageAdaptiveItem;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param data image data/ данные изображения
+     * @param coordinator object for working with coordinates/ объект для работы с координатами
+     * @param adaptive an object for working with adapted scaling/ объект для работы с адаптированным масштабированием
+     */
+    constructor(props: ImageProps, data: ImageData, coordinator: ImageCoordinator, adaptive: ImageAdaptiveItem);
+    /**
+     * Returns values for the background-image property.
+     *
+     * Возвращает значения для свойства background-image.
+     */
+    readonly image: ComputedRef<string | null>;
+    /**
+     * Returns the image source/ Возвращает источник изображения
+     */
+    readonly imageSrc: ComputedRef<string | null>;
+    /**
+     * Returns values for the background property.
+     *
+     * Возвращает значения для свойства background.
+     */
+    readonly size: ComputedRef<string | null>;
+    /**
+     * Checks if the object is an image.
+     *
+     * Проверяет, является ли объект изображением.
+     */
+    isImage(): boolean;
+    /**
+     * Returns the value for the background-size property.
+     *
+     * Возвращает значение для свойства background-size.
+     * @param width width value/ значение ширины
+     * @param height height value/ значение высоты
+     */
+    protected getSize(width: NumberOrString, height: NumberOrString): string | null;
+    /**
+     * Returns sizes according to the coordinator property.
+     *
+     * Возвращает размеры по свойству координатора.
+     */
+    protected getSizeByCoordinator(): string | null;
+    /**
+     * Returns the scaling sizes.
+     *
+     * Возвращает размеры масштабирования.
+     */
+    protected getSizeForItem(): string | null;
+}

package/dist/constructors/Image/ImageCalculation.d.ts

@@ -0,0 +1,101 @@
+import { ImageSize } from './basicTypes';
+/**
+ * A class for storing data for adaptive computation of image scaling for a specific group.
+ *
+ * Класс для хранения данных для адаптивного вычисления масштабирования изображения для конкретной группы.
+ */
+export declare class ImageCalculation {
+    protected readonly name: string;
+    protected factorMax: number;
+    protected size: ImageSize;
+    protected offset: ImageSize;
+    /**
+     * Constructor
+     * @param name group name/ название группы
+     */
+    constructor(name: string);
+    /**
+     * Checks whether the element belongs to the current group.
+     *
+     * Проверяет, принадлежит ли элемент к текущей группе.
+     * @param name name of the checked group/ название проверяемой группы
+     */
+    is(name: string): boolean;
+    /**
+     * Checks if the group has elements with sizes. It is used to check if there is data for work.
+     *
+     * Проверяет, есть ли у группы элементы с размерами. Используется для проверки, есть ли данные для работы.
+     */
+    isSize(): boolean;
+    /**
+     * Returns the maximum physical width.
+     *
+     * Возвращает максимальную физическую ширину.
+     */
+    getWidth(): number;
+    /**
+     * Returns the maximum physical height.
+     *
+     * Возвращает максимальную физическую высоту.
+     */
+    getHeight(): number;
+    /**
+     * Returns the actual width.
+     *
+     * Возвращает фактическую ширину.
+     */
+    getOffsetWidth(): number;
+    /**
+     * Returns the actual height.
+     *
+     * Возвращает фактическую высоту.
+     */
+    getOffsetHeight(): number;
+    /**
+     * Returns the maximum multiplier for scaling.
+     *
+     * Возвращает максимальный множитель для масштабирования.
+     */
+    getFactorMax(): number;
+    /**
+     * Updating size.width, if it is less than the selected value.
+     *
+     * Обновление size.width, если она меньше выбранного значения.
+     * @param width value of the selected width/ значение выбранной ширины
+     */
+    makeWidth(width: number): this;
+    /**
+     * Updating size.height, if it is less than the selected value.
+     *
+     * Обновление size.height, если она меньше выбранного значения.
+     * @param height value of the selected height/ значение выбранной высоты
+     */
+    makeHeight(height: number): this;
+    /**
+     * Updating offset.width, if it is larger than the selected value.
+     *
+     * Обновление offset.width, если она больше выбранного значения.
+     * @param width value of the selected width/ значение выбранной ширины
+     */
+    makeOffsetWidth(width: number): this;
+    /**
+     * Updating offset.height, if it is larger than the selected value.
+     *
+     * Обновление offset.height, если она больше выбранного значения.
+     * @param height value of the selected height/ значение выбранной высоты
+     */
+    makeOffsetHeight(height: number): this;
+    /**
+     * Changes the multiplier value if it is greater than the checked value.
+     *
+     * Изменяет значение множителя, если оно больше проверяемого значения.
+     * @param value values for verification/ значения для проверки
+     */
+    makeFactorMax(value: number): this;
+    /**
+     * Restoring the value to its original state.
+     *
+     * Восстановление значения в изначальное состояние.
+     */
+    reset(): this;
+}

package/dist/constructors/Image/ImageCalculationList.d.ts

@@ -0,0 +1,42 @@
+import { ImageCalculation } from './ImageCalculation';
+/**
+ * Class for managing all ImageCalculation objects.
+ *
+ * Класс для управления всеми объектами ImageCalculation.
+ */
+export declare class ImageCalculationList {
+    protected static items: ImageCalculation[];
+    /**
+     * Checks if the group has elements with sizes. It is used to check if there is data for work.
+     *
+     * Проверяет, есть ли у группы элементы с размерами. Используется для проверки, есть ли данные для работы.
+     */
+    static isSize(): boolean;
+    /**
+     * Returns an object with data for calculation by the name of its group.
+     *
+     * Возвращает объект с данными для вычисления по названию его группы.
+     * @param name group name/ название группы
+     */
+    static get(name: string): ImageCalculation;
+    /**
+     * Resets all parameters for all groups.
+     *
+     * Сбрасывает все параметры для всех групп.
+     */
+    static reset(): void;
+    /**
+     * Search for the ImageCalculation object by the name of the group.
+     *
+     * Поиск объекта ImageCalculation по названию группы.
+     * @param name group name/ название группы
+     */
+    protected static find(name: string): ImageCalculation | undefined;
+    /**
+     * Creating a new ImageCalculation object by the name of the group.
+     *
+     * Создание нового объекта ImageCalculation по названию группы.
+     * @param name group name/ название группы
+     */
+    protected static init(name: string): ImageCalculation;
+}

package/dist/constructors/Image/ImageCoordinator.d.ts

@@ -0,0 +1,45 @@
+import { Undefined } from '@dxtmisha/functional';
+import { ImageCoordinatorItem, ImageSize } from './basicTypes';
+import { ImageProps } from './props';
+import { ComputedRef } from 'vue';
+type ImageCoordinatorItemFull = [number, number, number, number];
+/**
+ * A class for calculating the central part of the image by its coordinates.
+ *
+ * Класс для вычисления центральной части изображения по его координатам.
+ */
+export declare class ImageCoordinator {
+    protected readonly props: ImageProps;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     */
+    constructor(props: ImageProps);
+    /**
+     * Returns coordinates.
+     *
+     * Возвращает координаты.
+     */
+    readonly coordinator: ComputedRef<ImageCoordinatorItemFull>;
+    /**
+     * Returns the sizes for the background-position property by coordinates.
+     *
+     * Возвращает размеры для свойства background-position по координатам.
+     */
+    readonly size: ComputedRef<ImageSize>;
+    /**
+     * Checks if there are coordinates for calculation.
+     *
+     * Проверяет, есть ли координаты для вычисления.
+     */
+    is(): this is {
+        coordinator: Exclude<ImageCoordinatorItem, Undefined>;
+    };
+    /**
+     * Returns the values for the background property.
+     *
+     * Возвращает значения для свойства background.
+     */
+    getSize(): ImageSize<string>;
+}
+export {};

package/dist/constructors/Image/ImageData.d.ts

@@ -0,0 +1,56 @@
+import { Ref } from 'vue';
+import { Undefined } from '@dxtmisha/functional';
+import { ImageType } from './ImageType';
+import { ImageEventItem, ImageItem } from './basicTypes';
+import { ImageProps } from './props';
+/**
+ * A class for obtaining image or icon data.
+ *
+ * Класс для получения данных изображения или иконки.
+ */
+export declare class ImageData {
+    protected readonly props: ImageProps;
+    protected readonly type: ImageType;
+    /**
+     * Returns images.
+     *
+     * Возвращает изображения.
+     */
+    readonly image: Ref<ImageEventItem, ImageEventItem>;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param type image type/ тип изображения
+     */
+    constructor(props: ImageProps, type: ImageType);
+    /**
+     * Checks if there are values.
+     *
+     * Проверяет, есть ли значения.
+     */
+    is(): this is {
+        image: Exclude<ImageEventItem, Undefined>;
+    };
+    /**
+     * Checks if the value is a link, that is, a type of string.
+     *
+     * Проверяет, является ли значение ссылкой, то есть видом строки.
+     */
+    isLink(): this is {
+        image: Ref<string>;
+    };
+    /**
+     * Checks if the value is an image object.
+     *
+     * Проверяет, является ли значение объектом изображения.
+     */
+    isImage(): this is {
+        image: Ref<ImageItem>;
+    };
+    /**
+     * Calculates the image value and returns it.
+     *
+     * Вычисляет значение изображения и возвращает его.
+     */
+    protected init(): Promise<ImageEventItem>;
+}

package/dist/constructors/Image/ImageDesign.d.ts

@@ -0,0 +1,79 @@
+import { VNode, ComputedRef } from 'vue';
+import { ConstrOptions, ConstrStyles, DesignConstructorAbstract } from '@dxtmisha/functional';
+import { Image } from './Image';
+import { ImagePropsBasic } from './props';
+import { ImageClasses, ImageComponents, ImageEmits, ImageExpose, ImageSlots } from './types';
+/**
+ * ImageDesign
+ */
+export declare class ImageDesign<COMP extends ImageComponents, EXPOSE extends ImageExpose, CLASSES extends ImageClasses, P extends ImagePropsBasic> extends DesignConstructorAbstract<HTMLDivElement, COMP, ImageEmits, EXPOSE, ImageSlots, CLASSES, P> {
+    protected readonly item: Image;
+    /**
+     * Constructor
+     * @param name class name/ название класса
+     * @param props properties/ свойства
+     * @param options list of additional parameters/ список дополнительных параметров
+     * @param ItemConstructor image item class/ класс элемента изображения
+     */
+    constructor(name: string, props: Readonly<P>, options?: ConstrOptions<COMP, ImageEmits, P>, ItemConstructor?: typeof Image);
+    /**
+     * 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;
+    /**
+     * Properties for the image tag.
+     *
+     * Свойства для тега image.
+     */
+    readonly propsImage: ComputedRef<any>;
+    /**
+     * Main properties.
+     *
+     * Основные свойства.
+     */
+    readonly propsMain: ComputedRef<any>;
+    /**
+     * Rendering the picture tag.
+     *
+     * Рендеринг тега picture.
+     */
+    readonly renderPicture: () => VNode;
+    /**
+     * Rendering the img tag.
+     *
+     * Рендеринг тега img.
+     */
+    readonly renderImg: () => VNode;
+    /**
+     * Rendering the img item.
+     *
+     * Рендеринг элемента img.
+     */
+    readonly renderImgItem: () => VNode;
+    /**
+     * Rendering the value for the component.
+     *
+     * Рендеринг значения для компонента.
+     */
+    readonly renderValue: () => string | VNode | undefined;
+}

package/dist/constructors/Image/ImageFile.d.ts

@@ -0,0 +1,58 @@
+import { ImageItem } from './basicTypes';
+/**
+ * Maximum size allowed without conversion.
+ *
+ * Максимальный размер, допустимый без преобразования.
+ */
+export declare const MAX_SIZE: number;
+/**
+ * Class for working with uploaded images.
+ *
+ * Класс для работы с загруженными изображениями.
+ */
+export declare class ImageFile {
+    /**
+     * Checks if the file is an image.
+     *
+     * Проверяет, является ли файл изображением.
+     * @param file verified file/ проверяемый файл
+     */
+    static isImage(file: File): boolean;
+    /**
+     * Creates an image based on a file or a link.
+     *
+     * Создает изображение на основе файла или ссылки.
+     * @param src file or link/ файл или ссылка
+     */
+    static createImage(src: string | File): Promise<ImageItem | undefined>;
+    /**
+     * Returns a link to the image.
+     *
+     * Возвращает ссылку на изображение.
+     * @param src file or link/ файл или ссылка
+     */
+    static getPath(src: string | File): Promise<string>;
+    /**
+     * Applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer.
+     *
+     * Асинхронно читать содержимое файлов (или буферы данных), хранящиеся на компьютере пользователя.
+     * @param file the Blob or File from which to read/ Blob или File которые следует прочитать
+     */
+    static getFileResult(file: File): Promise<string>;
+    /**
+     * Applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer.
+     *
+     * Асинхронно читать содержимое файлов (или буферы данных), хранящиеся на компьютере пользователя.
+     * @param file the Blob or File from which to read/ Blob или File которые следует прочитать
+     */
+    static getFileReader(file: File): Promise<string>;
+    /**
+     * Image size adaptation. Checks if the image size is larger than maxSize, reduces it to maxSize.
+     *
+     * Адаптация размера изображения. Проверяет, если размер изображения больше maxSize, уменьшает его до maxSize.
+     * @param image image element/ элемент изображения
+     * @param src link to image/ ссылка на изображение
+     * @param maxSize maximum allowable image size/ максимальный допустимый размер изображения
+     */
+    protected static getSRC(image: HTMLImageElement, src?: string | File, maxSize?: number): string;
+}

package/dist/constructors/Image/ImageImg.d.ts

@@ -0,0 +1,87 @@
+import { Ref, WatchHandle, ComputedRef } from 'vue';
+import { ConstrBind } from '@dxtmisha/functional';
+import { ImageType } from './ImageType';
+import { ImagePosition } from './ImagePosition';
+import { ImageBackground } from './ImageBackground';
+import { ImageAttrs, ImagePictureList } from './basicTypes';
+import { ImageProps } from './props';
+/**
+ * A class for working with the img tag.
+ *
+ * Класс для работы с тегом img.
+ */
+export declare class ImageImg {
+    protected readonly props: ImageProps;
+    protected readonly element: Ref<HTMLElement | undefined>;
+    protected readonly type: ImageType;
+    protected readonly position: ImagePosition;
+    protected readonly background: ImageBackground;
+    protected lazyInit: Ref<boolean, boolean>;
+    protected lazyStatus?: WatchHandle;
+    constructor(props: ImageProps, element: Ref<HTMLElement | undefined>, type: ImageType, position: ImagePosition, background: ImageBackground);
+    /**
+     * Determines whether to use the img tag/ Определяет, использовать ли тег img
+     */
+    readonly is: ComputedRef<boolean>;
+    /**
+     * Determines whether lazy loading is enabled/ Определяет, включена ли ленивя загрузка
+     */
+    readonly isLazy: ComputedRef<boolean>;
+    /**
+     * Determines whether to use the picture tag/ Определяет, использовать ли тег picture
+     */
+    readonly isPicture: ComputedRef<boolean>;
+    /**
+     * Calculates all properties for binding to the element/
+     * Вычисляет все свойства для привязки к элементу
+     */
+    readonly binds: ComputedRef<ConstrBind<ImageAttrs>>;
+    /**
+     * Calculates the picture sources for different resolutions/
+     * Вычисляет источники picture для разных разрешений
+     */
+    readonly picture: ComputedRef<ImagePictureList | undefined>;
+    /**
+     * Calculates styles for binding to the element.
+     *
+     * Вычисляет стили для привязки к элементу.
+     */
+    readonly styles: ComputedRef<Record<string, any>>;
+    /**
+     * Checks if the type is file or image.
+     *
+     * Проверяет, является ли тип файлом или изображением.
+     */
+    protected isType(): boolean;
+    /**
+     * Checks if the size is contained or cover.
+     *
+     * Проверяет, является ли размер contain или cover.
+     */
+    protected isSize(): boolean;
+    /**
+     * Returns the value for the transform scale.
+     *
+     * Возвращает значение для свойства transform scale.
+     */
+    protected getSize(): string | undefined;
+    /**
+     * Returns the srcset attribute value.
+     *
+     * Возвращает значение атрибута srcset.
+     */
+    protected getSrcset(): string | undefined;
+    /**
+     * Converts the srcset key to a string.
+     *
+     * Преобразует ключ srcset в строку.
+     * @param key key/ ключ
+     */
+    protected toSrcsetKey(key: string | number): string;
+    /**
+     * Initializes lazy loading.
+     *
+     * Инициализирует ленивую загрузку.
+     */
+    protected makeLazy(): void;
+}

package/dist/constructors/Image/ImageInclude.d.ts

@@ -0,0 +1,35 @@
+import { VNode, ComputedRef } from 'vue';
+import { ConstrEmit, DesignComponents, RefOrNormal, ConstrBind } from '@dxtmisha/functional';
+import { ImageEventData, ImageComponentsInclude, ImageEmitsInclude, ImagePropsInclude } from './basicTypes';
+import { ItemList } from '@dxtmisha/functional-basic';
+/**
+ * Класс для подключения и работы с компонентом изображения.
+ *
+ * A class for connecting to and working with the image component.
+ */
+export declare class ImageInclude {
+    protected readonly props: ImagePropsInclude;
+    protected readonly components?: DesignComponents<ImageComponentsInclude, ImagePropsInclude> | undefined;
+    protected readonly emits?: ConstrEmit<ImageEmitsInclude> | undefined;
+    protected readonly extra?: RefOrNormal<Record<string, any>> | undefined;
+    /**
+     * Constructor for working with images.
+     *
+     * Конструктор для работы с изображениями.
+     * @param props input parameter/ входной параметр
+     * @param components object for working with components/ объект для работы с компонентами
+     * @param emits the function is called when an event is triggered/ функция вызывается, когда срабатывает событие
+     * @param extra additional parameter/ дополнительный параметр
+     */
+    constructor(props: ImagePropsInclude, components?: DesignComponents<ImageComponentsInclude, ImagePropsInclude> | undefined, emits?: ConstrEmit<ImageEmitsInclude> | undefined, extra?: RefOrNormal<Record<string, any>> | undefined);
+    /**
+     * Проверяет, есть ли изображение/ Checks if an image exists
+     */
+    readonly isImage: ComputedRef<boolean>;
+    /**
+     * Возвращает данные для передачи компоненту/ Returns data to pass to the component
+     */
+    readonly bind: ComputedRef<ConstrBind<ItemList>>;
+    render(): VNode[];
+    onLoad(event: ImageEventData): void;
+}

package/dist/constructors/Image/ImagePdf.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Class for working with PDF files.
+ *
+ * Класс для работы с PDF-файлами.
+ */
+export declare class ImagePdf {
+    /**
+     * Checks if the file is an image.
+     *
+     * Проверяет, является ли файл PDF.
+     * @param file verified file/ проверяемый файл
+     */
+    static isPdf(file: string | File): boolean;
+    /**
+     * Applications asynchronously read the contents of files (or raw data buffers) stored on the user's computer.
+     *
+     * Асинхронно читать содержимое файлов (или буферы данных), хранящиеся на компьютере пользователя.
+     * @param file the Blob or File from which to read/ Blob или File которые следует прочитать
+     */
+    static get(file: string | File): Promise<string>;
+}

package/dist/constructors/Image/ImagePosition.d.ts

@@ -0,0 +1,30 @@
+import { ImageCoordinator } from './ImageCoordinator';
+import { ImageProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * A class for obtaining data for the background-position property.
+ *
+ * Класс для получения данных для свойства background-position.
+ */
+export declare class ImagePosition {
+    protected readonly props: ImageProps;
+    protected readonly coordinator: ImageCoordinator;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     * @param coordinator coordinates for margins/ координаты для отступов
+     */
+    constructor(props: ImageProps, coordinator: ImageCoordinator);
+    /**
+     * Returns the position on the left.
+     *
+     * Возвращает позицию слева.
+     */
+    readonly x: ComputedRef<string>;
+    /**
+     * Returns the position on the top.
+     *
+     * Возвращает позицию сверху.
+     */
+    readonly y: ComputedRef<string>;
+}

package/dist/constructors/Image/ImageType.d.ts

@@ -0,0 +1,22 @@
+import { ImageTypeItem } from './basicTypes';
+import { ImageProps } from './props';
+import { ComputedRef } from 'vue';
+/**
+ * Class for working with the image type.
+ *
+ * Класс для работы с типом изображения.
+ */
+export declare class ImageType {
+    protected readonly props: ImageProps;
+    /**
+     * Constructor
+     * @param props input data/ входные данные
+     */
+    constructor(props: ImageProps);
+    /**
+     * Get the image type.
+     *
+     * Получения тип изображения.
+     */
+    readonly item: ComputedRef<ImageTypeItem>;
+}