@zeedhi/common 1.121.0 → 1.122.0

package/dist/types/components/zd-svg-map/svg-map.d.ts

@@ -0,0 +1,35 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { ISvgMap, ISvgMapEvents, TooltipData } from './interfaces';
+/**
+ * Base class for SvgMap component.
+ */
+export declare class SvgMap extends ComponentRender implements ISvgMap {
+    areaColor?: string;
+    areaHoverColor?: string;
+    areaSelectColor?: string;
+    events: ISvgMapEvents;
+    height: string | number;
+    multiple: boolean;
+    width: string | number;
+    svgContent: string;
+    svgContainer: any;
+    tooltipData?: TooltipData | undefined;
+    loading?: boolean;
+    keyColumn: string;
+    private mapAreas;
+    private srcValue;
+    private selectedAreaValue;
+    protected viewBeforeUpdate?: () => void;
+    protected viewUpdate?: () => void;
+    constructor(props: ISvgMap);
+    get src(): string;
+    set src(value: string);
+    get selectedArea(): string | string[];
+    set selectedArea(value: string | string[]);
+    private updateSelectedArea;
+    private getSVG;
+    setViewBeforeUpdate(beforeUpdate: () => void): void;
+    setViewUpdate(update: () => void): void;
+    updateSVGContainer(): void;
+    mapClick(element: SVGElement): void;
+}

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

@@ -0,0 +1,7 @@
+import { IEventParam } from '@zeedhi/core';
+import { IToggleable } from '../zd-toggleable/interfaces';
+import { Switch } from './switch';
+export type ISwitchEvent = IEventParam<Switch>;
+export interface ISwitch extends IToggleable {
+    inset?: boolean;
+}

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

@@ -0,0 +1,16 @@
+import { Toggleable } from '../zd-toggleable/toggleable';
+import { ISwitch } from './interfaces';
+/**
+ * Base class for Switch component.
+ */
+export declare class Switch extends Toggleable implements ISwitch {
+    /**
+     * It can make switch render in inset mode.
+     */
+    inset: boolean;
+    /**
+     * Create a new Switch.
+     * @param props Switch properties
+     */
+    constructor(props: ISwitch);
+}

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

@@ -0,0 +1,25 @@
+import { IEventParam } from '@zeedhi/core';
+import { IIterable, IIterableProps } from '../zd-iterable/interfaces';
+import { Table } from './table';
+export type ITabletEvent = IEventParam<Table>;
+export interface ITableProps extends IIterableProps {
+    caption?: ITableCaption;
+    showTableHead?: boolean;
+    fillWidth?: boolean;
+    height?: number | string;
+    maxHeight?: number | string;
+    minHeight?: number | string;
+}
+export interface ITable extends IIterable {
+    caption: ITableCaption;
+    showTableHead: boolean;
+    fillWidth: boolean;
+    height: number | string;
+    maxHeight: number | string;
+    minHeight: number | string;
+}
+export interface ITableCaption {
+    label?: string;
+    isVisible?: boolean;
+    align?: string;
+}

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

@@ -0,0 +1,42 @@
+import { Column } from '../zd-iterable/column';
+import { IColumn } from '../zd-iterable/interfaces';
+import { Iterable } from '../zd-iterable/iterable';
+import { ITable, ITableCaption, ITableProps } from './interfaces';
+/**
+ * Base class for Table component.
+ */
+export declare class Table extends Iterable implements ITable {
+    /**
+     * Defines table caption.
+     */
+    caption: ITableCaption;
+    /**
+     * Controls table width.
+     */
+    fillWidth: boolean;
+    /**
+     * Controls table head visibility.
+     */
+    showTableHead: boolean;
+    /**
+     * 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;
+    /**
+     * Creates a new Table.
+     * @param table Table properties
+     */
+    constructor(props: ITableProps);
+    createColumn(column: IColumn): Column;
+}

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

@@ -0,0 +1,40 @@
+import { IEventParam } from '@zeedhi/core';
+import { EventDef, IComponent, IComponentEvents, IComponentRender } from '../zd-component/interfaces';
+import { Tabs } from './tabs';
+export type ITabsEventParam = IEventParam<Tabs>;
+export interface ITabsBeforeChangeEventParam extends ITabsEventParam {
+    tabIndex: number;
+}
+export interface ITabsEvents<T = ITabsEventParam | ITabsBeforeChangeEventParam | IEventParam<any>> extends IComponentEvents<T> {
+    change?: EventDef<T>;
+    beforeChange?: EventDef<T>;
+}
+export interface ITab extends IComponent {
+    tabTitle: string;
+    disabled?: boolean;
+    lazyLoad?: boolean;
+    color?: string;
+    dense?: boolean;
+    direction?: 'horizontal' | 'vertical';
+    fixed?: boolean;
+    iconName?: string;
+    rounded?: string | number | boolean;
+    selectedClass?: string;
+    value?: any;
+    variant?: 'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain';
+    width?: string | number;
+}
+export interface ITabs extends IComponentRender {
+    activeTab?: number;
+    tabs?: ITab[];
+    height?: number | string;
+    maxHeight?: number | string;
+    minHeight?: number | string;
+    color?: string;
+    backgroudColor?: string;
+    dense?: boolean;
+    direction?: 'horizontal' | 'vertical';
+    disabled?: boolean;
+    grow?: boolean;
+    max?: number;
+}

package/dist/types/components/zd-tabs/tab-not-found.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Tab not found error
+ */
+export declare class TabNotFoundError extends Error {
+    /**
+     * Create a new Error.
+     * @param name Tab name
+     * @param parentName Tab parent name
+     */
+    constructor(name: string, parentName: string);
+}

package/dist/types/components/zd-tabs/tab.d.ts

@@ -0,0 +1,57 @@
+import { Component } from '../zd-component/component';
+import { ITab } from './interfaces';
+/**
+ * Base class for Tab component.
+ */
+export declare class Tab extends Component implements ITab {
+    disabled: boolean;
+    tabTitle: string;
+    lazyLoad: boolean;
+    /**
+     * Applies specified color to the control
+     */
+    color: string;
+    /**
+     * Adjusts the vertical height used by the component.
+     */
+    dense: boolean;
+    /**
+     * Changes the direction of the tabs. Can be either horizontal or vertical.
+     */
+    direction: 'horizontal' | 'vertical';
+    /**
+     * Forces component to take up all available space up to
+     * their maximum width (300px), and centers it.
+     */
+    fixed: boolean;
+    /**
+     * Enable and show the icon with respective icon name.
+     */
+    iconName?: string;
+    /**
+     * Designates the border-radius applied to the component.
+     */
+    rounded: string | number | boolean;
+    /**
+     * Configure the active CSS class applied when an item is selected.
+     */
+    selectedClass: string;
+    /**
+     * The value used when the component is selected in a group.
+     * If not provided, a unique ID will be used.
+     */
+    value: any;
+    /**
+     * Applies a distinct style to the component
+     */
+    variant: 'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain';
+    /**
+     * Sets the width for the component.
+     */
+    width?: string | number;
+    /**
+     * Create a new Tab.
+     * @param props Tab properties
+     */
+    constructor(props: ITab);
+}

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

@@ -0,0 +1,86 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { ITabs, ITabsEvents } from './interfaces';
+import { Tab } from './tab';
+/**
+ * Base class for Tabs component.
+ */
+export declare class Tabs extends ComponentRender implements ITabs {
+    activeTabValue: number;
+    events: ITabsEvents;
+    tabs: Tab[];
+    /**
+     * 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;
+    /**
+     * Applies specified color to the selected tabs.
+     */
+    color?: string | undefined;
+    /**
+     * Applies specified color to the control’s background.
+     */
+    backgroudColor?: string;
+    /**
+     * Adjusts the vertical height used by the component.
+     */
+    dense?: boolean;
+    /**
+     * Changes the direction of the tabs. Can be either horizontal or vertical
+     */
+    direction?: 'horizontal' | 'vertical';
+    /**
+     * Puts all children components into a disabled state
+     */
+    disabled?: boolean;
+    /**
+     * Force v-tab’s to take up all available space
+     */
+    grow?: boolean;
+    /**
+     * Sets a maximum number of selections that can be made.
+     */
+    max?: number;
+    /**
+     * Create a new Tabs.
+     * @param props Tabs properties
+     */
+    constructor(props: ITabs);
+    get activeTab(): number;
+    set activeTab(index: number);
+    private getTabs;
+    getTab(name: string): Tab;
+    /**
+     * Method for navigating to the next tab
+     * @param loop Defines if want a loop navigation
+     */
+    nextTab(loop?: boolean): void;
+    /**
+     * Method for navigating to the previous tab
+     * @param loop Defines if want a loop navigation
+     */
+    previousTab(loop?: boolean): void;
+    /**
+     * Triggered before tab is change.
+     * @param event DOM event
+     * @param index Tab index
+     * @param element Tabs element
+     */
+    beforeChange(event?: Event, index?: number, element?: any): void;
+    /**
+     * Triggered when active tab changes
+     * @param event DOM event
+     * @param element Tabs element
+     */
+    change(event?: Event, element?: any): void;
+}

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

@@ -0,0 +1,7 @@
+import { IEventParam } from '@zeedhi/core';
+import { IComponentRender } from '../zd-component/interfaces';
+import { Tag } from './tag';
+export type ITagEvent = IEventParam<Tag>;
+export interface ITag extends IComponentRender {
+    tag: string;
+}

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

@@ -0,0 +1,13 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { ITag } from './interfaces';
+/**
+ * Base class for Tag component.
+ */
+export declare class Tag extends ComponentRender implements ITag {
+    tag: string;
+    /**
+     * Creates a new Tag.
+     * @param props Tag properties
+     */
+    constructor(props: ITag);
+}

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

@@ -0,0 +1,9 @@
+import { IEventParam } from '@zeedhi/core';
+import { IComponentRender } from '../zd-component/interfaces';
+import { Text } from './text';
+export type ITextEvent = IEventParam<Text>;
+export interface IText extends IComponentRender {
+    tag?: string;
+    text: string | string[];
+    compile?: boolean;
+}

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

@@ -0,0 +1,8 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { IText } from './interfaces';
+export declare class Text extends ComponentRender implements IText {
+    tag?: string | undefined;
+    text: string | string[];
+    compile: boolean;
+    constructor(props: IText);
+}

package/dist/types/components/zd-text-input/interfaces.d.ts

@@ -0,0 +1,23 @@
+import { IEvent, IEventParam } from '@zeedhi/core';
+import { IInput, IInputEvents } from '../zd-input/interfaces';
+import { TextInput } from './text-input';
+export type ITextInputEvent = IEventParam<TextInput>;
+export interface ITextInputEvents<T = IEventParam<any>> extends IInputEvents<T> {
+    appendIconClick?: IEvent<T> | string;
+    appendOuterIconClick?: IEvent<T> | string;
+    prependOuterIconClick?: IEvent<T> | string;
+    prependIconClick?: IEvent<T> | string;
+}
+export interface ITextInput extends IInput {
+    appendIcon?: string;
+    appendOuterIcon?: string;
+    events?: ITextInputEvents;
+    prependIcon?: string;
+    prependOuterIcon?: string;
+    type?: string;
+    prefix?: string;
+    suffix?: string;
+    valueWithPrefix?: boolean;
+    valueWithSuffix?: boolean;
+    inputMode?: string;
+}

package/dist/types/components/zd-text-input/text-input.d.ts

@@ -0,0 +1,91 @@
+import { Input } from '../zd-input/input';
+import { ITextInput } from './interfaces';
+/**
+ * Base class for Text component.
+ */
+export declare class TextInput extends Input implements ITextInput {
+    /**
+     * Appends an icon inside text input component.
+     */
+    appendIcon: string;
+    /**
+     * Appends an icon outside text input component.
+     */
+    appendOuterIcon: string;
+    /**
+     * Displays a prefix text inside text input component. Overrides prependIcon prop.
+     */
+    prefix: string;
+    /**
+     * Prepends an icon inside text input component.
+     */
+    prependIcon: string;
+    /**
+     * Prepends an icon outside text input component.
+     */
+    prependOuterIcon: string;
+    /**
+     * Displays a suffix text inside text input component. Overrides appendIcon prop.
+     */
+    suffix: string;
+    /**
+     * Sets input type.
+     */
+    type: string;
+    /**
+     * Defines text input value should concat the prefix text.
+     */
+    valueWithPrefix: boolean;
+    /**
+     * Defines text input value should concat the suffix text.
+     */
+    valueWithSuffix: boolean;
+    inputMode?: string | undefined;
+    protected formatterFn: (...args: any) => any;
+    protected parserFn: (...args: any) => any;
+    /**
+     * Create a new TextInput.
+     * @param props TextInput properties
+     */
+    constructor(props: ITextInput);
+    onCreated(): void;
+    private addKeyMap;
+    private callSingleIconEvent;
+    /**
+     * Retrieves a formatted value without valueSuffix and with mask.
+     * @param value Text value
+     * @returns Text formatted value
+     */
+    formatter(value: string): any;
+    /**
+     * Retrieves a parsed value with prefix and suffix if it is needed and without mask.
+     * @param value Text value
+     * @returns Text parsed value
+     */
+    parser(value: string): any;
+    /**
+     * Triggered when the appended icon is clicked.
+     * @param event DOM event
+     * @param element Text input
+     */
+    appendIconClick(event: Event, element: any): void;
+    /**
+     * Triggered when the appended outer icon is clicked.
+     * @param event DOM event
+     * @param element Text input
+     */
+    appendOuterIconClick(event: Event, element: any): void;
+    /**
+     * Triggered when the prepended icon is clicked.
+     * @param event DOM event
+     * @param element Text input
+     */
+    prependIconClick(event: Event, element: any): void;
+    /**
+     * Triggered when the prepended outer icon is clicked.
+     * @param event DOM event
+     * @param element Text input
+     */
+    prependOuterIconClick(event: Event, element: any): void;
+    getMask(): any;
+}

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

@@ -0,0 +1,21 @@
+import { IEventParam } from '@zeedhi/core';
+import { ITextInput } from '../zd-text-input/interfaces';
+import { Textarea } from './textarea';
+export type ITextareaEvent = IEventParam<Textarea>;
+export interface ITextarea extends ITextInput {
+    autoGrow?: boolean;
+    backgroundColor?: string;
+    clearIcon?: string;
+    counter?: boolean | number | string;
+    filled?: boolean;
+    loading?: boolean | string;
+    resize?: boolean;
+    reverse?: boolean;
+    rounded?: boolean;
+    rowHeight?: number | string;
+    rows?: number | string;
+    height?: number | string;
+    maxHeight?: number | string;
+    minHeight?: number | string;
+    fillHeight?: boolean;
+}

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

@@ -0,0 +1,71 @@
+import { TextInput } from '../zd-text-input/text-input';
+import { ITextarea } from './interfaces';
+/**
+ * Base class for Textarea component.
+ */
+export declare class Textarea extends TextInput implements ITextarea {
+    /**
+     * Automatically grow the textarea depending on amount of text.
+     */
+    autoGrow: boolean;
+    /**
+     * Changes the background-color of the input.
+     */
+    backgroundColor: string;
+    /**
+     * Applied when using clearable and the input is dirty.
+     */
+    clearIcon: string;
+    /**
+     * Creates counter for input length; if no number is specified, it defaults to 25. Does not apply any validation.
+     */
+    counter?: boolean | string | number;
+    /**
+     * Applies the alternate filled input style.
+     */
+    filled: boolean;
+    /**
+     * Displays linear progress bar.
+     */
+    loading: boolean | string;
+    /**
+     * Remove resize handle.
+     */
+    resize: boolean;
+    /**
+     * Adds a border radius to the input.
+     */
+    rounded: boolean;
+    /**
+     * Height value for each row. Requires the use of the auto-grow prop.
+     */
+    rowHeight: number | string;
+    /**
+     * Default row count.
+     */
+    rows: number | 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;
+    /**
+     * Set component height to fill all space available
+     */
+    fillHeight: boolean;
+    /**
+     * Create a new Textarea.
+     * @param props Textarea properties
+     */
+    constructor(props: ITextarea);
+}

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

@@ -0,0 +1,22 @@
+import { IEventParam } from '@zeedhi/core';
+import { ITextInput, ITextInputEvents } from '../zd-text-input/interfaces';
+import { Time } from './time';
+export type ITimeEvent = IEventParam<Time>;
+export type ITimeEvents = ITextInputEvents<ITimeEvent>;
+export interface ITime extends ITextInput {
+    allowedHours?: any[];
+    allowedMinutes?: any[];
+    allowedSeconds?: any[];
+    displayValue?: string;
+    displayFormat?: string;
+    fullWidth?: boolean;
+    maxTime?: string;
+    minTime?: string;
+    events?: ITimeEvents;
+    scrollable?: boolean;
+    showTimePicker?: boolean;
+    timeFormat?: string;
+    useSeconds?: boolean;
+    valueFormat?: string;
+    inputFormat?: string;
+}

package/dist/types/components/zd-time/time-format-selector.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Selects the time format by the rule:
+ * non-common format > common format
+ * and if the format is a common format, it will be overriden by timeFormat
+ */
+export declare class TimeFormatSelector {
+    getFormat(format: string, timeFormat: string, useSeconds: boolean): any;
+}