Backstage
    Preparing search index...

    Interface ColumnProps

    interface ColumnProps {
        allowsArrowNavigation?: boolean;
        allowsSorting?: boolean;
        children?: ReactNode;
        className?: string;
        defaultWidth?: ColumnSize | null;
        dir?: string;
        focusMode?: "cell" | "child";
        hidden?: boolean;
        id?: Key;
        inert?: boolean;
        isRowHeader?: boolean;
        lang?: string;
        maxWidth?: ColumnStaticSize | null;
        minWidth?: ColumnStaticSize | null;
        onAnimationEnd?: AnimationEventHandler<HTMLTableHeaderCellElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLTableHeaderCellElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLTableHeaderCellElement>;
        onAnimationIterationCapture?: AnimationEventHandler<
            HTMLTableHeaderCellElement,
        >;
        onAnimationStart?: AnimationEventHandler<HTMLTableHeaderCellElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLTableHeaderCellElement>;
        onAuxClick?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onClick?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onContextMenu?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onDoubleClick?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<
            HTMLTableHeaderCellElement,
        >;
        onLostPointerCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<
            HTMLTableHeaderCellElement,
        >;
        onMouseDown?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseEnter?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseLeave?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseMove?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseOut?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseOver?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseUp?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLTableHeaderCellElement>;
        onPointerCancel?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerDown?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerEnter?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerLeave?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerMove?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerOut?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerOver?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerUp?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLTableHeaderCellElement>;
        onScroll?: UIEventHandler<HTMLTableHeaderCellElement>;
        onScrollCapture?: UIEventHandler<HTMLTableHeaderCellElement>;
        onTouchCancel?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchEnd?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchMove?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchStart?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLTableHeaderCellElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionCancelCapture?: TransitionEventHandler<
            HTMLTableHeaderCellElement,
        >;
        onTransitionEnd?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionRun?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionStart?: TransitionEventHandler<HTMLTableHeaderCellElement>;
        onTransitionStartCapture?: TransitionEventHandler<
            HTMLTableHeaderCellElement,
        >;
        onWheel?: WheelEventHandler<HTMLTableHeaderCellElement>;
        onWheelCapture?: WheelEventHandler<HTMLTableHeaderCellElement>;
        render?: DOMRenderFunction<"div" | "th", ColumnRenderProps>;
        style?: StyleOrFunction<ColumnRenderProps>;
        suppressHydrationWarning?: boolean;
        textValue?: string;
        translate?: "yes" | "no";
        width?: ColumnSize | null;
    }

    Hierarchy (View Summary)

    Index
    allowsArrowNavigation? allowsSorting? children? className? defaultWidth? dir? focusMode? hidden? id? inert? isRowHeader? lang? maxWidth? minWidth? 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? onTouchCancel? onTouchCancelCapture? onTouchEnd? onTouchEndCapture? onTouchMove? onTouchMoveCapture? onTouchStart? onTouchStartCapture? onTransitionCancel? onTransitionCancelCapture? onTransitionEnd? onTransitionEndCapture? onTransitionRun? onTransitionRunCapture? onTransitionStart? onTransitionStartCapture? onWheel? onWheelCapture? render? style? suppressHydrationWarning? textValue? translate? width?
    allowsArrowNavigation?: boolean

    Whether the column should support arrow key navigation even when the containing table uses tab keyboard navigation. Allows users to navigate between columns and rows with arrow keys while focus is on an interactive child element within the column header.

    allowsSorting?: boolean

    Whether the column allows sorting.

    children?: ReactNode
    className?: string
    defaultWidth?: ColumnSize | null

    The default width of the column. This prop only applies when the <Table> is wrapped in a <ResizableTableContainer>.

    dir?: string
    focusMode?: "cell" | "child"

    Whether the column header or its first focusable child element should be focused when the column header is focused. Defaults to 'child' in arrow keyboard navigation mode and 'cell' in tab keyboard navigation mode.

    hidden?: boolean
    id?: Key

    The unique id of the column.

    inert?: boolean
    isRowHeader?: boolean

    Whether a column is a row header and should be announced by assistive technology during row navigation.

    lang?: string
    maxWidth?: ColumnStaticSize | null

    The maximum width of the column. This prop only applies when the <Table> is wrapped in a <ResizableTableContainer>.

    minWidth?: ColumnStaticSize | null

    The minimum width of the column. This prop only applies when the <Table> is wrapped in a <ResizableTableContainer>.

    onAnimationEnd?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAnimationIteration?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAnimationStart?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLTableHeaderCellElement>
    onAuxClick?: MouseEventHandler<HTMLTableHeaderCellElement>
    onAuxClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onClick?: MouseEventHandler<HTMLTableHeaderCellElement>
    onClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onContextMenu?: MouseEventHandler<HTMLTableHeaderCellElement>
    onContextMenuCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onDoubleClick?: MouseEventHandler<HTMLTableHeaderCellElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onGotPointerCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onLostPointerCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onMouseDown?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseDownCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseEnter?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseLeave?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseMove?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseOut?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseOutCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseOver?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseOverCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseUp?: MouseEventHandler<HTMLTableHeaderCellElement>
    onMouseUpCapture?: MouseEventHandler<HTMLTableHeaderCellElement>
    onPointerCancel?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerDown?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerDownCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerEnter?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerLeave?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerMove?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerOut?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerOutCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerOver?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerOverCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerUp?: PointerEventHandler<HTMLTableHeaderCellElement>
    onPointerUpCapture?: PointerEventHandler<HTMLTableHeaderCellElement>
    onScroll?: UIEventHandler<HTMLTableHeaderCellElement>
    onScrollCapture?: UIEventHandler<HTMLTableHeaderCellElement>
    onTouchCancel?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchEnd?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchEndCapture?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchMove?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchStart?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTouchStartCapture?: TouchEventHandler<HTMLTableHeaderCellElement>
    onTransitionCancel?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionEnd?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionRun?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionStart?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLTableHeaderCellElement>
    onWheel?: WheelEventHandler<HTMLTableHeaderCellElement>
    onWheelCapture?: WheelEventHandler<HTMLTableHeaderCellElement>
    render?: DOMRenderFunction<"div" | "th", ColumnRenderProps>

    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.
    style?: StyleOrFunction<ColumnRenderProps>

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

    suppressHydrationWarning?: boolean

    A React-only flag that suppresses the warning React normally logs when an element's server-rendered content doesn't match the client render during hydration. See React docs.

    textValue?: string

    A string representation of the column's contents, used for accessibility announcements.

    translate?: "yes" | "no"
    width?: ColumnSize | null

    The width of the column. This prop only applies when the <Table> is wrapped in a <ResizableTableContainer>.

    Settings
    Member Visibility

    On This Page
    Properties
    allowsArrowNavigationallowsSortingchildrenclassNamedefaultWidthdirfocusModehiddenidinertisRowHeaderlangmaxWidthminWidthonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonGotPointerCaptureonGotPointerCaptureCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderstylesuppressHydrationWarningtextValuetranslatewidth