@types/atom/src/tooltip-manager.d.ts

TypeScript definitions for atom

import { Disposable, Tooltip } from "../index";

export type TooltipPlacement =
    | "top"
    | "bottom"
    | "left"
    | "right"
    | "auto"
    | "auto top"
    | "auto bottom"
    | "auto left"
    | "auto right";

/** Associates tooltips with HTML elements or selectors. */
export interface TooltipManager {
    /** Add a tooltip to the given element. */
    add(
        target: HTMLElement | JQueryCompatible,
        options:
            | {
                item?: object | undefined;
            }
            | ({
                title?: string | (() => string) | undefined;
                html?: boolean | undefined;
                keyBindingCommand?: string | undefined;
                keyBindingTarget?: HTMLElement | undefined;
            } & {
                class?: string | undefined;
                placement?: TooltipPlacement | (() => TooltipPlacement) | undefined;
                trigger?: "click" | "hover" | "focus" | "manual" | undefined;
                delay?: { show: number; hide: number } | undefined;
            }),
    ): Disposable;

    /** Find the tooltips that have been applied to the given element. */
    findTooltips(target: HTMLElement): Tooltip[];
}

export interface JQueryCompatible<Element extends Node = HTMLElement> extends Iterable<Element> {
    jquery: string;
}