@vuesax-alpha/nightly
Version:
A Component Library for Vue 3
478 lines (477 loc) • 22.6 kB
TypeScript
import type Tooltip from './tooltip.vue';
import type { ExtractPropTypes } from 'vue';
export declare const tooltipProps: {
shift: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => (boolean | Partial<Partial<{
boundary: any;
rootBoundary: import("vuesax-alpha/es/hooks").RootBoundary;
elementContext: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext;
altBoundary: boolean;
padding: import("vuesax-alpha/es/hooks").Padding;
}> & {
mainAxis: boolean;
crossAxis: boolean;
limiter: {
fn: (state: import("vuesax-alpha/es/hooks/use-floating/core").MiddlewareState) => import("vuesax-alpha/es/hooks").Coords;
options?: any;
};
}>) & {}) | (() => boolean | Partial<Partial<{
boundary: any;
rootBoundary: import("vuesax-alpha/es/hooks").RootBoundary;
elementContext: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext;
altBoundary: boolean;
padding: import("vuesax-alpha/es/hooks").Padding;
}> & {
mainAxis: boolean;
crossAxis: boolean;
limiter: {
fn: (state: import("vuesax-alpha/es/hooks/use-floating/core").MiddlewareState) => import("vuesax-alpha/es/hooks").Coords;
options?: any;
};
}>) | ((new (...args: any[]) => (boolean | Partial<Partial<{
boundary: any;
rootBoundary: import("vuesax-alpha/es/hooks").RootBoundary;
elementContext: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext;
altBoundary: boolean;
padding: import("vuesax-alpha/es/hooks").Padding;
}> & {
mainAxis: boolean;
crossAxis: boolean;
limiter: {
fn: (state: import("vuesax-alpha/es/hooks/use-floating/core").MiddlewareState) => import("vuesax-alpha/es/hooks").Coords;
options?: any;
};
}>) & {}) | (() => boolean | Partial<Partial<{
boundary: any;
rootBoundary: import("vuesax-alpha/es/hooks").RootBoundary;
elementContext: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext;
altBoundary: boolean;
padding: import("vuesax-alpha/es/hooks").Padding;
}> & {
mainAxis: boolean;
crossAxis: boolean;
limiter: {
fn: (state: import("vuesax-alpha/es/hooks/use-floating/core").MiddlewareState) => import("vuesax-alpha/es/hooks").Coords;
options?: any;
};
}>))[], unknown, unknown, boolean, boolean>;
color: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<StringConstructor, "primary" | "success" | "danger" | "warn" | "dark" | "text" | "light" | "secondary" | "facebook" | "twitter" | "youtube" | "pinterest" | "linkedin" | "snapchat" | "whatsapp" | "tumblr" | "reddit" | "spotify" | "amazon" | "medium" | "vimeo" | "skype" | "dribbble" | "slack" | "yahoo" | "twitch" | "discord" | "telegram" | "google-plus" | "messenger", import("../../..").Color>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
animation: import("vuesax-alpha/es/utils").VsPropFinalized<StringConstructor, unknown, unknown, string, boolean>;
interactivity: import("vuesax-alpha/es/utils").VsPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
appendTo: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<(new (...args: any[]) => (string | HTMLElement) & {}) | (() => string | HTMLElement) | ((new (...args: any[]) => (string | HTMLElement) & {}) | (() => string | HTMLElement))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
type: import("vuesax-alpha/es/utils").VsPropFinalized<StringConstructor, "border" | "shadow" | "border-thick", unknown, string, boolean>;
shape: import("vuesax-alpha/es/utils").VsPropFinalized<StringConstructor, "default" | "circle" | "square", unknown, string, boolean>;
effect: import("vuesax-alpha/es/utils").VsPropFinalized<StringConstructor, "dark" | "light", unknown, string, boolean>;
showArrow: import("vuesax-alpha/es/utils").VsPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
loading: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
offset: import("vuesax-alpha/es/utils").VsPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
bottom: BooleanConstructor;
left: BooleanConstructor;
right: BooleanConstructor;
top: BooleanConstructor;
notHover: BooleanConstructor;
shadow: BooleanConstructor;
border: BooleanConstructor;
borderThick: BooleanConstructor;
square: BooleanConstructor;
circle: BooleanConstructor;
processBeforeOpen: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => () => boolean) | (() => () => boolean) | {
(): () => boolean;
new (): any;
readonly prototype: any;
} | ((new (...args: any[]) => () => boolean) | (() => () => boolean) | {
(): () => boolean;
new (): any;
readonly prototype: any;
})[], unknown, unknown, () => true, boolean>;
processBeforeClose: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => () => boolean) | (() => () => boolean) | {
(): () => boolean;
new (): any;
readonly prototype: any;
} | ((new (...args: any[]) => () => boolean) | (() => () => boolean) | {
(): () => boolean;
new (): any;
readonly prototype: any;
})[], unknown, unknown, () => true, boolean>;
visible: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => (boolean | null) & {}) | (() => boolean | null) | ((new (...args: any[]) => (boolean | null) & {}) | (() => boolean | null))[], never, never, null, false>;
"onUpdate:visible": {
readonly type: import("vue").PropType<(val: boolean) => void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
disabled: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
trigger: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => import("vuesax-alpha/es/utils").Arrayable<import("vuesax-alpha/es/components/popper").PopperTriggerType> & {}) | (() => import("vuesax-alpha/es/utils").Arrayable<import("vuesax-alpha/es/components/popper").PopperTriggerType>) | ((new (...args: any[]) => import("vuesax-alpha/es/utils").Arrayable<import("vuesax-alpha/es/components/popper").PopperTriggerType> & {}) | (() => import("vuesax-alpha/es/utils").Arrayable<import("vuesax-alpha/es/components/popper").PopperTriggerType>))[], unknown, unknown, string, boolean>;
virtualRef: {
readonly type: import("vue").PropType<import("../../..").Measurable>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
virtualTriggering: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onMouseenter: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onMouseleave: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onClick: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onKeydown: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onFocus: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onBlur: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
onContextmenu: {
readonly type: import("vue").PropType<(e: Event) => boolean | void>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
triggerClass: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<(new (...args: any[]) => (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) & {}) | (() => string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | ((new (...args: any[]) => (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) & {}) | (() => string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
triggerStyle: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<(new (...args: any[]) => import("vue").StyleValue & {}) | (() => import("vue").StyleValue) | ((new (...args: any[]) => import("vue").StyleValue & {}) | (() => import("vue").StyleValue))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
teleported: import("vuesax-alpha/es/utils").VsPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
strategy: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => import("vuesax-alpha/es/hooks").Strategy & {}) | (() => import("vuesax-alpha/es/hooks").Strategy) | ((new (...args: any[]) => import("vuesax-alpha/es/hooks").Strategy & {}) | (() => import("vuesax-alpha/es/hooks").Strategy))[], "fixed" | "absolute", unknown, string, boolean>;
fit: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
placement: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => import("vuesax-alpha/es/hooks").Placement & {}) | (() => import("vuesax-alpha/es/hooks").Placement) | ((new (...args: any[]) => import("vuesax-alpha/es/hooks").Placement & {}) | (() => import("vuesax-alpha/es/hooks").Placement))[], "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end" | "right" | "right-start" | "right-end", unknown, string, boolean>;
zIndex: import("vuesax-alpha/es/utils").VsPropFinalized<NumberConstructor, unknown, unknown, number, boolean>;
flip: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => (boolean | {
padding?: import("vuesax-alpha/es/hooks").Padding | undefined;
rootBoundary?: import("vuesax-alpha/es/hooks").RootBoundary | undefined;
elementContext?: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext | undefined;
altBoundary?: boolean | undefined;
mainAxis?: boolean | undefined;
crossAxis?: boolean | undefined;
fallbackPlacements?: import("vuesax-alpha/es/hooks").Placement[] | undefined;
fallbackStrategy?: "bestFit" | "initialPlacement" | undefined;
fallbackAxisSideDirection?: "none" | "end" | "start" | undefined;
flipAlignment?: boolean | undefined;
boundary?: import("vuesax-alpha/es/hooks").Boundary | undefined;
}) & {}) | (() => boolean | {
padding?: import("vuesax-alpha/es/hooks").Padding | undefined;
rootBoundary?: import("vuesax-alpha/es/hooks").RootBoundary | undefined;
elementContext?: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext | undefined;
altBoundary?: boolean | undefined;
mainAxis?: boolean | undefined;
crossAxis?: boolean | undefined;
fallbackPlacements?: import("vuesax-alpha/es/hooks").Placement[] | undefined;
fallbackStrategy?: "bestFit" | "initialPlacement" | undefined;
fallbackAxisSideDirection?: "none" | "end" | "start" | undefined;
flipAlignment?: boolean | undefined;
boundary?: import("vuesax-alpha/es/hooks").Boundary | undefined;
}) | ((new (...args: any[]) => (boolean | {
padding?: import("vuesax-alpha/es/hooks").Padding | undefined;
rootBoundary?: import("vuesax-alpha/es/hooks").RootBoundary | undefined;
elementContext?: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext | undefined;
altBoundary?: boolean | undefined;
mainAxis?: boolean | undefined;
crossAxis?: boolean | undefined;
fallbackPlacements?: import("vuesax-alpha/es/hooks").Placement[] | undefined;
fallbackStrategy?: "bestFit" | "initialPlacement" | undefined;
fallbackAxisSideDirection?: "none" | "end" | "start" | undefined;
flipAlignment?: boolean | undefined;
boundary?: import("vuesax-alpha/es/hooks").Boundary | undefined;
}) & {}) | (() => boolean | {
padding?: import("vuesax-alpha/es/hooks").Padding | undefined;
rootBoundary?: import("vuesax-alpha/es/hooks").RootBoundary | undefined;
elementContext?: import("vuesax-alpha/es/hooks/use-floating/core").ElementContext | undefined;
altBoundary?: boolean | undefined;
mainAxis?: boolean | undefined;
crossAxis?: boolean | undefined;
fallbackPlacements?: import("vuesax-alpha/es/hooks").Placement[] | undefined;
fallbackStrategy?: "bestFit" | "initialPlacement" | undefined;
fallbackAxisSideDirection?: "none" | "end" | "start" | undefined;
flipAlignment?: boolean | undefined;
boundary?: import("vuesax-alpha/es/hooks").Boundary | undefined;
}))[], unknown, unknown, () => {}, boolean>;
windowResize: import("vuesax-alpha/es/utils").VsPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
windowScroll: import("vuesax-alpha/es/utils").VsPropFinalized<BooleanConstructor, unknown, unknown, boolean, boolean>;
content: {
readonly type: import("vue").PropType<string>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
rawContent: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
popperClass: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) & {}) | (() => string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | ((new (...args: any[]) => (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) & {}) | (() => string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | (string | {
[x: string]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]))[], unknown, unknown, string, boolean>;
popperStyle: import("vuesax-alpha/es/utils").VsPropFinalized<(new (...args: any[]) => import("vue").StyleValue & {}) | (() => import("vue").StyleValue) | ((new (...args: any[]) => import("vue").StyleValue & {}) | (() => import("vue").StyleValue))[], unknown, unknown, string, boolean>;
persistent: {
readonly type: import("vue").PropType<import("vuesax-alpha/es/utils").VsPropMergeType<BooleanConstructor, unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__vsPropKey: true;
};
showAfter: import("vuesax-alpha/es/utils").VsPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
hideAfter: import("vuesax-alpha/es/utils").VsPropFinalized<NumberConstructor, unknown, unknown, 200, boolean>;
autoClose: import("vuesax-alpha/es/utils").VsPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
};
export declare type TooltipProps = ExtractPropTypes<typeof tooltipProps>;
export declare type TooltipInstance = InstanceType<typeof Tooltip>;
export declare type TooltipExpose = {
isVisible: boolean;
contentRef: HTMLElement | undefined;
triggerRef: HTMLElement | undefined;
show: () => void;
hide: () => void;
update: () => void;
destroy: () => void;
};