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>;
        selectedKeys?: "all" | Iterable<Key, any, any>;
        selectionMode?: SelectionMode;
        style?: CSSProperties;
        title: string;
        translate?: "yes" | "no";
        value?: T;
    }

    Type Parameters

    • T

    Hierarchy

    • MenuSectionProps<T>
    • Omit<RAMenuSectionProps<T>, "children">
      • MenuSectionProps
    Index

    Properties

    "aria-label"?: string

    An accessibility label for the section.

    children: ReactNode

    Static child items or a function to render children.

    className?: string

    The CSS className for the element.

    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>
    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.

    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.