primevue-mirror/components/tooltip/Tooltip.d.ts

50 lines
1.3 KiB
TypeScript
Raw Normal View History

2023-03-02 09:31:36 +00:00
import { DirectiveBinding, ObjectDirective } from 'vue';
2022-09-06 12:03:37 +00:00
2023-03-02 09:53:55 +00:00
export interface TooltipOptions {
/**
* Text of the tooltip.
*/
value?: string | undefined;
2023-03-01 14:57:18 +00:00
/**
* When present, it specifies that the component should be disabled.
* @defaultValue false
*/
disabled?: boolean | undefined;
/**
* When present, it adds a custom id to the tooltip.
*/
id?: string | undefined;
/**
* When present, it adds a custom class to the tooltip.
*/
class?: string | undefined;
/**
* When present, it adds a custom id to the tooltip.
* @defaultValue false
*/
escape?: boolean | undefined;
/**
2023-03-02 09:31:36 +00:00
* Automatically adjusts the element position when there is not enough space on the selected position.
2023-03-01 14:57:18 +00:00
* @defaultValue true
*/
fitContent?: boolean | undefined;
2023-03-02 09:53:55 +00:00
}
export declare type TooltipDirectiveModifiers = {};
2023-03-02 09:31:36 +00:00
export interface TooltipDirectiveBinding extends Omit<DirectiveBinding, 'modifiers' | 'value'> {
/**
2023-03-02 09:53:55 +00:00
* Value of the tooltip.
2023-03-02 09:31:36 +00:00
*/
2023-03-02 09:53:55 +00:00
value?: string | TooltipOptions | undefined;
2023-03-02 09:31:36 +00:00
/**
2023-03-02 09:53:55 +00:00
* Modifiers of the tooltip.
2023-03-02 09:31:36 +00:00
* @type {TooltipDirectiveModifiers}
*/
modifiers?: TooltipDirectiveModifiers | undefined;
2023-03-01 14:57:18 +00:00
}
2023-03-02 09:31:36 +00:00
declare const Tooltip: ObjectDirective;
2022-09-06 12:03:37 +00:00
export default Tooltip;