@opencloud-eu/design-system
Version:
OpenCloud Design System is used to design OpenCloud UI components
234 lines (233 loc) • 11.1 kB
TypeScript
export interface Props {
/**
* @docs The label of the filter.
*/
filterLabel: string;
/**
* @docs Determines if the drop should close when an item is clicked.
* @default false
*/
closeOnClick?: boolean;
/**
* @docs The element ID of the filter.
*/
id?: string;
/**
* @docs Determines if the filter is a binary toggle.
* @default false
*/
isToggle?: boolean;
/**
* @docs Determines if the toggle is active.
* @default false
*/
isToggleActive?: boolean;
/**
* @docs Determines if the filter has a raw appearance.
* @default false
*/
raw?: boolean;
/**
* @docs The names of the selected items.
*/
selectedItemNames?: string[];
}
export interface Emits {
/**
* @docs Emitted when the filter has been cleared.
*/
(e: 'clearFilter'): void;
/**
* @docs Emitted when the drop has been hidden.
*/
(e: 'hideDrop'): void;
/**
* @docs Emitted when the drop has been displayed.
*/
(e: 'showDrop'): void;
/**
* @docs Emitted when the filter has been toggled.
*/
(e: 'toggleFilter'): void;
}
export interface Slot {
/**
* @docs The content of the filter chip.
*/
default: () => unknown;
}
declare function __VLS_template(): {
attrs: Partial<{}>;
slots: Readonly<Slot> & Slot;
refs: {
dropRef: {
$: import('vue').ComponentInternalInstance;
$data: {};
$props: Partial<{}> & Omit<{
readonly closeOnClick?: boolean;
readonly dropId?: string;
readonly isNested?: boolean;
readonly mode?: "click" | "hover" | "manual";
readonly offset?: string;
readonly paddingSize?: import('../../helpers').SizeType | "remove";
readonly popperOptions?: import('tippy.js').Props["popperOptions"];
readonly position?: "top-start" | "right-start" | "bottom-start" | "left-start" | "auto-start" | "top-end" | "right-end" | "bottom-end" | "left-end" | "auto-end";
readonly target?: string;
readonly toggle?: string;
readonly onHideDrop?: () => any;
readonly onShowDrop?: () => any;
} & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>;
$attrs: {
[x: string]: unknown;
};
$refs: {
[x: string]: unknown;
} & {
drop: HTMLDivElement;
};
$slots: Readonly<{
[name: string]: import('vue').Slot<any>;
}>;
$root: import('vue').ComponentPublicInstance | null;
$parent: import('vue').ComponentPublicInstance | null;
$host: Element | null;
$emit: ((event: "hideDrop") => void) & ((event: "showDrop") => void);
$el: HTMLDivElement;
$options: import('vue').ComponentOptionsBase<Readonly<import('../OcDrop/OcDrop.vue').Props> & Readonly<{
onHideDrop?: () => any;
onShowDrop?: () => any;
}>, {
show: (duration?: number) => void;
hide: (duration?: number) => void;
tippy: import('vue').Ref<any, any>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
hideDrop: () => any;
showDrop: () => any;
}, string, {}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & {
beforeCreate?: (() => void) | (() => void)[];
created?: (() => void) | (() => void)[];
beforeMount?: (() => void) | (() => void)[];
mounted?: (() => void) | (() => void)[];
beforeUpdate?: (() => void) | (() => void)[];
updated?: (() => void) | (() => void)[];
activated?: (() => void) | (() => void)[];
deactivated?: (() => void) | (() => void)[];
beforeDestroy?: (() => void) | (() => void)[];
beforeUnmount?: (() => void) | (() => void)[];
destroyed?: (() => void) | (() => void)[];
unmounted?: (() => void) | (() => void)[];
renderTracked?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void)[];
};
$forceUpdate: () => void;
$nextTick: typeof import('vue').nextTick;
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import('@vue/reactivity').OnCleanup]) => any : (...args: [any, any, import('@vue/reactivity').OnCleanup]) => any, options?: import('vue').WatchOptions): import('vue').WatchStopHandle;
} & Readonly<{}> & Omit<Readonly<import('../OcDrop/OcDrop.vue').Props> & Readonly<{
onHideDrop?: () => any;
onShowDrop?: () => any;
}>, "hide" | "show" | "tippy"> & import('vue').ShallowUnwrapRef<{
show: (duration?: number) => void;
hide: (duration?: number) => void;
tippy: import('vue').Ref<any, any>;
}> & {} & import('vue').ComponentCustomProperties & {} & {
$slots: Readonly<import('../OcDrop/OcDrop.vue').Slots> & import('../OcDrop/OcDrop.vue').Slots;
};
};
rootEl: HTMLDivElement;
};
type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
declare const __VLS_component: import('vue').DefineComponent<Props, {
hideDrop: () => void;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
hideDrop: () => any;
showDrop: () => any;
clearFilter: () => any;
toggleFilter: () => any;
}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{
onHideDrop?: () => any;
onShowDrop?: () => any;
onClearFilter?: () => any;
onToggleFilter?: () => any;
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
dropRef: {
$: import('vue').ComponentInternalInstance;
$data: {};
$props: Partial<{}> & Omit<{
readonly closeOnClick?: boolean;
readonly dropId?: string;
readonly isNested?: boolean;
readonly mode?: "click" | "hover" | "manual";
readonly offset?: string;
readonly paddingSize?: import('../../helpers').SizeType | "remove";
readonly popperOptions?: import('tippy.js').Props["popperOptions"];
readonly position?: "top-start" | "right-start" | "bottom-start" | "left-start" | "auto-start" | "top-end" | "right-end" | "bottom-end" | "left-end" | "auto-end";
readonly target?: string;
readonly toggle?: string;
readonly onHideDrop?: () => any;
readonly onShowDrop?: () => any;
} & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>;
$attrs: {
[x: string]: unknown;
};
$refs: {
[x: string]: unknown;
} & {
drop: HTMLDivElement;
};
$slots: Readonly<{
[name: string]: import('vue').Slot<any>;
}>;
$root: import('vue').ComponentPublicInstance | null;
$parent: import('vue').ComponentPublicInstance | null;
$host: Element | null;
$emit: ((event: "hideDrop") => void) & ((event: "showDrop") => void);
$el: HTMLDivElement;
$options: import('vue').ComponentOptionsBase<Readonly<import('../OcDrop/OcDrop.vue').Props> & Readonly<{
onHideDrop?: () => any;
onShowDrop?: () => any;
}>, {
show: (duration?: number) => void;
hide: (duration?: number) => void;
tippy: import('vue').Ref<any, any>;
}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
hideDrop: () => any;
showDrop: () => any;
}, string, {}, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & {
beforeCreate?: (() => void) | (() => void)[];
created?: (() => void) | (() => void)[];
beforeMount?: (() => void) | (() => void)[];
mounted?: (() => void) | (() => void)[];
beforeUpdate?: (() => void) | (() => void)[];
updated?: (() => void) | (() => void)[];
activated?: (() => void) | (() => void)[];
deactivated?: (() => void) | (() => void)[];
beforeDestroy?: (() => void) | (() => void)[];
beforeUnmount?: (() => void) | (() => void)[];
destroyed?: (() => void) | (() => void)[];
unmounted?: (() => void) | (() => void)[];
renderTracked?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
renderTriggered?: ((e: import('vue').DebuggerEvent) => void) | ((e: import('vue').DebuggerEvent) => void)[];
errorCaptured?: ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void) | ((err: unknown, instance: import('vue').ComponentPublicInstance | null, info: string) => boolean | void)[];
};
$forceUpdate: () => void;
$nextTick: typeof import('vue').nextTick;
$watch<T extends string | ((...args: any) => any)>(source: T, cb: T extends (...args: any) => infer R ? (...args: [R, R, import('@vue/reactivity').OnCleanup]) => any : (...args: [any, any, import('@vue/reactivity').OnCleanup]) => any, options?: import('vue').WatchOptions): import('vue').WatchStopHandle;
} & Readonly<{}> & Omit<Readonly<import('../OcDrop/OcDrop.vue').Props> & Readonly<{
onHideDrop?: () => any;
onShowDrop?: () => any;
}>, "hide" | "show" | "tippy"> & import('vue').ShallowUnwrapRef<{
show: (duration?: number) => void;
hide: (duration?: number) => void;
tippy: import('vue').Ref<any, any>;
}> & {} & import('vue').ComponentCustomProperties & {} & {
$slots: Readonly<import('../OcDrop/OcDrop.vue').Slots> & import('../OcDrop/OcDrop.vue').Slots;
};
}, HTMLDivElement>;
declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
export default _default;
type __VLS_WithTemplateSlots<T, S> = T & {
new (): {
$slots: S;
};
};