ink-cartridge
    Preparing search index...

    Type Alias MouseRegionOptions

    type MouseRegionOptions = {
        clickOnFocus?: boolean;
        clickOnRise?: boolean;
        dragOnRise?: boolean;
        enterOnFocus?: boolean;
        enterOnRise?: boolean;
        layerId?: string;
        leaveOffFocus?: boolean;
        leaveOffRise?: boolean;
        priority?: number;
        ref?: RefObject<DOMElement | null>;
        regionId?: string;
        wheelOnRise?: boolean;
    }
    Index
    clickOnFocus?: boolean
    clickOnRise?: boolean

    When true, clicking this region raises the surrounding regular layer above all other layers via bringLayerToFront (zIndex = max + 1), before the user's own onClick runs. Ineffective on modal layers — while a modal is open it owns all mouse hit-testing, and regular layers never rise above modals — and outside any layer.

    dragOnRise?: boolean

    When true, starting a drag on this region raises the surrounding regular layer above all other layers, before the user's own onDragStart runs. Same modal/root exclusions as clickOnRise.

    enterOnFocus?: boolean
    enterOnRise?: boolean

    When true, the mouse entering this region raises the surrounding regular layer above all other layers, before the user's own onEnter runs. Combine with leaveOffRise to lower the layer again on leave. Same modal/root exclusions as clickOnRise.

    layerId?: string
    leaveOffFocus?: boolean
    leaveOffRise?: boolean

    Whether leaving the region restores the layer's initial zIndex (undoes the enterOnRise raise). Only applies when enterOnRise is set; defaults to true.

    priority?: number
    ref?: RefObject<DOMElement | null>

    Ref to register the region under and key the region-focus map with, instead of a hook-created ref. Pass the same ref object you give to boundKeyboard(..., { ref, focusId }) so a click on the region forwards focus to that binding. Only object refs can key the focus map — a callback ref is rejected (falls back to an internal ref, losing the focus link).

    regionId?: string
    wheelOnRise?: boolean

    When true, a wheel event over this region raises the surrounding regular layer above all other layers, before the user's own onWheel runs. Same modal/root exclusions as clickOnRise.