@zeedhi/common 1.111.1 → 3.0.0

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,22 @@
+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;
+}

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

@@ -0,0 +1,90 @@
+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;
+    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 { Time } from './time';
+import { ITextInput, ITextInputEvents } from '../zd-text-input/interfaces';
+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;
+}

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

@@ -0,0 +1,148 @@
+import { ITime } from './interfaces';
+import { TextInput } from '../zd-text-input/text-input';
+/**
+ * Base class for Time Picker component.
+ */
+export declare class Time extends TextInput implements ITime {
+    /**
+     * Restricts which hours can be selected.
+     */
+    allowedHours?: any[];
+    /**
+     * Restricts which minutes can be selected.
+     */
+    allowedMinutes?: any[];
+    /**
+     * Restricts which seconds can be selected.
+     */
+    allowedSeconds?: any[];
+    /**
+     * Input auto complete.
+     */
+    autofill: boolean;
+    /**
+     * Defines the format of a time displayed in picker. Available options are ampm and 24hr.
+     */
+    timeFormat: string;
+    /**
+     * Forces 100% width.
+     */
+    fullWidth: boolean;
+    /**
+     * Maximum allowed time.
+     */
+    maxTime: string;
+    /**
+     * Minimum allowed time.
+     */
+    minTime: string;
+    /**
+     * Allows changing hour/minute with mouse scroll.
+     */
+    scrollable: boolean;
+    /**
+     * Shows the time picker.
+     */
+    showTimePicker: boolean;
+    /**
+     * Toggles the use of seconds in picker.
+     */
+    useSeconds: boolean;
+    /**
+     * Width of the picker.
+     */
+    width: number | string;
+    protected formatterFn: (...args: any) => any;
+    protected parserFn: (...args: any) => any;
+    private isoFormatValue;
+    private valueFormatInternal;
+    private displayFormatInternal;
+    /**
+     * Defines the time input format.
+     */
+    inputFormat?: string;
+    /**
+     * True when displayValue is valid
+     */
+    protected isDisplayValid: boolean;
+    protected initialMask?: string;
+    protected isSimpleDisplay: boolean;
+    protected timeError: boolean;
+    /**
+     * Create a new Time Picker.
+     * @param props Time properties
+     */
+    constructor(props: ITime);
+    private getFormat;
+    get displayFormat(): string;
+    set displayFormat(value: string);
+    get valueFormat(): string;
+    set valueFormat(value: string);
+    private get isoFormat();
+    private getInitialMask;
+    formatter(value: string): string;
+    parser(value: string): any;
+    /**
+     * Triggered when date is clicked.
+     * @param event
+     * @param element
+     */
+    selectTime(time: string, event?: Event, element?: any): void;
+    get displayValue(): string;
+    set displayValue(newValue: string);
+    /**
+     * Assign the updated mask to mask property
+     */
+    updateMask(): any;
+    /**
+     * Gets the updated masked, based on displayFormat if the initial mask is undefined
+     */
+    protected getUpdatedMask(): string;
+    protected maskFormat(format: string): string;
+    setTimeValue(displayValue: string): void;
+    isValidTime(value: string, format: string | undefined, strict?: boolean): boolean;
+    get isoValue(): string;
+    set isoValue(newValue: string);
+    formatISOTimeValue(value: string): string;
+    parseISOTimeValue(value: string): any;
+    /**
+   * Checks if a time format is simple.
+   * Simple time formats are the ones that consists only of 'HH', 'mm', 'mm' or 'YYYY', and mask delimiters
+   * @param format The format to be checked
+   * @returns true if it is simple, false otherwise
+   */
+    protected isSimpleFormat(format: string): boolean;
+    timeValidation(): boolean | string;
+    timeAllowedValidation(): boolean | string;
+    click(event?: Event, element?: any): void;
+    blur(event: Event, element: any): void;
+    focus(event: Event, element: any): void;
+    /**
+     * Add date mask
+     */
+    protected addTimeMask(): void;
+    /**
+     * Removes the component mask if value is valid
+     */
+    protected removeTimeMask(): void;
+    /**
+     * Checks if value is valid according to valueFormat and if displayValue
+     * is true
+     */
+    isFullyValid(value?: string): boolean;
+    /**
+     * Last invalid value passed to formatter
+     */
+    isTimeAllowed(value?: string): boolean;
+    isSameOrAfterMin(value: string): boolean;
+    isSameOrBeforeMax(value: string): boolean;
+    isHourAllowed(value: string): boolean;
+    isMinuteAllowed(value: string): boolean;
+    isSecondAllowed(value: string): boolean;
+    clear(): void;
+    /**
+     * Converts a date format to a mask
+     */
+    private toMask;
+    getMask(): string;
+}

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

@@ -0,0 +1,6 @@
+import { IInput } from '../zd-input/interfaces';
+export type StateType = boolean | string | number | null | object;
+export interface IToggleable extends IInput {
+    falseValue?: StateType;
+    trueValue?: StateType;
+}

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

@@ -0,0 +1,21 @@
+import { Input } from '../zd-input/input';
+import { IToggleable, StateType } from './interfaces';
+/**
+ * Base class for Toggleable inputs.
+ */
+export declare class Toggleable extends Input implements IToggleable {
+    /**
+     * Value for falsy state
+     */
+    falseValue: StateType;
+    /**
+     * Value for truthy state
+     */
+    trueValue: StateType;
+    /**
+     * Create a new Toggleable input.
+     * @param props Toggleable properties
+     */
+    constructor(props: IToggleable);
+    toggleValue(): void;
+}

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

@@ -0,0 +1,18 @@
+import { IEventParam } from '@zeedhi/core';
+import { IComponentRender } from '../zd-component/interfaces';
+import { Tooltip } from './tooltip';
+export type ITooltipEvent = IEventParam<Tooltip>;
+export interface ITooltip extends IComponentRender {
+    bottom?: boolean;
+    disabled?: boolean;
+    label?: string;
+    left?: boolean;
+    maxWidth?: number | string;
+    minWidth?: number | string;
+    nudge?: number | string;
+    openOnClick?: boolean;
+    openOnFocus?: boolean;
+    openOnHover?: boolean;
+    right?: boolean;
+    top?: boolean;
+}

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

@@ -0,0 +1,57 @@
+import { ComponentRender } from '../zd-component/component-render';
+import { ITooltip } from './interfaces';
+/**
+ * Base class for Tooltip component.
+ */
+export declare class Tooltip extends ComponentRender implements ITooltip {
+    /**
+     * Aligns the component towards the bottom
+     */
+    bottom: boolean;
+    /**
+     * Disables the tooltip
+     */
+    disabled: boolean;
+    label: string;
+    /**
+     * Aligns the component towards the left
+     */
+    left: boolean;
+    /**
+     * Sets the maximum width for the content
+     */
+    maxWidth?: number | string;
+    /**
+     * Sets the minimum width for the content
+     */
+    minWidth?: number | string;
+    /**
+     * Nudge the content
+     */
+    nudge: number | string;
+    /**
+     * Open the tooltip on activator click
+     */
+    openOnClick: boolean;
+    /**
+     * Open the tooltip on activator focus
+     */
+    openOnFocus: boolean;
+    /**
+     * Open the tooltip on activator hover
+     */
+    openOnHover: boolean;
+    /**
+     * Nudge the content to the top
+     */
+    right: boolean;
+    /**
+     * Nudge the content to the top
+     */
+    top: boolean;
+    /**
+     * Create a new Tooltip
+     * @param props Tooltip definition
+     */
+    constructor(props: ITooltip);
+}