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

    Interface PopoverOptions

    Popover options for state, dismissal, focus, and collision-aware positioning.

    interface PopoverOptions {
        closeOnFocusOutside?: boolean;
        defaultValue?: boolean;
        focusContent?: boolean;
        getValue?: () => boolean;
        id?: string;
        onValueChange?: (
            value: boolean,
            details: ChangeDetails<OpenChangeReason>,
        ) => void;
        positioning?: FloatingPositionOptions;
        restoreFocus?: boolean;
        subscribeValue?: (listener: () => void) => Unsubscribe;
    }

    Hierarchy

    Index

    Properties

    closeOnFocusOutside? defaultValue? focusContent? getValue? id? onValueChange? positioning? restoreFocus? subscribeValue?

    Properties

    closeOnFocusOutside?: boolean

    Closes on outside focus when true.

    true

    defaultValue?: boolean

    Initial value used only in uncontrolled mode.

    focusContent?: boolean

    Moves initial focus into the popover when true.

    false

    getValue?: () => boolean

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

    id?: string

    Deterministic popover ID.

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

    Receives every accepted value request and its typed cause.

    positioning?: FloatingPositionOptions

    Shared placement and collision configuration.

    restoreFocus?: boolean

    Restores trigger focus after keyboard dismissal.

    true

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

    Subscribes to consumer-owned value changes in controlled mode.

    Settings

    Member Visibility

    On This Page

    Properties