@ownclouders/design-system/dist/src/components/OcFilterChip/OcFilterChip.vue.d.ts

ownCloud Design System is based on VueDesign Systems and is used to design ownCloud UI components

import { PropType } from 'vue';
declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
    id: {
        type: StringConstructor;
        required: false;
        default: () => string;
    };
    /**
     * Label which is displayed when no items are selected.
     */
    filterLabel: {
        type: StringConstructor;
        required: true;
    };
    /**
     * An array of selected item names. It is being ignored when `isToggle` is set to `true`.
     */
    selectedItemNames: {
        type: PropType<string[]>;
        required: false;
        default: () => string[];
    };
    /**
     * Display the filter chip as a on/off toggle.
     */
    isToggle: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the toggle filter is active. It only has an effect if `isToggle` is set to `true`.
     */
    isToggleActive: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the filter chip should be displayed as a raw button.
     */
    raw: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the drop should be closed when clicking on an item.
     */
    closeOnClick: {
        type: BooleanConstructor;
        default: boolean;
    };
}>, {
    filterActive: import('vue').ComputedRef<boolean>;
    dropRef: import('vue').Ref<import('vue').DefineComponent<import('vue').ExtractPropTypes<{
        dropId: {
            type: StringConstructor;
            required: false;
            default: () => string;
        };
        popperOptions: {
            type: ObjectConstructor;
            required: false;
            default: () => {};
        };
        toggle: {
            type: StringConstructor;
            default: string;
        };
        position: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        mode: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        closeOnClick: {
            type: BooleanConstructor;
            required: false;
        };
        isNested: {
            type: BooleanConstructor;
            required: false;
        };
        target: {
            type: StringConstructor;
            required: false;
            default: any;
        };
        paddingSize: {
            type: StringConstructor;
            required: false;
            default: string;
            validator: (value: unknown) => boolean;
        };
        offset: {
            type: StringConstructor;
            required: false;
            default: any;
        };
    }>, {
        drop: Readonly<import('vue').ShallowRef<HTMLElement>>;
        tippy: import('vue').Ref<any, any>;
        show: (duration?: number) => void;
        hide: (duration?: number) => void;
        onClick: () => void;
    }, {}, {
        triggerMapping(): string;
        paddingClass(): string;
    }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("hideDrop" | "showDrop")[], "hideDrop" | "showDrop", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
        dropId: {
            type: StringConstructor;
            required: false;
            default: () => string;
        };
        popperOptions: {
            type: ObjectConstructor;
            required: false;
            default: () => {};
        };
        toggle: {
            type: StringConstructor;
            default: string;
        };
        position: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        mode: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        closeOnClick: {
            type: BooleanConstructor;
            required: false;
        };
        isNested: {
            type: BooleanConstructor;
            required: false;
        };
        target: {
            type: StringConstructor;
            required: false;
            default: any;
        };
        paddingSize: {
            type: StringConstructor;
            required: false;
            default: string;
            validator: (value: unknown) => boolean;
        };
        offset: {
            type: StringConstructor;
            required: false;
            default: any;
        };
    }>> & Readonly<{
        onHideDrop?: (...args: any[]) => any;
        onShowDrop?: (...args: any[]) => any;
    }>, {
        target: string;
        offset: string;
        popperOptions: Record<string, any>;
        toggle: string;
        dropId: string;
        position: string;
        mode: string;
        closeOnClick: boolean;
        isNested: boolean;
        paddingSize: string;
    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>, import('vue').DefineComponent<import('vue').ExtractPropTypes<{
        dropId: {
            type: StringConstructor;
            required: false;
            default: () => string;
        };
        popperOptions: {
            type: ObjectConstructor;
            required: false;
            default: () => {};
        };
        toggle: {
            type: StringConstructor;
            default: string;
        };
        position: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        mode: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        closeOnClick: {
            type: BooleanConstructor;
            required: false;
        };
        isNested: {
            type: BooleanConstructor;
            required: false;
        };
        target: {
            type: StringConstructor;
            required: false;
            default: any;
        };
        paddingSize: {
            type: StringConstructor;
            required: false;
            default: string;
            validator: (value: unknown) => boolean;
        };
        offset: {
            type: StringConstructor;
            required: false;
            default: any;
        };
    }>, {
        drop: Readonly<import('vue').ShallowRef<HTMLElement>>;
        tippy: import('vue').Ref<any, any>;
        show: (duration?: number) => void;
        hide: (duration?: number) => void;
        onClick: () => void;
    }, {}, {
        triggerMapping(): string;
        paddingClass(): string;
    }, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("hideDrop" | "showDrop")[], "hideDrop" | "showDrop", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
        dropId: {
            type: StringConstructor;
            required: false;
            default: () => string;
        };
        popperOptions: {
            type: ObjectConstructor;
            required: false;
            default: () => {};
        };
        toggle: {
            type: StringConstructor;
            default: string;
        };
        position: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        mode: {
            type: StringConstructor;
            default: string;
            validator: (value: string) => boolean;
        };
        closeOnClick: {
            type: BooleanConstructor;
            required: false;
        };
        isNested: {
            type: BooleanConstructor;
            required: false;
        };
        target: {
            type: StringConstructor;
            required: false;
            default: any;
        };
        paddingSize: {
            type: StringConstructor;
            required: false;
            default: string;
            validator: (value: unknown) => boolean;
        };
        offset: {
            type: StringConstructor;
            required: false;
            default: any;
        };
    }>> & Readonly<{
        onHideDrop?: (...args: any[]) => any;
        onShowDrop?: (...args: any[]) => any;
    }>, {
        target: string;
        offset: string;
        popperOptions: Record<string, any>;
        toggle: string;
        dropId: string;
        position: string;
        mode: string;
        closeOnClick: boolean;
        isNested: boolean;
        paddingSize: string;
    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("hideDrop" | "showDrop" | "clearFilter" | "toggleFilter")[], "hideDrop" | "showDrop" | "clearFilter" | "toggleFilter", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
    id: {
        type: StringConstructor;
        required: false;
        default: () => string;
    };
    /**
     * Label which is displayed when no items are selected.
     */
    filterLabel: {
        type: StringConstructor;
        required: true;
    };
    /**
     * An array of selected item names. It is being ignored when `isToggle` is set to `true`.
     */
    selectedItemNames: {
        type: PropType<string[]>;
        required: false;
        default: () => string[];
    };
    /**
     * Display the filter chip as a on/off toggle.
     */
    isToggle: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the toggle filter is active. It only has an effect if `isToggle` is set to `true`.
     */
    isToggleActive: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the filter chip should be displayed as a raw button.
     */
    raw: {
        type: BooleanConstructor;
        default: boolean;
    };
    /**
     * Whether the drop should be closed when clicking on an item.
     */
    closeOnClick: {
        type: BooleanConstructor;
        default: boolean;
    };
}>> & Readonly<{
    onHideDrop?: (...args: any[]) => any;
    onShowDrop?: (...args: any[]) => any;
    onClearFilter?: (...args: any[]) => any;
    onToggleFilter?: (...args: any[]) => any;
}>, {
    id: string;
    raw: boolean;
    closeOnClick: boolean;
    selectedItemNames: string[];
    isToggle: boolean;
    isToggleActive: boolean;
}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
export default _default;