SheetXL - v1.0.2
    Preparing search index...

    Interface FloatStackOptions

    interface FloatStackOptions {
        anchor?: any;
        autoFocus?: boolean;
        disableClickAway?: boolean | ((target: EventTarget | null) => boolean);
        label?: string;
        onClose?: () => void;
        onOpen?: () => void;
        parentFloat?: FloatReference;
        propsPopper?: Partial<Omit<FloatPopperProps, "children" | "ref">>;
        renderFloatPanel?: RenderFloatPanel;
        renderPopupPanel?: RenderSlotFn<FloatPopupPanelProps> | null;
    }
    Index
    anchor? autoFocus? disableClickAway? label? onClose? onOpen? parentFloat? propsPopper? renderFloatPanel? renderPopupPanel?
    anchor?: any
    autoFocus?: boolean

    Whether the panel grabs focus when it opens.

    true (menus / dialogs / anything the user tabs through). Pass false for a passive popup — a tooltip or function/argument hint that must not steal focus from the field being typed in.

    disableClickAway?: boolean | ((target: EventTarget | null) => boolean)

    Suppress the light-dismiss (close on outside mousedown / touch / focus).

    false.

    • true — never light-dismiss; the caller drives visibility entirely (via open/close).
    • a predicate (target) => boolean — light-dismiss normally, EXCEPT when it returns true for the event target, which is then treated as "on the float" (no close). Use this to extend "not away" beyond the float + anchor — e.g. a caret-following formula hint keeps the click-away, but exempts clicks back into the editor it annotates (which the portaled float doesn't contain), so those don't close it.
    label?: string
    onClose?: () => void
    onOpen?: () => void
    parentFloat?: FloatReference

    If nesting float stacks are being used pass this from parent

    propsPopper?: Partial<Omit<FloatPopperProps, "children" | "ref">>

    Passed to the underlying popup panel. children is excluded — content comes from renderPopupPanel, and this keeps the option compatible with richer surface popper types (e.g. MUI's render-prop children).

    renderFloatPanel?: RenderFloatPanel

    Render the floating panel surface. Defaults to FloatPanel. Provide this to inject a custom surface (e.g. a themed card).

    renderPopupPanel?: RenderSlotFn<FloatPopupPanelProps> | null

    The float's content. null shows no popup but keeps the float in the stack — for toolbars and other always-visible components that take part in the movable stacking.

    Settings
    Member Visibility

    On This Page
    Properties