@zeedhi/common 1.121.0 → 1.123.0

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

@@ -0,0 +1,54 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IComponentRender } from '../zd-component/interfaces';
+import { ILogin } from './interfaces';
+/**
+ * Base class for Login component.
+ */
+export declare class Login extends ComponentRender implements ILogin {
+    /**
+     * Value set int the css property background.
+     */
+    backgroundStyle: string;
+    /**
+     * An area in the bottom of the card to display a link.
+     */
+    bottomLink: IComponentRender[];
+    /**
+     * Set card width.
+     */
+    cardWidth: string | number;
+    /**
+     * Applies specified color to the control.
+     * It can be the name of material or css color in hexa.
+     */
+    color: string;
+    /**
+     * Card position orientation.
+     */
+    layout: string;
+    /**
+     * Logo displayed in the top of the card.
+     */
+    logo: string;
+    /**
+     * Text displayed under the logo.
+     */
+    logoMessage: string;
+    /**
+     * Image displayed out of the card.
+     */
+    poweredByImage: string;
+    /**
+     * Image displayed in the card.
+     */
+    poweredByImageCard: string;
+    /**
+     * If form is flat
+     */
+    flatForm: boolean;
+    /**
+     * Buttons displayed in the bottom of the card.
+     */
+    socialLogin: IComponentRender[];
+    constructor(props: ILogin);
+}

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

@@ -0,0 +1,5 @@
+import { IComponentRender } from '../zd-component/interfaces';
+export interface IMain extends IComponentRender {
+    scrollable?: boolean;
+    tag?: string;
+}

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

@@ -0,0 +1,7 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IMain } from './interfaces';
+export declare class Main extends ComponentRender implements IMain {
+    scrollable: boolean;
+    tag?: string;
+    constructor(props: IMain);
+}

package/dist/types/components/zd-master-detail/detail-not-found.d.ts

@@ -0,0 +1,7 @@
+import { ZeedhiCommonError } from '../../error/zeedhi-error';
+/**
+ * Detail not found error
+ */
+export declare class DetailNotFoundError extends ZeedhiCommonError {
+    constructor(name: string);
+}

package/dist/types/components/zd-master-detail/interfaces.d.ts

@@ -0,0 +1,10 @@
+import { IDictionary } from '@zeedhi/core';
+import { IComponentRender } from '../zd-component/interfaces';
+export interface IMasterDetail extends IComponentRender {
+    config?: IDictionary<any>;
+    lazyRelate?: boolean;
+    height?: number | string;
+    maxHeight?: number | string;
+    minHeight?: number | string;
+    fillHeight?: boolean;
+}

package/dist/types/components/zd-master-detail/master-detail.d.ts

@@ -0,0 +1,18 @@
+import { IDictionary } from '@zeedhi/core';
+import { ComponentRender } from '../zd-component/component-render';
+import { IMasterDetail } from './interfaces';
+/**
+ * Base class for Master Detail component.
+ */
+export declare class MasterDetail extends ComponentRender implements IMasterDetail {
+    config: IDictionary<any>;
+    lazyRelate: boolean;
+    height: string | number;
+    minHeight: string | number;
+    maxHeight: string | number;
+    fillHeight: boolean;
+    constructor(props: IMasterDetail);
+    private createRelationship;
+    createRelationships(): void;
+    onMounted(element: any): void;
+}

package/dist/types/components/zd-master-detail/master-not-found.d.ts

@@ -0,0 +1,7 @@
+import { ZeedhiCommonError } from '../../error/zeedhi-error';
+/**
+ * Master not found error
+ */
+export declare class MasterNotFoundError extends ZeedhiCommonError {
+    constructor(name: string);
+}

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

@@ -0,0 +1,68 @@
+import { IEventParam } from '@zeedhi/core';
+import { IButton } from '../zd-button/interfaces';
+import { IComponentEvents, IComponentRender } from '../zd-component/interfaces';
+import { MenuLink } from './menu-link';
+export type IMenuLinkEvent = IEventParam<MenuLink>;
+export type IMenuLinkEvents = IComponentEvents<IMenuLinkEvent>;
+/**
+ * Interface for menu component
+ */
+export interface IMenu extends IComponentRender {
+    app?: boolean | string;
+    absolute?: boolean | string;
+    clipped?: boolean | string;
+    dense?: boolean | string;
+    fixed?: boolean | string;
+    floating?: boolean | string;
+    mini?: boolean | string;
+    miniWidth?: number | string;
+    temporary?: boolean | string;
+    items?: IMenuItem[];
+    itemsUrl?: string;
+    isLocal?: boolean | string;
+    closeToMini?: boolean | string;
+    showSearch?: boolean | string;
+    opened?: boolean | string;
+    topSlot?: IComponentRender[];
+    width?: number | string;
+    mobileBreakpoint?: number | string;
+    cache?: boolean;
+    disableRouteWatcher?: boolean;
+    permanent?: boolean | string;
+}
+/**
+ * Interface for menu itens
+ */
+export interface IMenuItem extends IComponentRender {
+    parentMenu?: IMenu;
+    parentGroup?: IMenuGroup;
+}
+export interface IInteractiveMenuItem {
+    label: string;
+    icon?: string;
+}
+/**
+ * Interface for menu link
+ */
+export interface IMenuLink extends IMenuItem, IInteractiveMenuItem {
+    route: string;
+    events?: IMenuLinkEvents;
+}
+/**
+ * Interface for menu group
+ */
+export interface IMenuGroup extends IMenuItem, IInteractiveMenuItem {
+    items: IMenuItem[];
+    opened?: boolean | string;
+    expandIcon?: string;
+}
+/**
+ * Interface for menu separator
+ */
+export type IMenuSeparator = IMenuItem;
+/**
+ * Interface for menu button
+ */
+export interface IMenuButton extends IButton {
+    menuName: string;
+}

package/dist/types/components/zd-menu/menu-button.d.ts

@@ -0,0 +1,29 @@
+import { Button } from '../zd-button/button';
+import { IMenuButton } from './interfaces';
+/**
+ * Base class for MenuButton component.
+ */
+export declare class MenuButton extends Button implements IMenuButton {
+    /**
+     * Makes the background transparent (equal to text prop in Vuetify).
+     */
+    flat: boolean;
+    /**
+     * Designates the button as icon, round and flat.
+     */
+    icon: boolean;
+    /**
+     * Designates the button icon, that will be rendered before the label.
+     */
+    iconName: string;
+    /**
+     * Name of the menu component controlled by this button.
+     */
+    menuName: string;
+    /**
+     * Creates a new Menu Button.
+     * @param props Menu Button properties
+     */
+    constructor(props: IMenuButton);
+    onCreated(): void;
+}

package/dist/types/components/zd-menu/menu-group.d.ts

@@ -0,0 +1,61 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IMenuGroup, IMenuItem } from './interfaces';
+import { Menu } from './menu';
+/**
+ * Base class for MenuGroup component.
+ */
+export declare class MenuGroup extends ComponentRender implements IMenuGroup {
+    /**
+     * item label
+     */
+    label: string;
+    /**
+     * Item icon
+     */
+    icon: string;
+    /**
+     * Items grouped
+     */
+    items: IMenuItem[];
+    /**
+     * Group state
+     */
+    opened: boolean | string;
+    /**
+     * Menu that contains the item
+     */
+    parentMenu?: Menu;
+    /**
+     * Group that contains the item
+     */
+    parentGroup?: MenuGroup;
+    /**
+     * Expansion icon
+     */
+    expandIcon: string;
+    /**
+     * Creates a new Menu Group.
+     * @param props Menu Group properties
+     */
+    constructor(props: IMenuGroup);
+    /**
+     * @returns item is selected or not
+     */
+    isSelected(): boolean;
+    /**
+     * Open group
+     */
+    open(): void;
+    /**
+     * Close group
+     */
+    close(): void;
+    /**
+     * Event triggered when this item is clicked
+     */
+    click(event?: Event): void;
+    /**
+     * Event triggered when this item is focus
+     */
+    focus(event: Event): void;
+}

package/dist/types/components/zd-menu/menu-link.d.ts

@@ -0,0 +1,50 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IMenuLink, IMenuLinkEvents } from './interfaces';
+import { Menu } from './menu';
+import { MenuGroup } from './menu-group';
+/**
+ * Base class for MenuLink component.
+ */
+export declare class MenuLink extends ComponentRender implements IMenuLink {
+    /**
+     * Item label
+     */
+    label: string;
+    /**
+     * Item events
+     */
+    events: IMenuLinkEvents;
+    /**
+     * Item icon
+     */
+    icon: string;
+    /**
+     * Url to redirect
+     */
+    route: string;
+    /**
+     * Menu that contains the item
+     */
+    parentMenu?: Menu;
+    /**
+     * Group that contains the item
+     */
+    parentGroup?: MenuGroup;
+    /**
+     * Creates a new Menu Link.
+     * @param props Menu Link properties
+     */
+    constructor(props: IMenuLink);
+    /**
+     * Event triggered when this item is clicked
+     */
+    click(event?: Event): void;
+    /**
+     * Event triggered when this item is focus
+     */
+    focus(): void;
+    /**
+     * @returns item is selected or not
+     */
+    isSelected(): boolean;
+}

package/dist/types/components/zd-menu/menu-separator.d.ts

@@ -0,0 +1,7 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IMenuSeparator } from './interfaces';
+/**
+ * Base class for MenuSeparator component.
+ */
+export declare class MenuSeparator extends ComponentRender implements IMenuSeparator {
+}

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

@@ -0,0 +1,199 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IComponentRender } from '../zd-component/interfaces';
+import { IMenu, IMenuItem } from './interfaces';
+/**
+ * Base class for Menu component.
+ */
+export declare class Menu extends ComponentRender implements IMenu {
+    /**
+     * Defines if the menu is an application menu
+     */
+    app: boolean | string;
+    /**
+     * Defines if the menu must be rendered inside an absolute div
+     */
+    absolute: boolean | string;
+    /**
+     * Defines if the menu should rests under the application toolbar
+     */
+    clipped: boolean | string;
+    /**
+     * Applies position: fixed to the menu
+     */
+    fixed: boolean | string;
+    /**
+     * Defines if the menu should have a visible container
+     */
+    floating: boolean | string;
+    /**
+     * Defines if the menu should stay visible regardless of screen size
+     */
+    permanent: boolean | string;
+    /**
+     * Create the menu with smaller items.
+     */
+    dense: boolean | string;
+    /**
+     * Create the menu with condensed width. Only icons and no label.
+     */
+    mini: boolean | string;
+    /**
+     * Defines the width of the menu when in mini state
+     */
+    miniWidth: number | string;
+    /**
+     * Defines if the menu is mini
+     */
+    miniState: boolean;
+    /**
+     * Defines if the menu is temporary. Temporary menu sits over above the application and uses a overlay div.
+     */
+    temporary: boolean | string;
+    /**
+     * Array of menu items
+     */
+    private menuItems;
+    /**
+     * Defines if the close event will turn menu to mini
+     */
+    closeToMini: boolean | string;
+    /**
+     * Defines if the search is shown
+     */
+    showSearch: boolean | string;
+    /**
+     * Defines if items are local
+     */
+    isLocal: boolean | string;
+    /**
+     * Defines if menu is opened
+     */
+    drawer: boolean;
+    /**
+     * Initial opened prop value
+     */
+    openedInitialValue?: boolean;
+    /**
+     * Defines if the mouse is over the menu
+     */
+    mouseOver: boolean;
+    /**
+     * Defines the menu width in pixels
+     */
+    width: number | string;
+    /**
+     * Defines the mobile breakpoint in pixels
+     */
+    mobileBreakpoint: number | string;
+    /**
+     * Array of components to be rendered on the top part of the menu
+     */
+    topSlot: IComponentRender[];
+    /**
+     * Object to store all the routes
+     */
+    private routes;
+    /**
+     * Selected path
+     */
+    private selectedPath;
+    /**
+     * Array of selected items
+     */
+    private selectedItems;
+    /**
+     * Defines the url to get menu items
+     */
+    private menuItemsUrl;
+    private openingMenuTimeout;
+    /** Control toolip for overflown items */
+    showTooltip: boolean;
+    /** Toolip text for overflown items */
+    tooltipText: string;
+    /** Toolip anchor */
+    tooltipAnchor?: HTMLElement;
+    /** Toolip content props */
+    tooltipContentProps?: any;
+    /** Filtered menu items */
+    private filteredMenuItems;
+    /** Search value */
+    private searchValue;
+    /** Store the current item focused */
+    currentItem: IMenuItem | null;
+    cache?: boolean;
+    disableRouteWatcher?: boolean;
+    /**
+     * Creates a new Menu.
+     * @param props Menu properties
+     */
+    constructor(props: IMenu);
+    /**
+     * Defines the url to get menu items
+     */
+    get itemsUrl(): string;
+    set itemsUrl(url: string);
+    /**
+     * Menu items
+     */
+    get items(): IMenuItem[];
+    set items(items: IMenuItem[]);
+    get opened(): boolean;
+    set opened(openedValue: boolean);
+    /**
+     * Get menu items from a given url
+     * @param element Element mounted reference
+     */
+    onMounted(element: any): void;
+    /**
+     * Load the menu metadata
+     * @param url url of the json file
+     */
+    loadMetadata(url: string): Promise<void>;
+    /**
+     * Save all Link routes parent groups
+     */
+    private saveLinkRoutes;
+    /**
+     * Toggle menu
+     */
+    toggleMenu(): void;
+    /**
+     * Close all menu
+     */
+    closeAllMenus(): void;
+    /**
+     * Saves the selected path
+     * @param path Path name
+     */
+    selectPath(path: string): void;
+    /**
+     * Select an item
+     * @param item Menu item
+     */
+    selectItem(items: IMenuItem[]): void;
+    /**
+     * @param item Menu item
+     * @returns Item is selected or not
+     */
+    isSelected(item: IMenuItem): boolean;
+    menuMouseEnter(): void;
+    /**
+     * Open all selected items
+     */
+    openSelectedTree(): void;
+    menuMouseLeave(): void;
+    /**
+     * Responds to Url changes
+     */
+    urlChanged(current: any): void;
+    get search(): string;
+    set search(value: string);
+    clearSearch(): void;
+    /**
+     * Search inside menu items
+     */
+    doSearch(): void;
+    private getAccessorValue;
+    private isItemVisible;
+    private searchItems;
+}

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

@@ -0,0 +1,35 @@
+import { IEventParam } from '@zeedhi/core';
+import { IButton } from '../zd-button/interfaces';
+import { EventDef, IComponent, IComponentEvents } from '../zd-component/interfaces';
+import { Modal } from './modal';
+export type IModalEvent = IEventParam<Modal>;
+export interface IModalEvents<T = IEventParam<any>> extends IComponentEvents<T> {
+    onShow?: EventDef<T>;
+    onHide?: EventDef<T>;
+}
+export interface IModalGrid {
+    cols?: number | string;
+    xs?: number | string;
+    sm?: number | string;
+    md?: number | string;
+    lg?: number | string;
+    xl?: number | string;
+    'offset-xs'?: number | string;
+    'offset-sm'?: number | string;
+    'offset-md'?: number | string;
+    'offset-lg'?: number | string;
+    'offset-xl'?: number | string;
+}
+export interface IModal extends IComponent {
+    title?: string;
+    fullscreen?: boolean;
+    grid?: IModalGrid;
+    persistent?: boolean;
+    draggable?: boolean;
+    dragHandle?: string;
+    escKeydownStop?: boolean;
+    events?: IModalEvents;
+}
+export interface IModalCloseButton extends IButton {
+    modalName: string;
+}

package/dist/types/components/zd-modal/modal-close-button.d.ts

@@ -0,0 +1,28 @@
+import { Button } from '../zd-button/button';
+import { IModalCloseButton } from './interfaces';
+/**
+ * Base class for Modal Close Button component.
+ */
+export declare class ModalCloseButton extends Button implements IModalCloseButton {
+    /**
+     * Name of Modal component to be closed
+     */
+    modalName: string;
+    /**
+     * Makes the background transparent (equal to text prop in Vuetify).
+     */
+    flat: boolean;
+    /**
+     * Designates the button as icon, round and flat.
+     */
+    icon: boolean;
+    /**
+     * Designates the button icon, that will be rendered before the label.
+     */
+    iconName: string;
+    /**
+     * Creates a new modal close button
+     * @param props Modal close button structure
+     */
+    constructor(props: IModalCloseButton);
+}

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

@@ -0,0 +1,53 @@
+import { Component } from '../zd-component/component';
+import { IModal, IModalEvents, IModalGrid } from './interfaces';
+/**
+ * Base class for Modal component.
+ */
+export declare class Modal extends Component implements IModal {
+    /**
+     * Sets the modal's title
+     */
+    title: string;
+    /**
+     * If true the modal will open as fullscreen
+     */
+    fullscreen: boolean;
+    grid: IModalGrid;
+    /**
+     * If true the modal won't close when overlay is clicked
+     */
+    persistent: boolean;
+    /**
+     * Allows modal to be dragged around in the screen
+     */
+    draggable: boolean;
+    /**
+     * Css selector of the drag handle
+     */
+    dragHandle?: string;
+    /**
+     * Set if esc keydown event should to stop propagation
+     */
+    escKeydownStop?: boolean;
+    /**
+     * Defines modal events.
+     */
+    events: IModalEvents;
+    /**
+     * Creates a new modal
+     * @param props Modal structure
+     */
+    constructor(props: IModal);
+    /**
+     * Removes modal from modals collection
+     */
+    destroy(): void;
+    /**
+     * Displays modal
+     */
+    show(): void;
+    /**
+     * Closes modal
+     */
+    hide(): void;
+}

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

@@ -0,0 +1,6 @@
+import { IEventParam } from '@zeedhi/core';
+import { IDateInput } from '../zd-date-input/interfaces';
+import { Month } from './month';
+export type IMonthEvent = IEventParam<Month>;
+export interface IMonth extends IDateInput {
+}

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

@@ -0,0 +1,33 @@
+import { DateInput } from '../zd-date-input/date-input';
+import { IMonth } from './interfaces';
+/**
+ * Base class for Month Picker component.
+ */
+export declare class Month extends DateInput implements IMonth {
+    /**
+     * Defines the month format.
+     */
+    dateFormat: string;
+    /**
+     * Defines the month format displayed.
+     */
+    displayFormat: string;
+    /**
+     * Defines the month input format.
+     */
+    inputFormat?: string;
+    protected isoFormat: string;
+    /**
+     * Determines the type of the view mode - month for month picker.
+     */
+    viewMode: string;
+    protected formatterFn: (...args: any) => any;
+    protected parserFn: (...args: any) => any;
+    /**
+     * Creates a new Month picker.
+     * @param props Month properties
+     */
+    constructor(props: IMonth);
+    blur(event: Event, element: any): void;
+    focus(event: Event, element: any): void;
+}