@svelte-plugins/tooltips/src/tooltip.d.ts

A simple tooltip action and component designed for Svelte.

import { SvelteComponent } from 'svelte';

export interface TooltipProps {
  /**
   * The action to trigger the tooltip
   * @default 'hover'
   */
  action?: 'hover' | 'click' | 'prop' | string;

  /**
   * The alignment of the tooltip.
   * @default 'left'
   */
  align?: 'left' | 'right' | 'center' | string;

  /**
   * The animation style of the tooltip.
   * @default ''
   */
  animation?: string;

  /**
   * Whether to show the arrow of the tooltip.
   * @default true
   */
  arrow?: boolean;

  /**
   * Whether to automatically position the tooltip when clipping occurs.
   * @default false
   */
  autoPosition?: boolean;

  /**
   * The content of the tooltip.
   * @default ''
   */
  content?: string;

  /**
   * The animation's delay of the tooltip.
   * @default 200
   */
  delay?: number;

  /**
   * Whether to hide the tooltip when clicking outside.
   * Only works when action is set to 'click'.
   * @default false
   */
  hideOnClickOutside?: boolean;

  /**
   * The maximum width of the tooltip.
   * @default 200
   */
  maxWidth?: number;

  /**
   * The position of the tooltip.
   * @default 'top'
   */
  position?: 'bottom' | 'left' | 'right' | 'top' | string;

  /**
   * Control the visibility of the tooltip.
   * @default false
   */
  show?: boolean;

  /**
   * The style of the tooltip.
   * @default null
   */
  style?: undefined;

  /**
   * The theme of the tooltip.
   * @default ''
   */
  theme?: string;
}

export interface TooltipEvents {}

export interface TooltipSlots {
  default: {};
}

export default class Tooltip extends SvelteComponent<
  TooltipProps,
  TooltipEvents,
  TooltipSlots
> {}