@nethesis/vue-components
Version:
This library contains: - a collection of Vue 3 components based on [Flowbite](https://flowbite.com/) - a set of utility functions
192 lines • 11 kB
TypeScript
import { Tippy } from 'vue-tippy';
import type { PropType } from 'vue';
export type TooltipPlacement = 'top' | 'top-start' | 'top-end' | 'right' | 'right-start' | 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'auto' | 'auto-start' | 'auto-end';
export type TooltipTriggerEvent = 'click' | 'mouseenter focus' | 'focusin' | 'mouseenter click' | 'manual';
/**
* All the props accepted by the Tippy component, see https://vue-tippy.netlify.app/props/
*/
export type TippyComponentProps = Partial<InstanceType<typeof Tippy>['$props']>;
declare var __VLS_6: {}, __VLS_12: {};
type __VLS_Slots = {} & {
trigger?: (props: typeof __VLS_6) => any;
} & {
content?: (props: typeof __VLS_12) => any;
};
declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
placement: {
type: PropType<TooltipPlacement>;
default: string;
};
triggerEvent: {
type: PropType<TooltipTriggerEvent>;
default: string;
};
interactive: {
type: BooleanConstructor;
default: boolean;
};
/**
* Any additional Tippy prop (https://vue-tippy.netlify.app/props/), e.g.
* `{ maxWidth: 'none', offset: [0, 20], delay: [300, 0] }`.
* The props above take precedence over the same key set here.
*/
tippyProps: {
type: PropType<TippyComponentProps>;
default: undefined;
};
}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
placement: {
type: PropType<TooltipPlacement>;
default: string;
};
triggerEvent: {
type: PropType<TooltipTriggerEvent>;
default: string;
};
interactive: {
type: BooleanConstructor;
default: boolean;
};
/**
* Any additional Tippy prop (https://vue-tippy.netlify.app/props/), e.g.
* `{ maxWidth: 'none', offset: [0, 20], delay: [300, 0] }`.
* The props above take precedence over the same key set here.
*/
tippyProps: {
type: PropType<TippyComponentProps>;
default: undefined;
};
}>> & Readonly<{}>, {
interactive: boolean;
placement: TooltipPlacement;
triggerEvent: TooltipTriggerEvent;
tippyProps: Partial<Partial<{
content: import("tippy.js").Content;
triggerTarget: Element | Element[];
getReferenceClientRect: import("tippy.js").GetReferenceClientRect;
animateFill: boolean;
appendTo: Element | "parent" | ((ref: Element) => Element);
aria: {
content?: "auto" | "describedby" | "labelledby" | null | undefined;
expanded?: boolean | "auto" | undefined;
};
delay: number | [number, number];
duration: number | [number, number];
followCursor: string | boolean;
hideOnClick: string | boolean;
ignoreAttributes: boolean;
inlinePositioning: boolean;
interactive: boolean;
interactiveBorder: number;
interactiveDebounce: number;
moveTransition: string;
offset: [number, number] | (({ placement, popper, reference, }: {
placement: import("@popperjs/core").Placement;
popper: import("@popperjs/core").Rect;
reference: import("@popperjs/core").Rect;
}) => [number, number]);
placement: import("@popperjs/core").Placement;
plugins: import("tippy.js").Plugin<unknown>[];
popperOptions: Partial<import("@popperjs/core").Options>;
render: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => {
popper: import("tippy.js").PopperElement<import("tippy.js").Props>;
onUpdate?: ((prevProps: import("tippy.js").Props, nextProps: import("tippy.js").Props) => void) | undefined;
};
showOnCreate: boolean;
sticky: string | boolean;
touch: string | boolean | unknown[];
trigger: string;
onAfterUpdate: (instance: import("tippy.js").Instance<import("tippy.js").Props>, partialProps: Partial<import("tippy.js").Props>) => void;
onBeforeUpdate: (instance: import("tippy.js").Instance<import("tippy.js").Props>, partialProps: Partial<import("tippy.js").Props>) => void;
onCreate: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
onDestroy: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
onHidden: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
onHide: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => false | void;
onMount: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
onShow: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => false | void;
onShown: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
onTrigger: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
onUntrigger: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
onClickOutside: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
allowHTML: boolean;
animation: string | boolean;
arrow: string | boolean | DocumentFragment | SVGElement;
inertia: boolean;
maxWidth: string | number;
role: string;
theme: string;
zIndex: number;
tag: string | Record<string, any>;
contentTag: string | Record<string, any>;
contentClass: string;
}> & Omit<{
readonly role: string;
readonly duration: number | [number, number];
readonly animation: string | boolean;
readonly tag: string | Record<string, any>;
readonly onShow: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => false | void;
readonly contentTag: string | Record<string, any>;
readonly contentClass: string;
readonly appendTo: Element | "parent" | ((ref: Element) => Element);
readonly aria: {
content?: "auto" | "describedby" | "labelledby" | null | undefined;
expanded?: boolean | "auto" | undefined;
};
readonly delay: number | [number, number];
readonly getReferenceClientRect: import("tippy.js").GetReferenceClientRect;
readonly hideOnClick: string | boolean;
readonly ignoreAttributes: boolean;
readonly interactive: boolean;
readonly interactiveBorder: number;
readonly interactiveDebounce: number;
readonly moveTransition: string;
readonly offset: [number, number] | (({ placement, popper, reference, }: {
placement: import("@popperjs/core").Placement;
popper: import("@popperjs/core").Rect;
reference: import("@popperjs/core").Rect;
}) => [number, number]);
readonly onAfterUpdate: (instance: import("tippy.js").Instance<import("tippy.js").Props>, partialProps: Partial<import("tippy.js").Props>) => void;
readonly onBeforeUpdate: (instance: import("tippy.js").Instance<import("tippy.js").Props>, partialProps: Partial<import("tippy.js").Props>) => void;
readonly onCreate: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
readonly onDestroy: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
readonly onHidden: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
readonly onHide: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => false | void;
readonly onMount: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
readonly onShown: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => void;
readonly onTrigger: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
readonly onUntrigger: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
readonly onClickOutside: (instance: import("tippy.js").Instance<import("tippy.js").Props>, event: Event) => void;
readonly placement: "right" | "left" | "auto" | "top" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom" | "bottom-start" | "bottom-end" | "left-start" | "left-end" | "auto-start" | "auto-end";
readonly plugins: import("tippy.js").Plugin<unknown>[];
readonly popperOptions: Partial<import("@popperjs/core").Options>;
readonly render: (instance: import("tippy.js").Instance<import("tippy.js").Props>) => {
popper: import("tippy.js").PopperElement<import("tippy.js").Props>;
onUpdate?: ((prevProps: import("tippy.js").Props, nextProps: import("tippy.js").Props) => void) | undefined;
};
readonly showOnCreate: boolean;
readonly touch: string | boolean | unknown[];
readonly trigger: string;
readonly triggerTarget: Element | Element[];
readonly animateFill: boolean;
readonly followCursor: string | boolean;
readonly inlinePositioning: boolean;
readonly sticky: string | boolean;
readonly allowHTML: boolean;
readonly arrow: string | boolean | SVGElement | DocumentFragment;
readonly content: string | Element | DocumentFragment | ((ref: Element) => string | Element | DocumentFragment);
readonly inertia: boolean;
readonly maxWidth: string | number;
readonly theme: string;
readonly zIndex: number;
readonly to?: string | Element | undefined;
onState?: ((...args: any[]) => any) | undefined | undefined;
} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, "role" | "duration" | "animation" | "tag" | "onShow" | "contentTag" | "contentClass" | "appendTo" | "aria" | "delay" | "getReferenceClientRect" | "hideOnClick" | "ignoreAttributes" | "interactive" | "interactiveBorder" | "interactiveDebounce" | "moveTransition" | "offset" | "onAfterUpdate" | "onBeforeUpdate" | "onCreate" | "onDestroy" | "onHidden" | "onHide" | "onMount" | "onShown" | "onTrigger" | "onUntrigger" | "onClickOutside" | "placement" | "plugins" | "popperOptions" | "render" | "showOnCreate" | "touch" | "trigger" | "triggerTarget" | "animateFill" | "followCursor" | "inlinePositioning" | "sticky" | "allowHTML" | "arrow" | "content" | "inertia" | "maxWidth" | "theme" | "zIndex">>;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
export default _default;
type __VLS_WithSlots<T, S> = T & {
new (): {
$slots: S;
};
};
//# sourceMappingURL=NeTooltip.vue.d.ts.map