element-plus
Version:
A Component Library for Vue 3
338 lines (337 loc) • 15.1 kB
TypeScript
import type { AriaProps, UseDelayedToggleProps } from 'element-plus/es/hooks';
import type { PopperContentProps } from 'element-plus/es/components/popper';
import type TooltipContent from './content.vue';
import type { ExtractPublicPropTypes } from 'vue';
export interface ElTooltipContentProps extends UseDelayedToggleProps, Omit<PopperContentProps, 'visible'> {
/**
* @description which element the tooltip CONTENT appends to
*/
appendTo?: string | HTMLElement;
/**
* @description display content, can be overridden by `slot#content`
*/
content?: string;
/**
* @description whether `content` is treated as HTML string
*/
rawContent?: boolean;
/**
* @description when tooltip inactive and `persistent` is `false` , popconfirm will be destroyed
*/
persistent?: boolean;
/**
* @description visibility of Tooltip
*/
visible?: boolean | null;
/**
* @description animation name
*/
transition?: string;
/**
* @description whether tooltip content is teleported, if `true` it will be teleported to where `append-to` sets
*/
teleported?: boolean;
/**
* @description whether Tooltip is disabled
*/
disabled?: boolean;
ariaLabel?: AriaProps['ariaLabel'];
}
export declare const useTooltipContentPropsDefaults: {
readonly content: "";
readonly visible: null;
readonly teleported: true;
readonly effect: "dark";
readonly enterable: true;
readonly stopPopperMouseEvent: true;
readonly pure: false;
readonly focusOnShow: false;
readonly trapping: false;
readonly virtualTriggering: false;
readonly loop: false;
readonly style: undefined;
readonly popperStyle: undefined;
readonly arrowOffset: 5;
readonly boundariesPadding: 0;
readonly gpuAcceleration: true;
readonly offset: 12;
readonly placement: "bottom";
readonly popperOptions: () => {};
readonly strategy: "absolute";
readonly showAfter: 0;
readonly hideAfter: 200;
readonly autoClose: 0;
};
/**
* @deprecated Removed after 3.0.0, Use `ElTooltipContentProps` instead.
*/
export declare const useTooltipContentProps: {
readonly ariaLabel: StringConstructor;
readonly appendTo: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement) | ((new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement))[], unknown, unknown>) | ((new (...args: any[]) => string | HTMLElement) | (() => import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement) | ((new (...args: any[]) => string | HTMLElement) | (() => string | HTMLElement))[], unknown, unknown>))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly content: import("element-plus/es/utils").EpPropFinalized<StringConstructor, unknown, unknown, "", boolean>;
readonly rawContent: BooleanConstructor;
readonly persistent: BooleanConstructor;
readonly visible: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => boolean) | (() => boolean | null) | ((new (...args: any[]) => boolean) | (() => boolean | null))[], unknown, unknown, null, boolean>;
readonly transition: StringConstructor;
readonly teleported: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly disabled: BooleanConstructor;
readonly loop: BooleanConstructor;
readonly id: StringConstructor;
readonly style: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | false | import("vue").CSSProperties | import("vue").StyleValue[]) | (() => import("vue").StyleValue) | ((new (...args: any[]) => string | false | import("vue").CSSProperties | import("vue").StyleValue[]) | (() => import("vue").StyleValue))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly className: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | ((new (...args: any[]) => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly effect: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => string) | (() => import("element-plus/es/components/popper").PopperEffect) | ((new (...args: any[]) => string) | (() => import("element-plus/es/components/popper").PopperEffect))[], unknown, unknown, "dark", boolean>;
readonly enterable: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly pure: BooleanConstructor;
readonly focusOnShow: BooleanConstructor;
readonly trapping: BooleanConstructor;
readonly popperClass: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | ((new (...args: any[]) => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]) | (() => string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | (string | {
[]: boolean;
} | any)[])[])[])[])[])[])[])[])[])[])[]))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly popperStyle: {
readonly type: import("vue").PropType<import("element-plus/es/utils").EpPropMergeType<(new (...args: any[]) => string | false | import("vue").CSSProperties | import("vue").StyleValue[]) | (() => import("vue").StyleValue) | ((new (...args: any[]) => string | false | import("vue").CSSProperties | import("vue").StyleValue[]) | (() => import("vue").StyleValue))[], unknown, unknown>>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly referenceEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly triggerTargetEl: {
readonly type: import("vue").PropType<HTMLElement>;
readonly required: false;
readonly validator: ((val: unknown) => boolean) | undefined;
__epPropKey: true;
};
readonly stopPopperMouseEvent: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly virtualTriggering: BooleanConstructor;
readonly zIndex: NumberConstructor;
readonly arrowOffset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 5, boolean>;
readonly boundariesPadding: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly fallbackPlacements: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => import("element-plus/es/components/popper").Placement[]) | (() => import("element-plus/es/components/popper").Placement[]) | ((new (...args: any[]) => import("element-plus/es/components/popper").Placement[]) | (() => import("element-plus/es/components/popper").Placement[]))[], unknown, unknown, undefined, boolean>;
readonly gpuAcceleration: import("element-plus/es/utils").EpPropFinalized<BooleanConstructor, unknown, unknown, true, boolean>;
readonly offset: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 12, boolean>;
readonly placement: import("element-plus/es/utils").EpPropFinalized<StringConstructor, import("element-plus/es/components/popper").Placement, unknown, "bottom", boolean>;
readonly popperOptions: import("element-plus/es/utils").EpPropFinalized<(new (...args: any[]) => Partial<import("element-plus/es/components/popper").Options>) | (() => Partial<import("element-plus/es/components/popper").Options>) | ((new (...args: any[]) => Partial<import("element-plus/es/components/popper").Options>) | (() => Partial<import("element-plus/es/components/popper").Options>))[], unknown, unknown, () => {}, boolean>;
readonly strategy: import("element-plus/es/utils").EpPropFinalized<StringConstructor, "fixed" | "absolute", unknown, "absolute", boolean>;
readonly showAfter: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
readonly hideAfter: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 200, boolean>;
readonly autoClose: import("element-plus/es/utils").EpPropFinalized<NumberConstructor, unknown, unknown, 0, boolean>;
};
/**
* @deprecated Removed after 3.0.0, Use `ElTooltipContentProps` instead.
*/
export type ElTooltipContentPropsPublic = ExtractPublicPropTypes<typeof useTooltipContentProps>;
export type TooltipContentInstance = InstanceType<typeof TooltipContent> & unknown;