@opencloud-eu/design-system
Version:
OpenCloud Design System is used to design OpenCloud UI components
199 lines (198 loc) • 10.2 kB
TypeScript
import { Props as OcDropProps } from '../OcDrop/OcDrop.vue';
import { ContextualHelperDataListItem } from '../../helpers';
export interface Props {
/**
* @docs Title of the info drop.
*/
title: string;
/**
* @docs Element ID of the info drop.
*/
dropId?: string;
/**
* @docs Text at the end of the info drop.
*/
endText?: string;
/**
* @docs List of items to display in the info drop. Please refer to the component source for the `ContextualHelperDataListItem` type definition.
*/
list?: ContextualHelperDataListItem[];
/**
* @docs Event that triggers the info drop.
* @default 'click'
*/
mode?: OcDropProps['mode'];
/**
* @docs Link at the end of the info drop.
*/
readMoreLink?: string;
/**
* @docs Text to display in the info drop.
*/
text?: string;
/**
* @docs CSS selector for the element to be used as toggle. By default, the preceding element is used.
*/
toggle?: string;
}
declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {
FocusTrap: import('vue').DefineComponent<{
active: {
type: BooleanConstructor;
default: boolean;
};
} & {
escapeDeactivates: {
type: BooleanConstructor;
default: true;
};
returnFocusOnDeactivate: {
type: BooleanConstructor;
default: true;
};
allowOutsideClick: {
type: import('vue').PropType<boolean | import('focus-trap').MouseEventToBoolean | undefined>;
default: true;
};
clickOutsideDeactivates: import('vue').PropType<boolean | import('focus-trap').MouseEventToBoolean | undefined>;
initialFocus: import('vue').PropType<import('focus-trap').FocusTargetOrFalse | (() => void) | undefined>;
fallbackFocus: import('vue').PropType<import('focus-trap').FocusTarget | undefined>;
checkCanFocusTrap: import('vue').PropType<((containers: (HTMLElement | SVGElement)[]) => Promise<void>) | undefined>;
checkCanReturnFocus: import('vue').PropType<((trigger: HTMLElement | SVGElement) => Promise<void>) | undefined>;
delayInitialFocus: {
type: BooleanConstructor;
default: true;
};
document: import('vue').PropType<Document | undefined>;
preventScroll: BooleanConstructor;
setReturnFocus: import('vue').PropType<import('focus-trap').FocusTargetValueOrFalse | ((nodeFocusedBeforeActivation: HTMLElement | SVGElement) => import('focus-trap').FocusTargetValueOrFalse) | undefined>;
tabbableOptions: import('vue').PropType<import('focus-trap').FocusTrapTabbableOptions | undefined>;
}, {
activate(): void;
deactivate(): void;
renderImpl(): import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
[key: string]: any;
}> | import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
[key: string]: any;
}>[] | null;
}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("update:active" | "activate" | "postActivate" | "deactivate" | "postDeactivate")[], "update:active" | "activate" | "postActivate" | "deactivate" | "postDeactivate", import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, Readonly<import('vue').ExtractPropTypes<{
active: {
type: BooleanConstructor;
default: boolean;
};
} & {
escapeDeactivates: {
type: BooleanConstructor;
default: true;
};
returnFocusOnDeactivate: {
type: BooleanConstructor;
default: true;
};
allowOutsideClick: {
type: import('vue').PropType<boolean | import('focus-trap').MouseEventToBoolean | undefined>;
default: true;
};
clickOutsideDeactivates: import('vue').PropType<boolean | import('focus-trap').MouseEventToBoolean | undefined>;
initialFocus: import('vue').PropType<import('focus-trap').FocusTargetOrFalse | (() => void) | undefined>;
fallbackFocus: import('vue').PropType<import('focus-trap').FocusTarget | undefined>;
checkCanFocusTrap: import('vue').PropType<((containers: (HTMLElement | SVGElement)[]) => Promise<void>) | undefined>;
checkCanReturnFocus: import('vue').PropType<((trigger: HTMLElement | SVGElement) => Promise<void>) | undefined>;
delayInitialFocus: {
type: BooleanConstructor;
default: true;
};
document: import('vue').PropType<Document | undefined>;
preventScroll: BooleanConstructor;
setReturnFocus: import('vue').PropType<import('focus-trap').FocusTargetValueOrFalse | ((nodeFocusedBeforeActivation: HTMLElement | SVGElement) => import('focus-trap').FocusTargetValueOrFalse) | undefined>;
tabbableOptions: import('vue').PropType<import('focus-trap').FocusTrapTabbableOptions | undefined>;
}>> & {
onActivate?: ((...args: any[]) => any) | undefined;
onPostActivate?: ((...args: any[]) => any) | undefined;
onDeactivate?: ((...args: any[]) => any) | undefined;
onPostDeactivate?: ((...args: any[]) => any) | undefined;
"onUpdate:active"?: ((...args: any[]) => any) | undefined;
}, {
returnFocusOnDeactivate: boolean;
escapeDeactivates: boolean;
allowOutsideClick: boolean | import('focus-trap').MouseEventToBoolean | undefined;
preventScroll: boolean;
delayInitialFocus: boolean;
active: boolean;
}, {}>;
}, {}, string, import('vue').ComponentProvideOptions, false, {
drop: {
$: 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<OcDropProps> & 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<OcDropProps> & 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>;
export default _default;