Backstage
    Preparing search index...

    Interface CellProps

    Props for the Cell component.

    Cell is a generic cell wrapper for custom cell content. When rendering cells via ColumnConfig.cell or a custom RowRenderFn, the returned element must be a cell component (Cell, CellText, or CellProfile) at the top level. Returning bare text or other elements without a cell wrapper will break the table layout.

    interface CellProps {
        children?: ChildrenOrFunction<CellRenderProps>;
        className?: string;
        colSpan?: number;
        dir?: string;
        hidden?: boolean;
        id?: Key;
        inert?: boolean;
        lang?: string;
        onAnimationEnd?: AnimationEventHandler<HTMLTableCellElement>;
        onAnimationEndCapture?: AnimationEventHandler<HTMLTableCellElement>;
        onAnimationIteration?: AnimationEventHandler<HTMLTableCellElement>;
        onAnimationIterationCapture?: AnimationEventHandler<HTMLTableCellElement>;
        onAnimationStart?: AnimationEventHandler<HTMLTableCellElement>;
        onAnimationStartCapture?: AnimationEventHandler<HTMLTableCellElement>;
        onAuxClick?: MouseEventHandler<HTMLTableCellElement>;
        onAuxClickCapture?: MouseEventHandler<HTMLTableCellElement>;
        onClick?: MouseEventHandler<HTMLTableCellElement>;
        onClickCapture?: MouseEventHandler<HTMLTableCellElement>;
        onContextMenu?: MouseEventHandler<HTMLTableCellElement>;
        onContextMenuCapture?: MouseEventHandler<HTMLTableCellElement>;
        onDoubleClick?: MouseEventHandler<HTMLTableCellElement>;
        onDoubleClickCapture?: MouseEventHandler<HTMLTableCellElement>;
        onGotPointerCapture?: PointerEventHandler<HTMLTableCellElement>;
        onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableCellElement>;
        onLostPointerCapture?: PointerEventHandler<HTMLTableCellElement>;
        onLostPointerCaptureCapture?: PointerEventHandler<HTMLTableCellElement>;
        onMouseDown?: MouseEventHandler<HTMLTableCellElement>;
        onMouseDownCapture?: MouseEventHandler<HTMLTableCellElement>;
        onMouseEnter?: MouseEventHandler<HTMLTableCellElement>;
        onMouseLeave?: MouseEventHandler<HTMLTableCellElement>;
        onMouseMove?: MouseEventHandler<HTMLTableCellElement>;
        onMouseMoveCapture?: MouseEventHandler<HTMLTableCellElement>;
        onMouseOut?: MouseEventHandler<HTMLTableCellElement>;
        onMouseOutCapture?: MouseEventHandler<HTMLTableCellElement>;
        onMouseOver?: MouseEventHandler<HTMLTableCellElement>;
        onMouseOverCapture?: MouseEventHandler<HTMLTableCellElement>;
        onMouseUp?: MouseEventHandler<HTMLTableCellElement>;
        onMouseUpCapture?: MouseEventHandler<HTMLTableCellElement>;
        onPointerCancel?: PointerEventHandler<HTMLTableCellElement>;
        onPointerCancelCapture?: PointerEventHandler<HTMLTableCellElement>;
        onPointerDown?: PointerEventHandler<HTMLTableCellElement>;
        onPointerDownCapture?: PointerEventHandler<HTMLTableCellElement>;
        onPointerEnter?: PointerEventHandler<HTMLTableCellElement>;
        onPointerLeave?: PointerEventHandler<HTMLTableCellElement>;
        onPointerMove?: PointerEventHandler<HTMLTableCellElement>;
        onPointerMoveCapture?: PointerEventHandler<HTMLTableCellElement>;
        onPointerOut?: PointerEventHandler<HTMLTableCellElement>;
        onPointerOutCapture?: PointerEventHandler<HTMLTableCellElement>;
        onPointerOver?: PointerEventHandler<HTMLTableCellElement>;
        onPointerOverCapture?: PointerEventHandler<HTMLTableCellElement>;
        onPointerUp?: PointerEventHandler<HTMLTableCellElement>;
        onPointerUpCapture?: PointerEventHandler<HTMLTableCellElement>;
        onScroll?: UIEventHandler<HTMLTableCellElement>;
        onScrollCapture?: UIEventHandler<HTMLTableCellElement>;
        onTouchCancel?: TouchEventHandler<HTMLTableCellElement>;
        onTouchCancelCapture?: TouchEventHandler<HTMLTableCellElement>;
        onTouchEnd?: TouchEventHandler<HTMLTableCellElement>;
        onTouchEndCapture?: TouchEventHandler<HTMLTableCellElement>;
        onTouchMove?: TouchEventHandler<HTMLTableCellElement>;
        onTouchMoveCapture?: TouchEventHandler<HTMLTableCellElement>;
        onTouchStart?: TouchEventHandler<HTMLTableCellElement>;
        onTouchStartCapture?: TouchEventHandler<HTMLTableCellElement>;
        onTransitionCancel?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionCancelCapture?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionEnd?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionEndCapture?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionRun?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionRunCapture?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionStart?: TransitionEventHandler<HTMLTableCellElement>;
        onTransitionStartCapture?: TransitionEventHandler<HTMLTableCellElement>;
        onWheel?: WheelEventHandler<HTMLTableCellElement>;
        onWheelCapture?: WheelEventHandler<HTMLTableCellElement>;
        render?: DOMRenderFunction<"div" | "td", CellRenderProps>;
        style?: StyleOrFunction<CellRenderProps>;
        textValue?: string;
        translate?: "yes" | "no";
    }

    Hierarchy (View Summary)

    Index
    children? className? colSpan? dir? hidden? id? inert? lang? 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? textValue? translate?
    children?: ChildrenOrFunction<CellRenderProps>

    The children of the component. A function may be provided to alter the children based on component state.

    className?: string
    colSpan?: number

    Indicates how many columns the data cell spans.

    dir?: string
    hidden?: boolean
    id?: Key

    The unique id of the cell.

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

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

    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 cell's contents, used for features like typeahead.

    translate?: "yes" | "no"

    Settings
    Member Visibility

    On This Page
    Properties
    childrenclassNamecolSpandirhiddenidinertlangonAnimationEndonAnimationEndCaptureonAnimationIterationonAnimationIterationCaptureonAnimationStartonAnimationStartCaptureonAuxClickonAuxClickCaptureonClickonClickCaptureonContextMenuonContextMenuCaptureonDoubleClickonDoubleClickCaptureonGotPointerCaptureonGotPointerCaptureCaptureonLostPointerCaptureonLostPointerCaptureCaptureonMouseDownonMouseDownCaptureonMouseEnteronMouseLeaveonMouseMoveonMouseMoveCaptureonMouseOutonMouseOutCaptureonMouseOveronMouseOverCaptureonMouseUponMouseUpCaptureonPointerCancelonPointerCancelCaptureonPointerDownonPointerDownCaptureonPointerEnteronPointerLeaveonPointerMoveonPointerMoveCaptureonPointerOutonPointerOutCaptureonPointerOveronPointerOverCaptureonPointerUponPointerUpCaptureonScrollonScrollCaptureonTouchCancelonTouchCancelCaptureonTouchEndonTouchEndCaptureonTouchMoveonTouchMoveCaptureonTouchStartonTouchStartCaptureonTransitionCancelonTransitionCancelCaptureonTransitionEndonTransitionEndCaptureonTransitionRunonTransitionRunCaptureonTransitionStartonTransitionStartCaptureonWheelonWheelCapturerenderstyletextValuetranslate