UI Headless Runtime API - v1.0.0
    Preparing search index...

    Interface TooltipOptions

    Tooltip delay, scope, state, and positioning options.

    interface TooltipOptions {
        closeDelay?: number;
        defaultValue?: boolean;
        getValue?: () => boolean;
        id?: string;
        onValueChange?: (
            value: boolean,
            details: ChangeDetails<OpenChangeReason>,
        ) => void;
        openDelay?: number;
        positioning?: FloatingPositionOptions;
        scope?: string;
        subscribeValue?: (listener: () => void) => Unsubscribe;
    }

    Hierarchy

    Index

    Properties

    closeDelay? defaultValue? getValue? id? onValueChange? openDelay? positioning? scope? subscribeValue?

    Properties

    closeDelay?: number

    Delay before pointer-triggered closing in milliseconds.

    100

    defaultValue?: boolean

    Initial value used only in uncontrolled mode.

    getValue?: () => boolean

    Reads the consumer-owned value. Its presence enables controlled mode.

    id?: string

    Deterministic relationship ID base.

    onValueChange?: (
        value: boolean,
        details: ChangeDetails<OpenChangeReason>,
    ) => void

    Receives every accepted value request and its typed cause.

    openDelay?: number

    Delay before pointer-triggered opening in milliseconds.

    700

    positioning?: FloatingPositionOptions

    Shared anchored positioning options.

    scope?: string

    Scope in which only one tooltip may be active.

    default

    subscribeValue?: (listener: () => void) => Unsubscribe

    Subscribes to consumer-owned value changes in controlled mode.

    Settings

    Member Visibility

    On This Page

    Properties