Circle V2 API Docs
    Preparing search index...

    Interface TooltipRootProps

    interface TooltipRootProps {
        "aria-label"?: string;
        children?: ReactNode;
        closeDelay?: number;
        closeOnClick?: boolean;
        closeOnEscape?: boolean;
        closeOnPointerDown?: boolean;
        closeOnScroll?: boolean;
        defaultOpen?: boolean;
        disabled?: boolean;
        id?: string;
        ids?: Partial<
            { arrow: string; content: string; positioner: string; trigger: string },
        >;
        immediate?: boolean;
        interactive?: boolean;
        lazyMount?: boolean;
        onExitComplete?: VoidFunction;
        onOpenChange?: (details: OpenChangeDetails) => void;
        open?: boolean;
        openDelay?: number;
        positioning?: PositioningOptions;
        present?: boolean;
        recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>;
        skipAnimationOnMount?: boolean;
        unmountOnExit?: boolean;
        unstyled?: boolean;
    }

    Hierarchy

    • TooltipRootBaseProps
      • TooltipRootProps
    Index

    Properties

    aria-label? children? closeDelay? closeOnClick? closeOnEscape? closeOnPointerDown? closeOnScroll? defaultOpen? disabled? id? ids? immediate? interactive? lazyMount? onExitComplete? onOpenChange? open? openDelay? positioning? present? recipe? skipAnimationOnMount? unmountOnExit? unstyled?

    Properties

    "aria-label"?: string

    Custom label for the tooltip.

    children?: ReactNode
    closeDelay?: number

    The close delay of the tooltip.

    150
    closeOnClick?: boolean

    Whether the tooltip should close on click

    true
    closeOnEscape?: boolean

    Whether to close the tooltip when the Escape key is pressed.

    true
    closeOnPointerDown?: boolean

    Whether to close the tooltip on pointerdown.

    true
    closeOnScroll?: boolean

    Whether the tooltip should close on scroll

    true
    defaultOpen?: boolean

    The initial open state of the tooltip when rendered. Use when you don't need to control the open state of the tooltip.

    disabled?: boolean

    Whether the tooltip is disabled

    id?: string

    The unique identifier of the machine.

    ids?: Partial<
        { arrow: string; content: string; positioner: string; trigger: string },
    >

    The ids of the elements in the tooltip. Useful for composition.

    immediate?: boolean

    Whether to synchronize the present change immediately or defer it to the next frame

    interactive?: boolean

    Whether the tooltip's content is interactive. In this mode, the tooltip will remain open when user hovers over the content.

    https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus

    false
    lazyMount?: boolean

    Whether to enable lazy mounting

    false
    onExitComplete?: VoidFunction

    Function called when the animation ends in the closed state

    onOpenChange?: (details: OpenChangeDetails) => void

    Function called when the tooltip is opened.

    open?: boolean

    The controlled open state of the tooltip

    openDelay?: number

    The open delay of the tooltip.

    400
    positioning?: PositioningOptions

    The user provided options used to position the popover content

    present?: boolean

    Whether the node is present (controlled by the user)

    recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>
    skipAnimationOnMount?: boolean

    Whether to allow the initial presence animation.

    false
    unmountOnExit?: boolean

    Whether to unmount on exit.

    false
    unstyled?: boolean

    If true, the element will opt out of the theme styles.

    Settings

    Member Visibility

    On This Page

    Properties