@zeedhi/common 1.123.0 → 1.124.0

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

@@ -1,152 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { ICard, ICardEvents } from './interfaces';
-/**
- * Base class for Card component.
- */
-export declare class Card extends ComponentRender implements ICard {
-    /**
-     * Configure the active CSS class applied when the link is active
-     */
-    activeClass: string;
-    /**
-     * Setting append prop always appends the relative path to the current path
-     */
-    append: boolean;
-    /**
-     * Applies specified color to the control. It can be the name of material color
-     */
-    color: string;
-    /**
-     * Removes the ability to click or target the component
-     */
-    disabled: boolean;
-    /**
-     * Designates an elevation applied to the card between 0 and 24
-     */
-    elevation?: number | string;
-    /**
-     * Events registered to the card
-     */
-    events: ICardEvents;
-    /**
-     * Removes the card's elevation
-     */
-    flat: boolean;
-    /**
-     * Sets the height for the card.
-     * Possible values for height can be 'auto', '100%', '400px' or 400
-     */
-    height?: number | string;
-    /**
-     * Will apply an elevation of 6dp when hovered
-     */
-    hover: boolean;
-    /**
-     * Designates the component as anchor and applies the href attribute
-     */
-    href?: string;
-    /**
-     * Specifies an image background for the card
-     */
-    img: string;
-    /**
-     * Designates that the card is a link
-     */
-    link: boolean;
-    /**
-     * Sets the maximum height for the card.
-     * Possible values for width can be 'auto', '100%', '400px' or 400
-     */
-    maxHeight: number | string;
-    /**
-     * Sets the maximum width for the card.
-     * Possible values for width can be 'auto', '100%', '400px' or 400
-     */
-    maxWidth: number | string;
-    /**
-     * Sets the minimum height for the card.
-     * Possible values for width can be 'auto', '100%', '400px' or 400
-     */
-    minHeight: number | string;
-    /**
-     * Sets the minimum width for the card.
-     * Possible values for width can be 'auto', '100%', '400px' or 400
-     */
-    minWidth: number | string;
-    /**
-     * Removes card elevation shadow and adds a thin border
-     */
-    outlined: boolean;
-    /**
-     * Specifies a higher default elevation (16dp)
-     */
-    raised: boolean;
-    /**
-     * Apply the ripple effect to show action from a user
-     */
-    ripple: boolean;
-    /**
-     * Removes the component's border-radius
-     */
-    tile: boolean;
-    /**
-     * Designates the component as anchor and applies the router.to attribute
-     */
-    to?: string;
-    /**
-     * Sets the width for the card.
-     * Possible values for width can be 'auto', '100%', '400px' or 400
-     */
-    width?: number | string;
-    /**
-     * Applies border style to component
-     */
-    border: string | number | boolean;
-    /**
-     * Adjusts the vertical height of the component
-     * Possible values: 'default', 'comfortable' and 'compact'
-     */
-    density: 'default' | 'comfortable' | 'compact';
-    /**
-     * Displays the loading progress bar
-     */
-    loading: string | boolean;
-    /**
-     * Defines the position of the component.
-     * Possible values: 'relative' | 'absolute' | 'static' | 'fixed' | 'sticky'
-     */
-    position?: 'relative' | 'absolute' | 'static' | 'fixed' | 'sticky';
-    /**
-     * Defines if the component will call router.replace() or router.push()
-     */
-    replace: boolean;
-    /**
-     * Applies a large border radius on the button
-     */
-    round: string | number | boolean;
-    /**
-     * Defines card subtitle
-     */
-    subtitle?: string;
-    /**
-     * Root element tag
-     */
-    tag?: string;
-    /**
-     * Defines card text
-     */
-    text?: string;
-    /**
-     * Defines card title
-     */
-    title?: string;
-    /**
-     * Applies style to component
-     */
-    variant?: 'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain';
-    /**
-     * Creates a new Card.
-     * @param props Card properties
-     */
-    constructor(props: ICard);
-}

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

@@ -1,40 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Card } from './card';
-export type ICardEvent = IEventParam<Card>;
-export type ICardEvents = IComponentEvents<ICardEvent>;
-export interface ICard extends IComponentRender {
-    activeClass?: string;
-    append?: boolean;
-    color?: string;
-    elevation?: number | string;
-    events?: ICardEvents;
-    disabled?: boolean;
-    flat?: boolean;
-    hover?: boolean;
-    href?: string;
-    img?: string;
-    link?: boolean;
-    outlined?: boolean;
-    raised?: boolean;
-    ripple?: boolean;
-    tile?: boolean;
-    to?: string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    border?: string | number | boolean;
-    density?: 'default' | 'comfortable' | 'compact';
-    loading?: boolean | string;
-    position?: 'relative' | 'absolute' | 'static' | 'fixed' | 'sticky';
-    replace?: boolean;
-    round?: string | number | boolean;
-    subtitle?: string;
-    tag?: string;
-    text?: string;
-    title?: string;
-    variant?: 'text' | 'flat' | 'elevated' | 'tonal' | 'outlined' | 'plain';
-}

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

@@ -1,163 +0,0 @@
-import { IButton } from '../zd-button/interfaces';
-import { ComponentRender } from '../zd-component/component-render';
-import { ICarousel, ICarouselEvents, ISlideData } from './interfaces';
-/**
- * Base class for Carousel component.
- */
-export declare class Carousel extends ComponentRender implements ICarousel {
-    /**
-     * Configures the carousel to play automatically
-     */
-    autoPlay: boolean;
-    /**
-     * Configures the carousel to show buttons outside the slides area
-     */
-    buttonsOutside: boolean;
-    /**
-     * Displays the carousel items always in the center (only when using
-     * a non-integer number in slidesPerView, like 1.5)
-     */
-    center: boolean;
-    /**
-     * Current slide being displayed
-     */
-    currentSlide: number;
-    /**
-     * Events registered to the carousel
-     */
-    events: ICarouselEvents;
-    /**
-     * Displays the pagination as a fraction in the following format: currentSlide/slidesCount.
-     * Only works when <code>showPagination</code> property is true
-     */
-    fractionPagination: boolean;
-    /**
-     * Sets the carousel height. Example values: 'auto', '100%', '400px',
-     * '30em', '400', 400. Values without measurement unit will be notated in pixels by default
-     */
-    height: number | string;
-    /**
-     * Sets the carousel max height. Example values: 'auto', '100%', '400px',
-     * '30em', '400', 400. Values without measurement unit will be notated in pixels by default
-     */
-    maxHeight: number | string;
-    /**
-     * Sets the carousel min height. Example values: 'auto', '100%', '400px',
-     * '30em', '400', 400. Values without measurement unit will be notated in pixels by default
-     */
-    minHeight: number | string;
-    /**
-     * Set component height to fill all space available
-     */
-    fillHeight: boolean;
-    /**
-     * Configures the carousel as infinite (the slide after the last one is the first slide, and vice-versa)
-     */
-    infiniteScroll: boolean;
-    /**
-     * Configures the carousel's initial slide
-     */
-    initialSlide: number;
-    /**
-     * If autoPlay is enabled, sets the time duration of each slide in milliseconds
-     */
-    interval: number;
-    /**
-     * Allows controlling the carousel using the keyboard arrow keys
-     */
-    keysControl: boolean;
-    /**
-     * Allows controlling the carousel using mouse drag
-     */
-    mouseControl: boolean;
-    /**
-     * Displays the pagination background
-     */
-    paginationBackground: boolean;
-    /**
-     * If autoPlay is enabled, it will pause on mouse hover
-     */
-    pauseOnHover: boolean;
-    /**
-     * Show the navigation arrows.
-     */
-    showArrows: boolean;
-    /**
-     * The navigation arrows will be shown only on mouse hover.
-     * Only works when <code>showArrows</code> property is true
-     */
-    showArrowsOnHover: boolean;
-    /**
-     * Show the carousel pagination menu
-     */
-    showPagination: boolean;
-    /**
-     * Show a progress bar that fills as the carousel approaches the last slide
-     */
-    showProgress: boolean;
-    /**
-     * Css class to be added to slides
-     */
-    slideCssClass: string;
-    /**
-     * Number of slides to be shown for each view (non-integer numbers are allowed)
-     */
-    slidesPerView: number;
-    /**
-     * Number of slides to be slided
-     */
-    slidesToSlide: number;
-    /**
-     * Allows controlling the carousel using touch for mobile
-     */
-    touchControl: boolean;
-    /**
-     * Duration of the slide transition in milliseconds
-     */
-    transitionDuration: number;
-    /**
-     * Allows controlling the carousel using the mouse wheel
-     */
-    wheelControl: boolean;
-    /**
-     * Carousel's right side button.
-     */
-    nextButton: IButton;
-    /**
-     * Carousel's left side button
-     */
-    prevButton: IButton;
-    /**
-     * Creates a new Carousel
-     * @param props Carousel properties
-     */
-    constructor(props: ICarousel);
-    /**
-     * Slides the carousel to the defined index
-     * @param index Index of the slide to be slided to
-     */
-    slideTo(index: number): void;
-    /**
-     * Slides to the next slide
-     */
-    slideNext(): void;
-    /**
-     * Slides to the previous slide
-     */
-    slidePrev(): void;
-    /**
-     * Event triggered before the current slide changes
-     * @param event Event that triggered the beforeSlide event
-     * @param element Carousel element
-     * @param slideData Data related to the beforeSlide event
-     */
-    beforeSlide(element: any, slideData: ISlideData, event?: Event): void;
-    /**
-     * Event triggered when the current slide changes.
-     * @param event Event that triggered the slide event
-     * @param element Carousel element
-     * @param slideData Data related to the slide event
-     */
-    slide(element: any, slideData: ISlideData, event?: Event): void;
-    private changeDefaultButtonName;
-}

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

@@ -1,49 +0,0 @@
-import { IButton } from '../zd-button/interfaces';
-import { IComponentEvents, IComponentRender } from '../zd-component/interfaces';
-import { Carousel } from './carousel';
-export interface ISlideData {
-    currentSlide: number;
-    slideFrom?: number;
-    slideTo?: number;
-}
-export interface ICarouselEventParam {
-    component: Carousel;
-    event?: Event | undefined;
-    element?: any;
-    slideData?: ISlideData;
-}
-export interface ICarouselEvents extends IComponentEvents<ICarouselEventParam> {
-    beforeSlide?: (data: ICarouselEventParam) => void;
-    slide?: (data: ICarouselEventParam) => void;
-}
-export interface ICarousel extends IComponentRender {
-    autoPlay?: boolean;
-    buttonsOutside?: boolean;
-    center?: boolean;
-    currentSlide?: number;
-    infiniteScroll?: boolean;
-    initialSlide?: number;
-    interval?: number;
-    keysControl?: boolean;
-    mouseControl?: boolean;
-    nextButton?: IButton;
-    fractionPagination?: boolean;
-    paginationBackground?: boolean;
-    pauseOnHover?: boolean;
-    prevButton?: IButton;
-    showArrowsOnHover?: boolean;
-    showArrows?: boolean;
-    showPagination?: boolean;
-    showProgress?: boolean;
-    slideCssClass?: string;
-    slidesPerView?: number;
-    slidesToSlide?: number;
-    touchControl?: boolean;
-    transitionDuration?: number;
-    wheelControl?: boolean;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    fillHeight?: boolean;
-    events?: ICarouselEvents;
-}

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

@@ -1,12 +0,0 @@
-import { Toggleable } from '../zd-toggleable/toggleable';
-import { ICheckbox } from './interfaces';
-/**
- * Base class for Checkbox component.
- */
-export declare class Checkbox extends Toggleable implements ICheckbox {
-    /**
-     * Create a new Checkbox.
-     * @param props Checkbox properties
-     */
-    constructor(props: ICheckbox);
-}

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

@@ -1,5 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IToggleable } from '../zd-toggleable/interfaces';
-import { Checkbox } from './checkbox';
-export type ICheckboxEvent = IEventParam<Checkbox>;
-export type ICheckbox = IToggleable;

package/dist/types/components/zd-checkbox-multiple/checkbox-multiple.d.ts

@@ -1,39 +0,0 @@
-import { Datasource } from '@zeedhi/core';
-import { Input } from '../zd-input/input';
-import { ICheckboxMultiple } from './interfaces';
-/**
- * Base class for Checkbox multiple component.
- */
-export declare class CheckboxMultiple extends Input implements ICheckboxMultiple {
-    /**
-     * Quantity of columns that will be rendered on non vertical case
-     */
-    columns: number;
-    /**
-     * Field on datasource.data that will be used to set checkbox's label
-     */
-    dataLabel: string;
-    /**
-     * Source of checkbox items
-     */
-    datasource: Datasource;
-    /**
-     * Field on datasource.data that will be used to set checkbox's value
-     */
-    dataValue: string;
-    /**
-     * Defines the checkbox list direction
-     */
-    vertical: boolean;
-    /**
-     * Defines if field value should be an object
-     */
-    returnObject: boolean;
-    /**
-     * Create a new Checkbox Multiple.
-     * @param props CheckBpox Multiple properties
-     */
-    constructor(props: ICheckboxMultiple);
-    onBeforeDestroy(): void;
-    onCreated(): void;
-}

package/dist/types/components/zd-checkbox-multiple/interfaces.d.ts

@@ -1,13 +0,0 @@
-import { IDatasource, IEventParam } from '@zeedhi/core';
-import { IInput } from '../zd-input/interfaces';
-import { CheckboxMultiple } from './checkbox-multiple';
-export type ICheckboxMultipleEvent = IEventParam<CheckboxMultiple>;
-export interface ICheckboxMultiple extends IInput {
-    dataLabel?: string;
-    datasource: IDatasource;
-    dataValue?: string;
-    value?: any[];
-    vertical?: boolean;
-    columns?: number;
-    returnObject?: boolean;
-}

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

@@ -1,60 +0,0 @@
-import { Button } from '../zd-button/button';
-import { IChip } from './interfaces';
-/**
- * Base class for Chip component.
- */
-export declare class Chip extends Button implements IChip {
-    /**
-     * Determines whether the chip is active or not
-     */
-    active: boolean;
-    /**
-     * Configure the active CSS class applied when the link is active
-     */
-    activeClass: string;
-    /**
-     * Adds remove button
-     */
-    closable: boolean;
-    /**
-     * Change the default icon used for close chips
-     */
-    closeIcon: string;
-    /**
-     * Makes the chip draggable
-     */
-    draggable: boolean;
-    /**
-     * Explicitly define the chip as a link
-     */
-    link: boolean;
-    /**
-     * Removes background and applies border and text color
-     */
-    outlined: boolean;
-    /**
-     * Applies the ripple
-     */
-    ripple: boolean;
-    /**
-     * Applies a large border radius on the chip
-     */
-    round: boolean;
-    /**
-     * Value Model
-     */
-    value: boolean;
-    /**
-     * Makes the component extra large
-     */
-    xLarge: boolean;
-    /**
-     * Makes the component extra small
-     */
-    xSmall: boolean;
-    /**
-     * Create a new Chip
-     * @param props Chip definition
-     */
-    constructor(props: IChip);
-}

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

@@ -1,18 +0,0 @@
-import { IEventParam } from '@zeedhi/core';
-import { IButton } from '../zd-button/interfaces';
-import { Chip } from './chip';
-export type IChipEvent = IEventParam<Chip>;
-export interface IChip extends IButton {
-    active?: boolean;
-    activeClass?: string;
-    closable?: boolean;
-    closeIcon?: string;
-    draggable?: boolean;
-    link?: boolean;
-    outlined?: boolean;
-    ripple?: boolean;
-    round?: boolean;
-    value?: boolean;
-    xLarge?: boolean;
-    xSmall?: boolean;
-}

package/dist/types/components/zd-code-viewer/code-viewer.d.ts

@@ -1,86 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { ICodeViewer } from './interfaces';
-/**
- * The Code Viewer component <code>zd-code-viewer</code> is used to show code highlighted using one of the
- * language supported by <a href=\"http://prismjs.com\" alt=\"Prism JS\" target=\"_blank\">Prism JS</a>
- * (<strong>html</strong>, <strong>javascript</strong>, <strong>typescript</strong>, <strong>css</strong>,
- * <strong>json</strong>, <strong>bash</strong>, <strong>etc.</strong>).
- * It can show code from a datasource field or static code.
- */
-export declare class CodeViewer extends ComponentRender implements ICodeViewer {
-    /**
-     * 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;
-    /**
-     * Language code to be used for highlight (js|javascript, css, html, json, ts|typescript, bash|shell)
-     * Other languages must be imported above
-     */
-    language: string;
-    /**
-     * Controls if line numbers are shown
-     */
-    showLineNumbers: boolean | string;
-    /**
-     * Icon to be shown on copy action
-     */
-    copyIcon?: string;
-    tooltipText: string;
-    private code;
-    private staticCodeValue;
-    private viewHighlight?;
-    setViewHighlight(fn: (code: string, language: string) => string): void;
-    /**
-     * Creates a new CodeViewer
-     * @param props CodeViewer properties
-     */
-    constructor(props: ICodeViewer);
-    /**
-     * Code to be shown. When showing JSON code, the JSON object can be passed instead of the string code.
-     */
-    get staticCode(): object | string | string[];
-    set staticCode(code: object | string | string[]);
-    /**
-     * Retrieves static code as string
-     */
-    private getCode;
-    /**
-     * Copy the component content to clipboard
-     */
-    copyToClipboard(): Promise<void>;
-    private changeTooltipText;
-    /**
-     * Get the code highlighted
-     */
-    getHighlightedCode(): string;
-    /**
-     * Get the total of lines
-     */
-    get lineNumbersCount(): number;
-}

package/dist/types/components/zd-code-viewer/interfaces.d.ts

@@ -1,13 +0,0 @@
-import { IComponentRender } from '../zd-component/interfaces';
-export interface ICodeViewer extends IComponentRender {
-    staticCode?: object | string | string[];
-    language?: string;
-    showLineNumbers?: boolean | string;
-    height?: number | string;
-    maxHeight?: number | string;
-    minHeight?: number | string;
-    width?: number | string;
-    maxWidth?: number | string;
-    minWidth?: number | string;
-    copyIcon?: string;
-}

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

@@ -1,33 +0,0 @@
-import { ComponentRender } from '../zd-component/component-render';
-import { ICol } from './interfaces';
-/**
- * Base class for Col component.
- */
-export declare class Col extends ComponentRender implements ICol {
-    cols: string | number;
-    sm?: string | number;
-    md?: string | number;
-    lg?: string | number;
-    xl?: string | number;
-    offset?: string | 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;
-    /**
-     * Creates a new Col.
-     * @param props Col properties
-     */
-    constructor(props: ICol);
-}