Backstage
    Preparing search index...

    Interface TableRootProps

    interface TableRootProps {
        "aria-describedby"?: string;
        "aria-details"?: string;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        children?: ReactNode;
        className?: ClassNameOrFunction<TableRenderProps>;
        defaultExpandedKeys?: Iterable<Key, any, any>;
        defaultSelectedKeys?: "all" | Iterable<Key, any, any>;
        dir?: string;
        disabledBehavior?: DisabledBehavior;
        disabledKeys?: Iterable<Key, any, any>;
        disallowEmptySelection?: boolean;
        dragAndDropHooks?: DragAndDropHooks;
        escapeKeyBehavior?: "none" | "clearSelection";
        expandedKeys?: Iterable<Key, any, any>;
        hidden?: boolean;
        inert?: boolean;
        lang?: string;
        loading?: boolean;
        onAnimationEnd?: AnimationEventHandler<HTMLTableElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLTableElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLTableElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLTableElement>;
        onAnimationStart?: AnimationEventHandler<HTMLTableElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLTableElement>;
        onAuxClick?: MouseEventHandler<HTMLTableElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLTableElement>;
        onClick?: MouseEventHandler<HTMLTableElement>;
        onClickCapture?: MouseEventHandler<HTMLTableElement>;
        onContextMenu?: MouseEventHandler<HTMLTableElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLTableElement>;
        onDoubleClick?: MouseEventHandler<HTMLTableElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLTableElement>;
        onExpandedChange?: (keys: Set<Key>) => any;
        onGotPointerCapture?: PointerEventHandler<HTMLTableElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLTableElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableElement>;
        onMouseDown?: MouseEventHandler<HTMLTableElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLTableElement>;
        onMouseEnter?: MouseEventHandler<HTMLTableElement>;
        onMouseLeave?: MouseEventHandler<HTMLTableElement>;
        onMouseMove?: MouseEventHandler<HTMLTableElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLTableElement>;
        onMouseOut?: MouseEventHandler<HTMLTableElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLTableElement>;
        onMouseOver?: MouseEventHandler<HTMLTableElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLTableElement>;
        onMouseUp?: MouseEventHandler<HTMLTableElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLTableElement>;
        onPointerCancel?: PointerEventHandler<HTMLTableElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLTableElement>;
        onPointerDown?: PointerEventHandler<HTMLTableElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLTableElement>;
        onPointerEnter?: PointerEventHandler<HTMLTableElement>;
        onPointerLeave?: PointerEventHandler<HTMLTableElement>;
        onPointerMove?: PointerEventHandler<HTMLTableElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLTableElement>;
        onPointerOut?: PointerEventHandler<HTMLTableElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLTableElement>;
        onPointerOver?: PointerEventHandler<HTMLTableElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLTableElement>;
        onPointerUp?: PointerEventHandler<HTMLTableElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLTableElement>;
        onRowAction?: (key: Key) => void;
        onScroll?: UIEventHandler<HTMLTableElement>;
        onScrollCapture?: UIEventHandler<HTMLTableElement>;
        onSelectionChange?: (keys: Selection) => void;
        onSortChange?: (descriptor: SortDescriptor) => any;
        onTouchCancel?: TouchEventHandler<HTMLTableElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLTableElement>;
        onTouchEnd?: TouchEventHandler<HTMLTableElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLTableElement>;
        onTouchMove?: TouchEventHandler<HTMLTableElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLTableElement>;
        onTouchStart?: TouchEventHandler<HTMLTableElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLTableElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLTableElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLTableElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLTableElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLTableElement>;
        onTransitionRun?: TransitionEventHandler<HTMLTableElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLTableElement>;
        onTransitionStart?: TransitionEventHandler<HTMLTableElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLTableElement>;
        onWheel?: WheelEventHandler<HTMLTableElement>;
        onWheelCapture?: WheelEventHandler<HTMLTableElement>;
        render?: DOMRenderFunction<"div" | "table", TableRenderProps>;
        selectedKeys?: "all" | Iterable<Key, any, any>;
        selectionBehavior?: SelectionBehavior;
        selectionMode?: SelectionMode;
        shouldSelectOnPressUp?: boolean;
        slot?: string | null;
        sortDescriptor?: SortDescriptor;
        stale?: boolean;
        style?: StyleOrFunction<TableRenderProps>;
        translate?: "yes" | "no";
        treeColumn?: Key;
    }

    Hierarchy (View Summary)

    Index

    Properties

    aria-describedby? aria-details? aria-label? aria-labelledby? children? className? defaultExpandedKeys? defaultSelectedKeys? dir? disabledBehavior? disabledKeys? disallowEmptySelection? dragAndDropHooks? escapeKeyBehavior? expandedKeys? hidden? inert? lang? loading? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onClick? onClickCapture? onContextMenu? onContextMenuCapture? onDoubleClick? onDoubleClickCapture? onExpandedChange? 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? onRowAction? onScroll? onScrollCapture? onSelectionChange? onSortChange? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onWheel? onWheelCapture? render? selectedKeys? selectionBehavior? selectionMode? shouldSelectOnPressUp? slot? sortDescriptor? stale? style? translate? treeColumn?

    Properties

    "aria-describedby"?: string

    Identifies the element (or elements) that describes the object.

    "aria-details"?: string

    Identifies the element (or elements) that provide a detailed, extended description for the object.

    "aria-label"?: string

    Defines a string value that labels the current element.

    "aria-labelledby"?: string

    Identifies the element (or elements) that labels the current element.

    children?: ReactNode

    The elements that make up the table. Includes the TableHeader, TableBody, Columns, and Rows.

    className?: ClassNameOrFunction<TableRenderProps>

    The CSS className for the element. A function may be provided to compute the class based on component state.

    'react-aria-Table'
    defaultExpandedKeys?: Iterable<Key, any, any>

    The initial expanded keys in the collection (uncontrolled).

    defaultSelectedKeys?: "all" | Iterable<Key, any, any>

    The initial selected keys in the collection (uncontrolled).

    dir?: string
    disabledBehavior?: DisabledBehavior

    Whether disabledKeys applies to all interactions, or only selection.

    "all"
    disabledKeys?: Iterable<Key, any, any>

    A list of row keys to disable.

    disallowEmptySelection?: boolean

    Whether the collection allows empty selection.

    dragAndDropHooks?: DragAndDropHooks

    The drag and drop hooks returned by useDragAndDrop used to enable drag and drop behavior for the Table.

    escapeKeyBehavior?: "none" | "clearSelection"

    Whether pressing the escape key should clear selection in the table or not.

    Most experiences should not modify this option as it eliminates a keyboard user's ability to easily clear selection. Only use if the escape key is being handled externally or should not trigger selection clearing contextually.

    'clearSelection'
    expandedKeys?: Iterable<Key, any, any>

    The currently expanded keys in the collection (controlled).

    hidden?: boolean
    inert?: boolean
    lang?: string
    loading?: boolean
    onAnimationEnd?: AnimationEventHandler<HTMLTableElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLTableElement>
    onAnimationIteration?: AnimationEventHandler<HTMLTableElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLTableElement>
    onAnimationStart?: AnimationEventHandler<HTMLTableElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLTableElement>
    onAuxClick?: MouseEventHandler<HTMLTableElement>
    onAuxClickCapture?: MouseEventHandler<HTMLTableElement>
    onClick?: MouseEventHandler<HTMLTableElement>
    onClickCapture?: MouseEventHandler<HTMLTableElement>
    onContextMenu?: MouseEventHandler<HTMLTableElement>
    onContextMenuCapture?: MouseEventHandler<HTMLTableElement>
    onDoubleClick?: MouseEventHandler<HTMLTableElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLTableElement>
    onExpandedChange?: (keys: Set<Key>) => any

    Handler that is called when items are expanded or collapsed.

    onGotPointerCapture?: PointerEventHandler<HTMLTableElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableElement>
    onLostPointerCapture?: PointerEventHandler<HTMLTableElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableElement>
    onMouseDown?: MouseEventHandler<HTMLTableElement>
    onMouseDownCapture?: MouseEventHandler<HTMLTableElement>
    onMouseEnter?: MouseEventHandler<HTMLTableElement>
    onMouseLeave?: MouseEventHandler<HTMLTableElement>
    onMouseMove?: MouseEventHandler<HTMLTableElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLTableElement>
    onMouseOut?: MouseEventHandler<HTMLTableElement>
    onMouseOutCapture?: MouseEventHandler<HTMLTableElement>
    onMouseOver?: MouseEventHandler<HTMLTableElement>
    onMouseOverCapture?: MouseEventHandler<HTMLTableElement>
    onMouseUp?: MouseEventHandler<HTMLTableElement>
    onMouseUpCapture?: MouseEventHandler<HTMLTableElement>
    onPointerCancel?: PointerEventHandler<HTMLTableElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLTableElement>
    onPointerDown?: PointerEventHandler<HTMLTableElement>
    onPointerDownCapture?: PointerEventHandler<HTMLTableElement>
    onPointerEnter?: PointerEventHandler<HTMLTableElement>
    onPointerLeave?: PointerEventHandler<HTMLTableElement>
    onPointerMove?: PointerEventHandler<HTMLTableElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLTableElement>
    onPointerOut?: PointerEventHandler<HTMLTableElement>
    onPointerOutCapture?: PointerEventHandler<HTMLTableElement>
    onPointerOver?: PointerEventHandler<HTMLTableElement>
    onPointerOverCapture?: PointerEventHandler<HTMLTableElement>
    onPointerUp?: PointerEventHandler<HTMLTableElement>
    onPointerUpCapture?: PointerEventHandler<HTMLTableElement>
    onRowAction?: (key: Key) => void

    Handler that is called when a user performs an action on the row.

    onScroll?: UIEventHandler<HTMLTableElement>
    onScrollCapture?: UIEventHandler<HTMLTableElement>
    onSelectionChange?: (keys: Selection) => void

    Handler that is called when the selection changes.

    onSortChange?: (descriptor: SortDescriptor) => any

    Handler that is called when the sorted column or direction changes.

    onTouchCancel?: TouchEventHandler<HTMLTableElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLTableElement>
    onTouchEnd?: TouchEventHandler<HTMLTableElement>
    onTouchEndCapture?: TouchEventHandler<HTMLTableElement>
    onTouchMove?: TouchEventHandler<HTMLTableElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLTableElement>
    onTouchStart?: TouchEventHandler<HTMLTableElement>
    onTouchStartCapture?: TouchEventHandler<HTMLTableElement>
    onTransitionCancel?: TransitionEventHandler<HTMLTableElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLTableElement>
    onTransitionEnd?: TransitionEventHandler<HTMLTableElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLTableElement>
    onTransitionRun?: TransitionEventHandler<HTMLTableElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLTableElement>
    onTransitionStart?: TransitionEventHandler<HTMLTableElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLTableElement>
    onWheel?: WheelEventHandler<HTMLTableElement>
    onWheelCapture?: WheelEventHandler<HTMLTableElement>
    render?: DOMRenderFunction<"div" | "table", TableRenderProps>

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

    selectionBehavior?: SelectionBehavior

    How multiple selection should behave in the collection.

    "toggle"
    selectionMode?: SelectionMode

    The type of selection that is allowed in the collection.

    shouldSelectOnPressUp?: boolean

    Whether selection should occur on press up instead of press down.

    slot?: string | null

    A slot name for the component. Slots allow the component to receive props from a parent component. An explicit null value indicates that the local props completely override all props received from a parent.

    sortDescriptor?: SortDescriptor

    The current sorted column and direction.

    stale?: boolean
    style?: StyleOrFunction<TableRenderProps>

    The inline style for the element. A function may be provided to compute the style based on component state.

    translate?: "yes" | "no"
    treeColumn?: Key

    The id of the column that displays hierarchical data.

    Settings

    Member Visibility

    On This Page

    Properties
    aria-describedbyaria-detailsaria-labelaria-labelledbychildrenclassNamedefaultExpandedKeysdefaultSelectedKeysdirdisabledBehaviordisabledKeysdisallowEmptySelectiondragAndDropHooksescapeKeyBehaviorexpandedKeyshiddeninertlangloadingonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonExpandedChangeonGotPointerCaptureonGotPointerCaptureCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonRowActiononScrollonScrollCaptureonSelectionChangeonSortChangeonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderselectedKeysselectionBehaviorselectionModeshouldSelectOnPressUpslotsortDescriptorstalestyletranslatetreeColumn