primeng/types/primeng-types-tooltip.d.ts

PrimeNG is a premium UI library for Angular featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock,

import { PassThrough, PassThroughOption } from 'primeng/api';

/**
 * Defines the position of the tooltip.
 * @group Types
 */
type TooltipPosition = 'right' | 'left' | 'top' | 'bottom';
/**
 * Defines the event that triggers the tooltip.
 * @group Types
 */
type TooltipEvent = 'hover' | 'focus' | 'both';
/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Tooltip.pt}
 * @group Interface
 */
interface TooltipPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the arrow's DOM element.
     */
    arrow?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the text's DOM element.
     */
    text?: PassThroughOption<HTMLDivElement, I>;
}
/**
 * Defines valid pass-through options in Tooltip.
 * @see {@link TooltipPassThroughOptions}
 *
 * @template I Type of instance.
 */
type TooltipPassThrough<I = unknown> = PassThrough<I, TooltipPassThroughOptions<I>>;

export type { TooltipEvent, TooltipPassThrough, TooltipPassThroughOptions, TooltipPosition };