Circle V2 API Docs
    Preparing search index...

    Interface HoverCardRootProps

    interface HoverCardRootProps {
        children: ReactNode;
        closeDelay?: number;
        defaultOpen?: boolean;
        disabled?: boolean;
        id?: string;
        ids?: Partial<
            { arrow: string; content: string; positioner: string; trigger: string },
        >;
        immediate?: boolean;
        lazyMount?: boolean;
        onExitComplete?: VoidFunction;
        onFocusOutside?: (event: Combobox.FocusOutsideEvent) => void;
        onInteractOutside?: (event: Combobox.InteractOutsideEvent) => void;
        onOpenChange?: (details: OpenChangeDetails) => void;
        onPointerDownOutside?: (event: Combobox.PointerDownOutsideEvent) => void;
        open?: boolean;
        openDelay?: number;
        positioning?: PositioningOptions;
        present?: boolean;
        recipe?: SlotRecipeDefinition<string, SlotRecipeVariantRecord<string>>;
        size?: ConditionalValue<"sm" | "md" | "lg" | "xs" | undefined>;
        skipAnimationOnMount?: boolean;
        unmountOnExit?: boolean;
        unstyled?: boolean;
    }

    Hierarchy

    • HoverCardRootBaseProps
      • HoverCardRootProps
    Index

    Properties

    children closeDelay? defaultOpen? disabled? id? ids? immediate? lazyMount? onExitComplete? onFocusOutside? onInteractOutside? onOpenChange? onPointerDownOutside? open? openDelay? positioning? present? recipe? size? skipAnimationOnMount? unmountOnExit? unstyled?

    Properties

    children: ReactNode
    closeDelay?: number

    The duration from when the mouse leaves the trigger or content until the hover card closes.

    300
    defaultOpen?: boolean

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

    disabled?: boolean

    Whether the hover card 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 popover. Useful for composition.

    immediate?: boolean

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

    lazyMount?: boolean

    Whether to enable lazy mounting

    false
    onExitComplete?: VoidFunction

    Function called when the animation ends in the closed state

    onFocusOutside?: (event: Combobox.FocusOutsideEvent) => void

    Function called when the focus is moved outside the component

    onInteractOutside?: (event: Combobox.InteractOutsideEvent) => void

    Function called when an interaction happens outside the component

    onOpenChange?: (details: OpenChangeDetails) => void

    Function called when the hover card opens or closes.

    onPointerDownOutside?: (event: Combobox.PointerDownOutsideEvent) => void

    Function called when the pointer is pressed down outside the component

    open?: boolean

    The controlled open state of the hover card

    openDelay?: number

    The duration from when the mouse enters the trigger until the hover card opens.

    600
    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>>
    size?: ConditionalValue<"sm" | "md" | "lg" | "xs" | undefined>
    "md"
    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