@zeedhi/common 3.0.6 → 3.1.0

package/dist/types/components/zd-dialog/dialog.d.ts

@@ -1,76 +0,0 @@
-import { IButton } from '../zd-button/interfaces';
-import { Component } from '../zd-component/component';
-import { IDialog } from './interfaces';
-/**
- * Base class for Dialog component.
- */
-export declare class Dialog extends Component implements IDialog {
-    /**
-     * Buttons collection that will be displayed on dialog footer
-     */
-    buttons: IButton[];
-    /**
-     * The maximum width of the content
-     */
-    maxWidth: string | number;
-    /**
-     * Clicking outside will not dismiss the dialog
-     */
-    persistent: boolean;
-    /**
-     * The text displayed on dialog
-     */
-    text: string;
-    /**
-     * The title displayed on dialog
-     */
-    title: string;
-    /**
-     * Dialog type (normal, success, error, warning, info)
-     */
-    type: string;
-    /**
-     * Confirm button component name
-     */
-    confirmButton?: string;
-    /**
-     * Deny button component name
-     */
-    denyButton?: string;
-    exit?: boolean;
-    /**
-     * Default dialog buttons
-     * @private
-     */
-    private getDefaultButtons;
-    protected defaultValues: {
-        confirmButton: string | undefined;
-        denyButton: string | undefined;
-        name: string;
-        maxWidth: string | number;
-        persistent: boolean;
-        type: string;
-        title: string;
-        text: string;
-        exit: boolean | undefined;
-    };
-    /**
-     * Creates a new Dialog
-     * @param props Dialog structure
-     */
-    constructor(props: IDialog);
-    /**
-     * Assign all dialog properties
-     * @param dialog Dialog structure
-     */
-    assignDialogProperties(dialog: IDialog): void;
-    protected clickDefaultButtonKeyMapping(): any;
-    /**
-     * Displays dialog
-     */
-    show(): void;
-    /**
-     * Hides dialog
-     */
-    hide(): void;
-}

package/dist/types/components/zd-dialog/interfaces.d.ts

@@ -1,13 +0,0 @@
-import { IButton } from '../zd-button/interfaces';
-import { IComponent } from '../zd-component/interfaces';
-export interface IDialog extends IComponent {
-    buttons?: IButton[];
-    maxWidth?: string | number;
-    persistent?: boolean;
-    confirmButton?: string;
-    denyButton?: string;
-    text?: string;
-    title?: string;
-    type?: string;
-    exit?: boolean;
-}

package/dist/types/components/zd-divider/divider.d.ts

@@ -1,20 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IDivider } from './interfaces';
-/**
- * Base class for Divider component.
- */
-export declare class Divider extends ComponentRender implements IDivider {
-    /**
-     * Adds indentation (72px) for normal dividers, reduces max height for vertical.
-     */
-    inset: boolean;
-    /**
-     * Displays dividers vertically.
-     */
-    vertical: boolean;
-    /**
-     * Creates a new Divider.
-     * @param props Divider properties
-     */
-    constructor(props: IDivider);
-}

package/dist/types/components/zd-divider/interfaces.d.ts

@@ -1,8 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IComponentRender } from '../zd-component/interfaces';
-import { Divider } from './divider';
-export type IDividerEvent = IEventParam<Divider>;
-export interface IDivider extends IComponentRender {
-    inset?: boolean;
-    vertical?: boolean;
-}

package/dist/types/components/zd-dropdown/dropdown.d.ts

@@ -1,81 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IComponentRender } from '../zd-component/interfaces';
-import { IDropdown } from './interfaces';
-/**
- * Base class for Dropdown component.
- */
-export declare class Dropdown extends ComponentRender implements IDropdown {
-    /**
-     * Applies position absolute to the dropdown.
-     */
-    absolute: boolean;
-    /**
-     * Designate to put the component that activates the menu.
-     */
-    activator: IComponentRender;
-    /**
-     * Designates if menu should close when its content is clicked.
-     */
-    closeOnContentClick: boolean;
-    /**
-     * Designates if menu should close on outside-activator click.
-     */
-    closeOnClick: boolean;
-    /**
-     * Applies a cursor to the dropdown.
-     */
-    cursor: string;
-    /**
-     * Disables the menu.
-     */
-    disabled: boolean;
-    /**
-     * Applies hover to the dropdown.
-     */
-    hover: boolean;
-    /**
-     * Sets the height for the dropdown.
-     */
-    height?: number | string;
-    /**
-     * Sets the maximum height for the dropdown.
-     */
-    maxHeight: number | string;
-    /**
-     * Sets the maximum width for the dropdown.
-     */
-    maxWidth: number | string;
-    /**
-     * Sets the minimum height for the dropdown.
-     */
-    minHeight: number | string;
-    /**
-     * Sets the minimum width for the dropdown.
-     */
-    minWidth: number | string;
-    /**
-     * Offset the menu on the x-axis.
-     */
-    offsetX: boolean;
-    /**
-     * Offset the menu on the x-axis.
-     */
-    offsetY: boolean;
-    /**
-     * Designates whether menu should open on activator click.
-     */
-    openOnClick: boolean;
-    /**
-     * Designates whether menu should open on activator hover.
-     */
-    openOnHover: boolean;
-    /**
-     * Controls whether the component is visible or hidden.
-     */
-    value?: any;
-    /**
-     * Creates a new DropDown.
-     * @param props DropDown properties
-     */
-    constructor(props: IDropdown);
-}

package/dist/types/components/zd-dropdown/interfaces.d.ts

@@ -1,23 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IComponentRender } from '../zd-component/interfaces';
-import { Dropdown } from './dropdown';
-export type IDropdownEvent = IEventParam<Dropdown>;
-export interface IDropdown extends IComponentRender {
-    absolute?: boolean;
-    activator: IComponentRender;
-    disabled?: boolean;
-    closeOnContentClick?: boolean;
-    closeOnClick?: boolean;
-    cursor?: string;
-    hover?: boolean;
-    height?: number | string;
-    maxHeight?: number | string;
-    maxWidth?: number | string;
-    minHeight?: number | string;
-    minWidth?: number | string;
-    offsetX?: boolean;
-    offsetY?: boolean;
-    openOnClick?: boolean;
-    openOnHover?: boolean;
-    value?: any;
-}

package/dist/types/components/zd-footer/footer.d.ts

@@ -1,80 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { IComponentRender } from '../zd-component/interfaces';
-import { IFooter } from './interfaces';
-/**
- * Base class for Footer component.
- */
-export declare class Footer extends ComponentRender implements IFooter {
-    /**
-     * Applies position absolute to footer.
-     */
-    absolute: boolean;
-    /**
-     * Designates the footer as part of the application layout.
-     */
-    app: boolean;
-    /**
-     * Render components on the middle of footer.
-     */
-    centerSlot: IComponentRender[];
-    /**
-     * Applies specified color to the control. It can be the name of material or css color in hexa.
-     */
-    color: string;
-    /**
-     * Events registered to the footer.
-     */
-    /**
-     * Applies position fixed to footer.
-     */
-    fixed: boolean;
-    /**
-     * Sets the height for footer.
-     */
-    height: number | string;
-    /**
-     * Positions the footer inside the application content.
-     */
-    inset: boolean;
-    /**
-     * Render components on the left of footer.
-     */
-    leftSlot: IComponentRender[];
-    /**
-     * Sets the maximum height for the footer.
-     */
-    maxHeight?: number | string;
-    /**
-     * Sets the maximum width for the footer.
-     */
-    maxWidth?: number | string;
-    /**
-     * Sets the minimum height for the footer.
-     */
-    minHeight?: number | string;
-    /**
-     * Sets the minimum width for the footer.
-     */
-    minWidth?: number | string;
-    /**
-     * Remove all padding from the footer.
-     */
-    padless: boolean;
-    /**
-     * Render components on the right of footer.
-     */
-    rightSlot: IComponentRender[];
-    /**
-     * Sets the width for the component.
-     */
-    width?: number | string;
-    /**
-     * Creates a new Footer.
-     * @param props Footer properties
-     */
-    constructor(props: IFooter);
-    /**
-     * Retrieves named slots visibility
-     */
-    get namedSlotsIsVisible(): number;
-}

package/dist/types/components/zd-footer/interfaces.d.ts

@@ -1,26 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Footer } from './footer';
-export type IFooterEvent = IEventParam<Footer>;
-export interface IFooterEvents extends IComponentEvents<IFooterEvent> {
-    blur: undefined;
-    click: undefined;
-    focus: undefined;
-}
-export interface IFooter extends IComponentRender {
-    absolute?: boolean;
-    app?: boolean;
-    centerSlot?: IComponentRender[];
-    color?: string;
-    fixed?: boolean;
-    height?: number | string;
-    inset?: boolean;
-    leftSlot?: IComponentRender[];
-    maxHeight?: number | string;
-    maxWidth?: number | string;
-    minHeight?: number | string;
-    minWidth?: number | string;
-    padless?: boolean;
-    rightSlot?: IComponentRender[];
-    width?: number | string;
-}

package/dist/types/components/zd-form/form.d.ts

@@ -1,174 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ComponentRender } from '../zd-component/component-render';
-import { Input } from '../zd-input/input';
-import { IForm, IFormComponent, IFormEvents, IFormGrid } from './interfaces';
-/**
- * Base class for Form component.
- */
-export declare class Form extends ComponentRender implements IForm {
-    /**
-     * Children component structure if the component has children.
-     */
-    children: IFormComponent[];
-    /**
-     * Applies the align-items css property.
-     * Available options are start, center, end, space-between, space-around and stretch.
-     */
-    align?: string;
-    /**
-     * Applies the justify-content css property.
-     * Available options are start, center, end, space-between and space-around.
-     */
-    justify?: string;
-    /**
-     * Defines the component height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    height: string | number;
-    /**
-     * Defines the component min height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minHeight: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxHeight: string | number;
-    /**
-     * Defines the component width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    width: string | number;
-    /**
-     * Defines the component min width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minWidth: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxWidth: string | number;
-    /**
-     * Defines form events.
-     */
-    events: IFormEvents;
-    /**
-     * Optional validation method assigned by view layer.
-     */
-    private viewValidate?;
-    /**
-     * Optional submit method.
-     */
-    submitFunction?: () => void;
-    /**
-     * Reset validation method assigned by view layer.
-     */
-    private viewResetValidation?;
-    /**
-     * Children components that are Inputs.
-     */
-    private inputs;
-    private internalValue;
-    /**
-     * Creates a new Form.
-     * @param props Form properties
-     */
-    constructor(props: IForm);
-    /**
-     * Form value.
-     */
-    get value(): IDictionary;
-    set value(value: IDictionary);
-    /**
-     * Clear all form inputs
-     */
-    clearForm(): void;
-    /**
-     * Saves input instance and defines property on form value.
-     * @param component Children component
-     */
-    registerInput(component: Input): void;
-    /**
-     * Children props without grid system.
-     */
-    get childrenProps(): {
-        [key: string]: any;
-        children?: import("..").IComponentRender[] | undefined;
-        component: string;
-        allowDuplicate?: boolean | undefined;
-        autofocus?: boolean | undefined;
-        componentId?: number | undefined;
-        cssClass?: string | undefined;
-        cssStyle?: string | IDictionary<any> | undefined;
-        events?: import("..").IComponentEvents<import("@zeedhi/core").IEventParam<any>> | undefined;
-        directives?: import("..").IComponentDirectives | undefined;
-        isVisible?: string | boolean | undefined;
-        dark?: boolean | undefined;
-        light?: boolean | undefined;
-        theme?: string | undefined;
-        keyMap?: import("@zeedhi/core").IKeyMap<import("@zeedhi/core").IEventParam<any>> | undefined;
-        name: string;
-        parent?: import("..").IComponentInstance | undefined;
-        tabStop?: boolean | undefined;
-        userProperties?: IDictionary<any> | undefined;
-        fillHeight?: boolean | undefined;
-    }[];
-    /**
-     * Checks if the value matches a col value (1, 2, ... 12) or auto
-     */
-    private matchColumn;
-    private breakpoints;
-    private matchBreakpoint;
-    private handleColClass;
-    private handleOffsetClass;
-    /**
-     * This method searches in a css class string to find classes related to grid cols \
-     * Parses all of the grid cols classes found to form grid object entries, for example
-     * the following class: 'zd-col-sm-12 zd-col-md-6' will become { sm: '12', md: '6' }
-     */
-    private parseGridClasses;
-    private getChildGrid;
-    /**
-     * Grid system for each child.
-     */
-    get childrenGrid(): IDictionary<IFormGrid>;
-    /**
-     * Validates form.
-     */
-    validate(): Promise<{
-        valid: boolean;
-    }>;
-    /**
-     * Sets view validation method.
-     */
-    setViewValidate(viewValidate: () => Promise<{
-        valid: boolean;
-        errors: {
-            id: string | number;
-            errorMessages: string[];
-        }[];
-    }>): void;
-    /**
-     * Sets view reset validation method.
-     */
-    setViewResetValidation(viewResetValidation: () => void): void;
-    /**
-     * Triggered when form is submitted and it's valid.
-     * @param event DOM Event
-     * @param element Form component
-     */
-    callSubmitEvent(event: Event, element: any): void;
-    /**
-     * Triggered when the component is mounted.
-     * @param element Element mounted reference
-     */
-    onMounted(element: any): void;
-    submit(): void;
-    /**
-     * Reset all form validation errors.
-     * @throws Will throw if viewResetValidation is undefined
-     */
-    resetValidation(): void;
-}

package/dist/types/components/zd-form/interfaces.d.ts

@@ -1,36 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { EventDef, IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Form } from './form';
-export type IFormEvent = IEventParam<Form>;
-export interface IFormEvents extends IComponentEvents<IFormEvent> {
-    submit?: EventDef<IFormEvent>;
-}
-export interface IFormGrid {
-    cols?: string;
-    lg?: string;
-    md?: string;
-    sm?: string;
-    xl?: string;
-    xxl?: string;
-    offset?: string;
-    'offset-lg'?: string;
-    'offset-md'?: string;
-    'offset-sm'?: string;
-    'offset-xl'?: string;
-    'offset-xxl'?: string;
-}
-export interface IFormComponent extends IComponentRender {
-    grid?: IFormGrid;
-}
-export interface IForm extends IComponentRender {
-    align?: string;
-    justify?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    children?: IFormComponent[];
-    events?: IFormEvents;
-}

package/dist/types/components/zd-frame/frame.d.ts

@@ -1,81 +0,0 @@
-import { IDictionary } from '@zeedhi/core';
-import { ComponentRender } from '../zd-component/component-render';
-import { IFrame, IFrameEvents } from './interfaces';
-export declare class Frame extends ComponentRender implements IFrame {
-    loading: boolean;
-    local: boolean;
-    metadata: object;
-    override: object;
-    params: object;
-    overrideNamedProps: IDictionary;
-    path: string;
-    cache: boolean;
-    JSONCache: boolean | string;
-    events: IFrameEvents;
-    cacheDuration: number;
-    /**
-     * Defines the component height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    height: string | number;
-    /**
-     * Defines the component min height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minHeight: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxHeight: string | number;
-    /**
-     * Defines the component width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    width: string | number;
-    /**
-     * Defines the component min width. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    minWidth: string | number;
-    /**
-     * Defines the component max height. Possible values for this property can be
-     * <samp>'auto', '100%', '400px' or 400</samp>
-     */
-    maxWidth: string | number;
-    type: string;
-    private readonly headerName;
-    private static readonly cacheName;
-    protected resolveLoad?: (value: object) => void;
-    protected rejectLoad?: (reason?: any) => void;
-    constructor(props: IFrame);
-    onCreated(): void;
-    overrideNamedPropsFunc(metadata: object): any;
-    reload(): Promise<void>;
-    /**
-     * Triggered when frame is load.
-     * @param event
-     * @param element
-     */
-    afterLoad(event?: Event, element?: HTMLElement): void;
-    /**
-     * Deletes all frame cached requests
-     */
-    static deleteCache(): Promise<boolean>;
-    waitLoading(): Promise<object>;
-    protected notFoundError(e: unknown): void;
-    private getMetadata;
-    private requestPage;
-    /**
-     * Checks if cache response is valid (not expired yet)
-     * @param response
-     */
-    private isValid;
-    /**
-     * Puts the metadata in defined cache with defined url
-     * @param cache Cache object in which data will be stored
-     * @param url Metadata url
-     * @param metadata Metadata to be stored
-     */
-    private putCache;
-}

package/dist/types/components/zd-frame/interfaces.d.ts

@@ -1,23 +0,0 @@
-import { IDictionary, IEventParam } from '@zeedhi/core';
-import { EventDef, IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Frame } from './frame';
-export type IFrameEvent = IEventParam<Frame>;
-export interface IFrameEvents<T = IFrameEvent> extends IComponentEvents<T> {
-    onAfterLoad?: EventDef<T>;
-}
-export interface IFrame extends IComponentRender {
-    path: string;
-    local?: boolean;
-    override?: object;
-    overrideNamedProps?: IDictionary;
-    cache?: boolean;
-    JSONCache?: boolean | string;
-    cacheDuration?: number;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    type?: string;
-}

package/dist/types/components/zd-frame-page/frame-page.d.ts

@@ -1,14 +0,0 @@
-import { Frame } from '../zd-frame/frame';
-import { IFramePage } from './interfaces';
-export declare class FramePage extends Frame implements IFramePage {
-    /**
-     * Set "NotFound" to the frame
-     */
-    notFoundRoute: string;
-    constructor(props: IFramePage);
-    /**
-     * Triggered before the component is destroyed.
-     */
-    onBeforeDestroy(): void;
-    protected notFoundError(e: unknown): void;
-}

package/dist/types/components/zd-frame-page/interfaces.d.ts

@@ -1,4 +0,0 @@
-import { IFrame } from '../zd-frame/interfaces';
-export interface IFramePage extends IFrame {
-    notFoundRoute?: string;
-}

package/dist/types/components/zd-grid/data-navigator.d.ts

@@ -1,12 +0,0 @@
-import { Direction, IDataNavigator, IGrid, IIterableTable } from './interfaces';
-export declare class DataNavigator implements IDataNavigator {
-    protected iterable: IGrid & IIterableTable;
-    constructor(iterable: IGrid & IIterableTable);
-    navigateDatasource(direction: Direction): void;
-    private navigateFirst;
-    private navigateLast;
-    private navigateInitial;
-    navigatePageDown(): void;
-    navigatePageUp(): void;
-    private navigateCurrentRow;
-}