Backstage
    Preparing search index...

    Interface MenuSectionProps<T>

    interface MenuSectionProps<T> {
        "aria-label"?: string;
        children: ReactNode;
        className?: string;
        defaultSelectedKeys?: "all" | Iterable<Key, any, any>;
        dependencies?: readonly any[];
        dir?: string;
        disabledKeys?: Iterable<Key, any, any>;
        disallowEmptySelection?: boolean;
        hidden?: boolean;
        id?: Key;
        inert?: boolean;
        items?: Iterable<T, any, any>;
        lang?: string;
        onAnimationEnd?: AnimationEventHandler<HTMLElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>;
        onAnimationStart?: AnimationEventHandler<HTMLElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLElement>;
        onAuxClick?: MouseEventHandler<HTMLElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLElement>;
        onClick?: MouseEventHandler<HTMLElement>;
        onClickCapture?: MouseEventHandler<HTMLElement>;
        onContextMenu?: MouseEventHandler<HTMLElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLElement>;
        onDoubleClick?: MouseEventHandler<HTMLElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>;
        onMouseDown?: MouseEventHandler<HTMLElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLElement>;
        onMouseEnter?: MouseEventHandler<HTMLElement>;
        onMouseLeave?: MouseEventHandler<HTMLElement>;
        onMouseMove?: MouseEventHandler<HTMLElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLElement>;
        onMouseOut?: MouseEventHandler<HTMLElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLElement>;
        onMouseOver?: MouseEventHandler<HTMLElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLElement>;
        onMouseUp?: MouseEventHandler<HTMLElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLElement>;
        onPointerCancel?: PointerEventHandler<HTMLElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLElement>;
        onPointerDown?: PointerEventHandler<HTMLElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLElement>;
        onPointerEnter?: PointerEventHandler<HTMLElement>;
        onPointerLeave?: PointerEventHandler<HTMLElement>;
        onPointerMove?: PointerEventHandler<HTMLElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLElement>;
        onPointerOut?: PointerEventHandler<HTMLElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLElement>;
        onPointerOver?: PointerEventHandler<HTMLElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLElement>;
        onPointerUp?: PointerEventHandler<HTMLElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLElement>;
        onScroll?: UIEventHandler<HTMLElement>;
        onScrollCapture?: UIEventHandler<HTMLElement>;
        onSelectionChange?: (keys: Selection) => void;
        onTouchCancel?: TouchEventHandler<HTMLElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLElement>;
        onTouchEnd?: TouchEventHandler<HTMLElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLElement>;
        onTouchMove?: TouchEventHandler<HTMLElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLElement>;
        onTouchStart?: TouchEventHandler<HTMLElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLElement>;
        onTransitionRun?: TransitionEventHandler<HTMLElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLElement>;
        onTransitionStart?: TransitionEventHandler<HTMLElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLElement>;
        onWheel?: WheelEventHandler<HTMLElement>;
        onWheelCapture?: WheelEventHandler<HTMLElement>;
        render?: DOMRenderFunction<"section", undefined>;
        selectedKeys?: "all" | Iterable<Key, any, any>;
        selectionMode?: SelectionMode;
        shouldCloseOnSelect?: boolean;
        style?: CSSProperties;
        title: string;
        translate?: "yes" | "no";
        value?: T;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index
    aria-label? children className? defaultSelectedKeys? dependencies? dir? disabledKeys? disallowEmptySelection? hidden? id? inert? items? lang? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onClick? onClickCapture? onContextMenu? onContextMenuCapture? onDoubleClick? onDoubleClickCapture? onGotPointerCapture? onGotPointerCaptureCapture? onLostPointerCapture? onLostPointerCaptureCapture? onMouseDown? onMouseDownCapture? onMouseEnter? onMouseLeave? onMouseMove? onMouseMoveCapture? onMouseOut? onMouseOutCapture? onMouseOver? onMouseOverCapture? onMouseUp? onMouseUpCapture? onPointerCancel? onPointerCancelCapture? onPointerDown? onPointerDownCapture? onPointerEnter? onPointerLeave? onPointerMove? onPointerMoveCapture? onPointerOut? onPointerOutCapture? onPointerOver? onPointerOverCapture? onPointerUp? onPointerUpCapture? onScroll? onScrollCapture? onSelectionChange? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onWheel? onWheelCapture? render? selectedKeys? selectionMode? shouldCloseOnSelect? style? title translate? value?
    "aria-label"?: string

    An accessibility label for the section.

    children: ReactNode
    className?: string
    defaultSelectedKeys?: "all" | Iterable<Key, any, any>

    The initial selected keys in the collection (uncontrolled).

    dependencies?: readonly any[]

    Values that should invalidate the item cache when using dynamic collections.

    dir?: string
    disabledKeys?: Iterable<Key, any, any>

    The currently disabled keys in the collection (controlled).

    disallowEmptySelection?: boolean

    Whether the collection allows empty selection.

    hidden?: boolean
    id?: Key

    The unique id of the section.

    inert?: boolean
    items?: Iterable<T, any, any>

    Item objects in the section.

    lang?: string
    onAnimationEnd?: AnimationEventHandler<HTMLElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLElement>
    onAnimationIteration?: AnimationEventHandler<HTMLElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLElement>
    onAnimationStart?: AnimationEventHandler<HTMLElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLElement>
    onAuxClick?: MouseEventHandler<HTMLElement>
    onAuxClickCapture?: MouseEventHandler<HTMLElement>
    onClick?: MouseEventHandler<HTMLElement>
    onClickCapture?: MouseEventHandler<HTMLElement>
    onContextMenu?: MouseEventHandler<HTMLElement>
    onContextMenuCapture?: MouseEventHandler<HTMLElement>
    onDoubleClick?: MouseEventHandler<HTMLElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLElement>
    onGotPointerCapture?: PointerEventHandler<HTMLElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLElement>
    onLostPointerCapture?: PointerEventHandler<HTMLElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLElement>
    onMouseDown?: MouseEventHandler<HTMLElement>
    onMouseDownCapture?: MouseEventHandler<HTMLElement>
    onMouseEnter?: MouseEventHandler<HTMLElement>
    onMouseLeave?: MouseEventHandler<HTMLElement>
    onMouseMove?: MouseEventHandler<HTMLElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLElement>
    onMouseOut?: MouseEventHandler<HTMLElement>
    onMouseOutCapture?: MouseEventHandler<HTMLElement>
    onMouseOver?: MouseEventHandler<HTMLElement>
    onMouseOverCapture?: MouseEventHandler<HTMLElement>
    onMouseUp?: MouseEventHandler<HTMLElement>
    onMouseUpCapture?: MouseEventHandler<HTMLElement>
    onPointerCancel?: PointerEventHandler<HTMLElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLElement>
    onPointerDown?: PointerEventHandler<HTMLElement>
    onPointerDownCapture?: PointerEventHandler<HTMLElement>
    onPointerEnter?: PointerEventHandler<HTMLElement>
    onPointerLeave?: PointerEventHandler<HTMLElement>
    onPointerMove?: PointerEventHandler<HTMLElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLElement>
    onPointerOut?: PointerEventHandler<HTMLElement>
    onPointerOutCapture?: PointerEventHandler<HTMLElement>
    onPointerOver?: PointerEventHandler<HTMLElement>
    onPointerOverCapture?: PointerEventHandler<HTMLElement>
    onPointerUp?: PointerEventHandler<HTMLElement>
    onPointerUpCapture?: PointerEventHandler<HTMLElement>
    onScroll?: UIEventHandler<HTMLElement>
    onScrollCapture?: UIEventHandler<HTMLElement>
    onSelectionChange?: (keys: Selection) => void

    Handler that is called when the selection changes.

    onTouchCancel?: TouchEventHandler<HTMLElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLElement>
    onTouchEnd?: TouchEventHandler<HTMLElement>
    onTouchEndCapture?: TouchEventHandler<HTMLElement>
    onTouchMove?: TouchEventHandler<HTMLElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLElement>
    onTouchStart?: TouchEventHandler<HTMLElement>
    onTouchStartCapture?: TouchEventHandler<HTMLElement>
    onTransitionCancel?: TransitionEventHandler<HTMLElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLElement>
    onTransitionEnd?: TransitionEventHandler<HTMLElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLElement>
    onTransitionRun?: TransitionEventHandler<HTMLElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLElement>
    onTransitionStart?: TransitionEventHandler<HTMLElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLElement>
    onWheel?: WheelEventHandler<HTMLElement>
    onWheelCapture?: WheelEventHandler<HTMLElement>
    render?: DOMRenderFunction<"section", undefined>

    Overrides the default DOM element with a custom render function. This allows rendering existing components with built-in styles and behaviors such as router links, animation libraries, and pre-styled components.

    Requirements:

    • You must render the expected element type (e.g. if <button> is expected, you cannot render an <a>).
    • Only a single root DOM element can be rendered (no fragments).
    • You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
    selectedKeys?: "all" | Iterable<Key, any, any>

    The currently selected keys in the collection (controlled).

    selectionMode?: SelectionMode

    The type of selection that is allowed in the collection.

    shouldCloseOnSelect?: boolean

    Whether the menu should close when the menu item is selected.

    style?: CSSProperties

    The inline style for the element.

    title: string
    translate?: "yes" | "no"
    value?: T

    The object value that this section represents. When using dynamic collections, this is set automatically.

    Settings
    Member Visibility

    On This Page
    Properties
    aria-labelchildrenclassNamedefaultSelectedKeysdependenciesdirdisabledKeysdisallowEmptySelectionhiddenidinertitemslangonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonGotPointerCaptureonGotPointerCaptureCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonScrollonScrollCaptureonSelectionChangeonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderselectedKeysselectionModeshouldCloseOnSelectstyletitletranslatevalue