• Public
  • Public/Protected
  • All

Interface TableCellProps





abbr?: string
about?: string
accessKey?: string
align?: "left" | "right" | "center" | "justify" | "char"
aria-activedescendant?: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

aria-atomic?: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

aria-autocomplete?: "list" | "none" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-busy?: Booleanish

Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

aria-checked?: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.


aria-pressed @see aria-selected.

aria-colcount?: number

Defines the total number of columns in a table, grid, or treegrid.



aria-colindex?: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.


aria-colcount @see aria-colspan.

aria-colspan?: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.


aria-colindex @see aria-rowspan.

aria-controls?: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.



aria-current?: boolean | "true" | "false" | "page" | "step" | "location" | "date" | "time"

Indicates the element that represents the current item within a container or set of related elements.

aria-describedby?: string

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



aria-details?: string

Identifies the element that provides a detailed, extended description for the object.



aria-disabled?: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.


aria-hidden @see aria-readonly.

aria-dropeffect?: "link" | "none" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.


in ARIA 1.1

aria-errormessage?: string

Identifies the element that provides an error message for the object.


aria-invalid @see aria-describedby.

aria-expanded?: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

aria-flowto?: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

aria-grabbed?: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.


in ARIA 1.1

aria-haspopup?: boolean | "true" | "false" | "dialog" | "grid" | "listbox" | "menu" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

aria-hidden?: Booleanish

Indicates whether the element is exposed to an accessibility API.



aria-invalid?: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.



aria-keyshortcuts?: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

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.



aria-level?: number

Defines the hierarchical level of an element within a structure.

aria-live?: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

aria-modal?: Booleanish

Indicates whether an element is modal when displayed.

aria-multiline?: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

aria-multiselectable?: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

aria-orientation?: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

aria-owns?: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.



aria-placeholder?: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

aria-posinset?: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.



aria-pressed?: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.


aria-checked @see aria-selected.

aria-readonly?: Booleanish

Indicates that the element is not editable, but is otherwise operable.



aria-relevant?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.



aria-required?: Booleanish

Indicates that user input is required on the element before a form may be submitted.

aria-roledescription?: string

Defines a human-readable, author-localized description for the role of an element.

aria-rowcount?: number

Defines the total number of rows in a table, grid, or treegrid.



aria-rowindex?: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.


aria-rowcount @see aria-rowspan.

aria-rowspan?: number

Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.


aria-rowindex @see aria-colspan.

aria-selected?: Booleanish

Indicates the current "selected" state of various widgets.


aria-checked @see aria-pressed.

aria-setsize?: number

Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.



aria-sort?: SortOrder

If you want to apply a sort icon for a header cell, set this prop to either "ascending" or "descending". When you change the sort order, this prop should change as well which will cause the sort icon to rotate. The default behavior is to have the icon facing upwards and not-rotated when "ascending", otherwise it will rotate downwards when "descending".

If this prop is set to "none", the cell will render the clickable button in the children, just without the sort icon. This is so that the sort behavior can still be toggled for keyboard users and will be tab-focusable.

aria-valuemax?: number

Defines the maximum allowed value for a range widget.

aria-valuemin?: number

Defines the minimum allowed value for a range widget.

aria-valuenow?: number

Defines the current value for a range widget.



aria-valuetext?: string

Defines the human readable text alternative of aria-valuenow for a range widget.

autoCapitalize?: string
autoCorrect?: string
autoSave?: string
children?: ReactNode
className?: string
colSpan?: number | "100%"

The number of columns that the cell should span. If you would like a cell to span an entire row ignoring the other rows and cells, you can set this value to the number of columns within your table or "100%".

color?: string
contentEditable?: Booleanish | "inherit"
contextMenu?: string
dangerouslySetInnerHTML?: { __html: string }

Type declaration

  • __html: string
datatype?: string
defaultChecked?: boolean
defaultValue?: string | number | readonly string[]
dir?: string
disablePadding?: boolean

Boolean if cell should no longer have any padding since you want a child element to span the entire size of the cell instead. This is helpful when rendering clickable and focusable elements within a cell.

This will be defaulted to true if the "aria-sort" prop has been provided and the sortIcon is not resoled as null. You can override this default behavior by manually setting this to true or false.

draggable?: Booleanish
grow?: boolean

This is a bit of a "weird" prop since all it does is apply width: 100% to this cell. This will make this specific cell fill the remaining width of the table (if there is any). If no cells have this prop enabled and the fullWidth table configuration is enabled, all cells will have an equal-sized width.

{@inheritDoc TableCellHorizontalAlignment}

header?: boolean

Boolean if all the TableCell components should be rendered as a <th> instead of a <td>. This is really just a convenience prop for the TableHeader component so the user of react-md doesn't need to keep setting the type="th" fot the TableCell if using the low-level components.

headers?: string
hidden?: boolean
id?: string
inlist?: any
inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal"

Hints at the type of data that might be entered by the user while editing the element or its contents



is?: string

Specify that a standard HTML element should behave like a defined custom built-in element



itemID?: string
itemProp?: string
itemRef?: string
itemScope?: boolean
itemType?: string
lang?: string
lineWrap?: boolean | "padded"

Boolean if the <td> and <th> cells should support line wrapping. This is disabled by default since you normally don't want line wrapping in tables unless it provides additional descriptions or other content.

If this is set to the string "padded", line wrapping will be enabled along with adding some additional vertical padding to each cell.

onAbort?: ReactEventHandler<HTMLTableCellElement>
onAbortCapture?: ReactEventHandler<HTMLTableCellElement>
onAnimationEnd?: AnimationEventHandler<HTMLTableCellElement>
onAnimationEndCapture?: AnimationEventHandler<HTMLTableCellElement>
onAnimationIteration?: AnimationEventHandler<HTMLTableCellElement>
onAnimationIterationCapture?: AnimationEventHandler<HTMLTableCellElement>
onAnimationStart?: AnimationEventHandler<HTMLTableCellElement>
onAnimationStartCapture?: AnimationEventHandler<HTMLTableCellElement>
onAuxClick?: MouseEventHandler<HTMLTableCellElement>
onAuxClickCapture?: MouseEventHandler<HTMLTableCellElement>
onBeforeInput?: FormEventHandler<HTMLTableCellElement>
onBeforeInputCapture?: FormEventHandler<HTMLTableCellElement>
onBlur?: FocusEventHandler<HTMLTableCellElement>
onBlurCapture?: FocusEventHandler<HTMLTableCellElement>
onCanPlay?: ReactEventHandler<HTMLTableCellElement>
onCanPlayCapture?: ReactEventHandler<HTMLTableCellElement>
onCanPlayThrough?: ReactEventHandler<HTMLTableCellElement>
onCanPlayThroughCapture?: ReactEventHandler<HTMLTableCellElement>
onChange?: FormEventHandler<HTMLTableCellElement>
onChangeCapture?: FormEventHandler<HTMLTableCellElement>
onClick?: MouseEventHandler<HTMLTableCellElement>
onClickCapture?: MouseEventHandler<HTMLTableCellElement>
onCompositionEnd?: CompositionEventHandler<HTMLTableCellElement>
onCompositionEndCapture?: CompositionEventHandler<HTMLTableCellElement>
onCompositionStart?: CompositionEventHandler<HTMLTableCellElement>
onCompositionStartCapture?: CompositionEventHandler<HTMLTableCellElement>
onCompositionUpdate?: CompositionEventHandler<HTMLTableCellElement>
onCompositionUpdateCapture?: CompositionEventHandler<HTMLTableCellElement>
onContextMenu?: MouseEventHandler<HTMLTableCellElement>
onContextMenuCapture?: MouseEventHandler<HTMLTableCellElement>
onCopy?: ClipboardEventHandler<HTMLTableCellElement>
onCopyCapture?: ClipboardEventHandler<HTMLTableCellElement>
onCut?: ClipboardEventHandler<HTMLTableCellElement>
onCutCapture?: ClipboardEventHandler<HTMLTableCellElement>
onDoubleClick?: MouseEventHandler<HTMLTableCellElement>
onDoubleClickCapture?: MouseEventHandler<HTMLTableCellElement>
onDrag?: DragEventHandler<HTMLTableCellElement>
onDragCapture?: DragEventHandler<HTMLTableCellElement>
onDragEnd?: DragEventHandler<HTMLTableCellElement>
onDragEndCapture?: DragEventHandler<HTMLTableCellElement>
onDragEnter?: DragEventHandler<HTMLTableCellElement>
onDragEnterCapture?: DragEventHandler<HTMLTableCellElement>
onDragExit?: DragEventHandler<HTMLTableCellElement>
onDragExitCapture?: DragEventHandler<HTMLTableCellElement>
onDragLeave?: DragEventHandler<HTMLTableCellElement>
onDragLeaveCapture?: DragEventHandler<HTMLTableCellElement>
onDragOver?: DragEventHandler<HTMLTableCellElement>
onDragOverCapture?: DragEventHandler<HTMLTableCellElement>
onDragStart?: DragEventHandler<HTMLTableCellElement>
onDragStartCapture?: DragEventHandler<HTMLTableCellElement>
onDrop?: DragEventHandler<HTMLTableCellElement>
onDropCapture?: DragEventHandler<HTMLTableCellElement>
onDurationChange?: ReactEventHandler<HTMLTableCellElement>
onDurationChangeCapture?: ReactEventHandler<HTMLTableCellElement>
onEmptied?: ReactEventHandler<HTMLTableCellElement>
onEmptiedCapture?: ReactEventHandler<HTMLTableCellElement>
onEncrypted?: ReactEventHandler<HTMLTableCellElement>
onEncryptedCapture?: ReactEventHandler<HTMLTableCellElement>
onEnded?: ReactEventHandler<HTMLTableCellElement>
onEndedCapture?: ReactEventHandler<HTMLTableCellElement>
onError?: ReactEventHandler<HTMLTableCellElement>
onErrorCapture?: ReactEventHandler<HTMLTableCellElement>
onFocus?: FocusEventHandler<HTMLTableCellElement>
onFocusCapture?: FocusEventHandler<HTMLTableCellElement>
onGotPointerCapture?: PointerEventHandler<HTMLTableCellElement>
onGotPointerCaptureCapture?: PointerEventHandler<HTMLTableCellElement>
onInput?: FormEventHandler<HTMLTableCellElement>
onInputCapture?: FormEventHandler<HTMLTableCellElement>
onInvalid?: FormEventHandler<HTMLTableCellElement>
onInvalidCapture?: FormEventHandler<HTMLTableCellElement>
onKeyDown?: KeyboardEventHandler<HTMLTableCellElement>
onKeyDownCapture?: KeyboardEventHandler<HTMLTableCellElement>
onKeyPress?: KeyboardEventHandler<HTMLTableCellElement>
onKeyPressCapture?: KeyboardEventHandler<HTMLTableCellElement>
onKeyUp?: KeyboardEventHandler<HTMLTableCellElement>
onKeyUpCapture?: KeyboardEventHandler<HTMLTableCellElement>
onLoad?: ReactEventHandler<HTMLTableCellElement>
onLoadCapture?: ReactEventHandler<HTMLTableCellElement>
onLoadStart?: ReactEventHandler<HTMLTableCellElement>
onLoadStartCapture?: ReactEventHandler<HTMLTableCellElement>
onLoadedData?: ReactEventHandler<HTMLTableCellElement>
onLoadedDataCapture?: ReactEventHandler<HTMLTableCellElement>
onLoadedMetadata?: ReactEventHandler<HTMLTableCellElement>
onLoadedMetadataCapture?: ReactEventHandler<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>
onPaste?: ClipboardEventHandler<HTMLTableCellElement>
onPasteCapture?: ClipboardEventHandler<HTMLTableCellElement>
onPause?: ReactEventHandler<HTMLTableCellElement>
onPauseCapture?: ReactEventHandler<HTMLTableCellElement>
onPlay?: ReactEventHandler<HTMLTableCellElement>
onPlayCapture?: ReactEventHandler<HTMLTableCellElement>
onPlaying?: ReactEventHandler<HTMLTableCellElement>
onPlayingCapture?: ReactEventHandler<HTMLTableCellElement>
onPointerCancel?: PointerEventHandler<HTMLTableCellElement>
onPointerCancelCapture?: PointerEventHandler<HTMLTableCellElement>
onPointerDown?: PointerEventHandler<HTMLTableCellElement>
onPointerDownCapture?: PointerEventHandler<HTMLTableCellElement>
onPointerEnter?: PointerEventHandler<HTMLTableCellElement>
onPointerEnterCapture?: PointerEventHandler<HTMLTableCellElement>
onPointerLeave?: PointerEventHandler<HTMLTableCellElement>
onPointerLeaveCapture?: 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>
onProgress?: ReactEventHandler<HTMLTableCellElement>
onProgressCapture?: ReactEventHandler<HTMLTableCellElement>
onRateChange?: ReactEventHandler<HTMLTableCellElement>
onRateChangeCapture?: ReactEventHandler<HTMLTableCellElement>
onReset?: FormEventHandler<HTMLTableCellElement>
onResetCapture?: FormEventHandler<HTMLTableCellElement>
onScroll?: UIEventHandler<HTMLTableCellElement>
onScrollCapture?: UIEventHandler<HTMLTableCellElement>
onSeeked?: ReactEventHandler<HTMLTableCellElement>
onSeekedCapture?: ReactEventHandler<HTMLTableCellElement>
onSeeking?: ReactEventHandler<HTMLTableCellElement>
onSeekingCapture?: ReactEventHandler<HTMLTableCellElement>
onSelect?: ReactEventHandler<HTMLTableCellElement>
onSelectCapture?: ReactEventHandler<HTMLTableCellElement>
onStalled?: ReactEventHandler<HTMLTableCellElement>
onStalledCapture?: ReactEventHandler<HTMLTableCellElement>
onSubmit?: FormEventHandler<HTMLTableCellElement>
onSubmitCapture?: FormEventHandler<HTMLTableCellElement>
onSuspend?: ReactEventHandler<HTMLTableCellElement>
onSuspendCapture?: ReactEventHandler<HTMLTableCellElement>
onTimeUpdate?: ReactEventHandler<HTMLTableCellElement>
onTimeUpdateCapture?: ReactEventHandler<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>
onTransitionEnd?: TransitionEventHandler<HTMLTableCellElement>
onTransitionEndCapture?: TransitionEventHandler<HTMLTableCellElement>
onVolumeChange?: ReactEventHandler<HTMLTableCellElement>
onVolumeChangeCapture?: ReactEventHandler<HTMLTableCellElement>
onWaiting?: ReactEventHandler<HTMLTableCellElement>
onWaitingCapture?: ReactEventHandler<HTMLTableCellElement>
onWheel?: WheelEventHandler<HTMLTableCellElement>
onWheelCapture?: WheelEventHandler<HTMLTableCellElement>
placeholder?: string
prefix?: string
property?: string
radioGroup?: string
resource?: string
results?: number
role?: AriaRole
rowSpan?: number
scope?: "row" | "rowgroup" | "col" | "colgroup"

This prop is only valid when the header prop is enabled or the TableCell is a child of the TableHeader component. This will generally be used with a value of "row" if you have table headers that are at the start of each row instead of at the top of the table.

security?: string
slot?: string
sortIcon?: ReactNode

An optional sort icon to use. This will be defaulted to the configured sort icon from the @react-md/icon package. If you do not want the default implementation for the sort icon behavior from react-md, you can set this prop to null.

sortIconAfter?: boolean

Boolean if the sort icon should appear after the children in the cell instead of before.

sortIconRotated?: boolean

Boolean if the sort icon should be rotated instead of the default direction. When this is undefined, it will only be true when the "aria-sort" prop is set to "descending". If this is not undefined, its boolean value will always be used.

spellCheck?: Booleanish
sticky?: boolean | "cell" | "header" | "header-cell"

If this is a trueish value, the cell will become a sticky cell that will be fixed while the user scrolls the table. When this is a boolean (or inherited from a TableHeader) or set to "header", the cell will act as a sticky header that will be visible for vertical scrolling.

When this is set to "cell", the cell will be fixed to the left or right for horizontal scrolling.

Finally, if this is set to "header-cell", it will be a combination of both vertical and horizontal scrolling. This means that other sticky header cells will scroll beneath this cell.

style?: CSSProperties
suppressContentEditableWarning?: boolean
suppressHydrationWarning?: boolean
tabIndex?: number
title?: string
translate?: "yes" | "no"
typeof?: string
unselectable?: "on" | "off"

{@inheritDoc TableCellVerticalAlignment}

vocab?: string

Generated using TypeDoc