Backstage
    Preparing search index...

    Interface TableHeaderProps<T>

    interface TableHeaderProps<T> {
        children?: ReactNode | ((item: T) => ReactElement);
        className?: ClassNameOrFunction<TableHeaderRenderProps>;
        columns?: Iterable<T, any, any>;
        dependencies?: readonly any[];
        dir?: string;
        hidden?: boolean;
        inert?: boolean;
        lang?: string;
        onAnimationEnd?: AnimationEventHandler<HTMLTableSectionElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLTableSectionElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLTableSectionElement>;
        onAnimationIterationCapture?: AnimationEventHandler<
            HTMLTableSectionElement,
        >;
        onAnimationStart?: AnimationEventHandler<HTMLTableSectionElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLTableSectionElement>;
        onAuxClick?: MouseEventHandler<HTMLTableSectionElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onClick?: MouseEventHandler<HTMLTableSectionElement>;
        onClickCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onContextMenu?: MouseEventHandler<HTMLTableSectionElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onDoubleClick?: MouseEventHandler<HTMLTableSectionElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onHoverChange?: (isHovering: boolean) => void;
        onHoverEnd?: (e: HoverEvent) => void;
        onHoverStart?: (e: HoverEvent) => void;
        onLostPointerCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onMouseDown?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseEnter?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseLeave?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseMove?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseOut?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseOver?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseUp?: MouseEventHandler<HTMLTableSectionElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLTableSectionElement>;
        onPointerCancel?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerDown?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerEnter?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerLeave?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerMove?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerOut?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerOver?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerUp?: PointerEventHandler<HTMLTableSectionElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLTableSectionElement>;
        onScroll?: UIEventHandler<HTMLTableSectionElement>;
        onScrollCapture?: UIEventHandler<HTMLTableSectionElement>;
        onTouchCancel?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchEnd?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchMove?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchStart?: TouchEventHandler<HTMLTableSectionElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLTableSectionElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionRun?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionStart?: TransitionEventHandler<HTMLTableSectionElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLTableSectionElement>;
        onWheel?: WheelEventHandler<HTMLTableSectionElement>;
        onWheelCapture?: WheelEventHandler<HTMLTableSectionElement>;
        render?: DOMRenderFunction<"div" | "thead", TableHeaderRenderProps>;
        style?: StyleOrFunction<TableHeaderRenderProps>;
        translate?: "yes" | "no";
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index
    children? className? columns? dependencies? dir? hidden? inert? lang? onAnimationEnd? onAnimationEndCapture? onAnimationIteration? onAnimationIterationCapture? onAnimationStart? onAnimationStartCapture? onAuxClick? onAuxClickCapture? onClick? onClickCapture? onContextMenu? onContextMenuCapture? onDoubleClick? onDoubleClickCapture? onGotPointerCapture? onGotPointerCaptureCapture? onHoverChange? onHoverEnd? onHoverStart? 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? translate?
    children?: ReactNode | ((item: T) => ReactElement)
    className?: ClassNameOrFunction<TableHeaderRenderProps>

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

    'react-aria-TableHeader'
    columns?: Iterable<T, any, any>
    dependencies?: readonly any[]

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

    dir?: string
    hidden?: boolean
    inert?: boolean
    lang?: string
    onAnimationEnd?: AnimationEventHandler<HTMLTableSectionElement>
    onAnimationEndCapture?: AnimationEventHandler<HTMLTableSectionElement>
    onAnimationIteration?: AnimationEventHandler<HTMLTableSectionElement>
    onAnimationIterationCapture?: AnimationEventHandler<HTMLTableSectionElement>
    onAnimationStart?: AnimationEventHandler<HTMLTableSectionElement>
    onAnimationStartCapture?: AnimationEventHandler<HTMLTableSectionElement>
    onAuxClick?: MouseEventHandler<HTMLTableSectionElement>
    onAuxClickCapture?: MouseEventHandler<HTMLTableSectionElement>
    onClick?: MouseEventHandler<HTMLTableSectionElement>
    onClickCapture?: MouseEventHandler<HTMLTableSectionElement>
    onContextMenu?: MouseEventHandler<HTMLTableSectionElement>
    onContextMenuCapture?: MouseEventHandler<HTMLTableSectionElement>
    onDoubleClick?: MouseEventHandler<HTMLTableSectionElement>
    onDoubleClickCapture?: MouseEventHandler<HTMLTableSectionElement>
    onGotPointerCapture?: PointerEventHandler<HTMLTableSectionElement>
    onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableSectionElement>
    onHoverChange?: (isHovering: boolean) => void

    Handler that is called when the hover state changes.

    onHoverEnd?: (e: HoverEvent) => void

    Handler that is called when a hover interaction ends.

    onHoverStart?: (e: HoverEvent) => void

    Handler that is called when a hover interaction starts.

    onLostPointerCapture?: PointerEventHandler<HTMLTableSectionElement>
    onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableSectionElement>
    onMouseDown?: MouseEventHandler<HTMLTableSectionElement>
    onMouseDownCapture?: MouseEventHandler<HTMLTableSectionElement>
    onMouseEnter?: MouseEventHandler<HTMLTableSectionElement>
    onMouseLeave?: MouseEventHandler<HTMLTableSectionElement>
    onMouseMove?: MouseEventHandler<HTMLTableSectionElement>
    onMouseMoveCapture?: MouseEventHandler<HTMLTableSectionElement>
    onMouseOut?: MouseEventHandler<HTMLTableSectionElement>
    onMouseOutCapture?: MouseEventHandler<HTMLTableSectionElement>
    onMouseOver?: MouseEventHandler<HTMLTableSectionElement>
    onMouseOverCapture?: MouseEventHandler<HTMLTableSectionElement>
    onMouseUp?: MouseEventHandler<HTMLTableSectionElement>
    onMouseUpCapture?: MouseEventHandler<HTMLTableSectionElement>
    onPointerCancel?: PointerEventHandler<HTMLTableSectionElement>
    onPointerCancelCapture?: PointerEventHandler<HTMLTableSectionElement>
    onPointerDown?: PointerEventHandler<HTMLTableSectionElement>
    onPointerDownCapture?: PointerEventHandler<HTMLTableSectionElement>
    onPointerEnter?: PointerEventHandler<HTMLTableSectionElement>
    onPointerLeave?: PointerEventHandler<HTMLTableSectionElement>
    onPointerMove?: PointerEventHandler<HTMLTableSectionElement>
    onPointerMoveCapture?: PointerEventHandler<HTMLTableSectionElement>
    onPointerOut?: PointerEventHandler<HTMLTableSectionElement>
    onPointerOutCapture?: PointerEventHandler<HTMLTableSectionElement>
    onPointerOver?: PointerEventHandler<HTMLTableSectionElement>
    onPointerOverCapture?: PointerEventHandler<HTMLTableSectionElement>
    onPointerUp?: PointerEventHandler<HTMLTableSectionElement>
    onPointerUpCapture?: PointerEventHandler<HTMLTableSectionElement>
    onScroll?: UIEventHandler<HTMLTableSectionElement>
    onScrollCapture?: UIEventHandler<HTMLTableSectionElement>
    onTouchCancel?: TouchEventHandler<HTMLTableSectionElement>
    onTouchCancelCapture?: TouchEventHandler<HTMLTableSectionElement>
    onTouchEnd?: TouchEventHandler<HTMLTableSectionElement>
    onTouchEndCapture?: TouchEventHandler<HTMLTableSectionElement>
    onTouchMove?: TouchEventHandler<HTMLTableSectionElement>
    onTouchMoveCapture?: TouchEventHandler<HTMLTableSectionElement>
    onTouchStart?: TouchEventHandler<HTMLTableSectionElement>
    onTouchStartCapture?: TouchEventHandler<HTMLTableSectionElement>
    onTransitionCancel?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionCancelCapture?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionEnd?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionEndCapture?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionRun?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionRunCapture?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionStart?: TransitionEventHandler<HTMLTableSectionElement>
    onTransitionStartCapture?: TransitionEventHandler<HTMLTableSectionElement>
    onWheel?: WheelEventHandler<HTMLTableSectionElement>
    onWheelCapture?: WheelEventHandler<HTMLTableSectionElement>
    render?: DOMRenderFunction<"div" | "thead", TableHeaderRenderProps>

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

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

    translate?: "yes" | "no"

    Settings
    Member Visibility

    On This Page
    Properties
    childrenclassNamecolumnsdependenciesdirhiddeninertlangonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonGotPointerCaptureonGotPointerCaptureCaptureonHoverChangeonHoverEndonHoverStartonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderstyletranslate