Backstage
    Preparing search index...

    Interface ColumnProps

    interface ColumnProps {
        allowsSorting?: boolean;
        children?: ReactNode;
        className?: ClassNameOrFunction<ColumnRenderProps>;
        defaultWidth?: ColumnSize | null;
        dir?: string;
        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>;
        style?: StyleOrFunction<ColumnRenderProps>;
        textValue?: string;
        translate?: "yes" | "no";
        width?: ColumnSize | null;
    }

    Hierarchy

    • Omit<AriaColumnProps, "children">
      • ColumnProps
    Index

    Properties

    allowsSorting? children? className? defaultWidth? dir? 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? style? textValue? translate? width?

    Properties

    allowsSorting?: boolean

    Whether the column allows sorting.

    children?: ReactNode
    className?: ClassNameOrFunction<ColumnRenderProps>

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

    defaultWidth?: ColumnSize | null

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

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

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

    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
    allowsSortingchildrenclassNamedefaultWidthdirhiddenidinertisRowHeaderlangmaxWidthminWidthonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonGotPointerCaptureonGotPointerCaptureCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturestyletextValuetranslatewidth