Layout

Table

A table displays large quantities of items or data in a list format. Filtering features and actions may be added.

View source

Props

NameTypeDefaultDescription
datarequiredany[]
The data to be displayed in the table
idrequiredstring
Unique identifier of the table
renderBodyrequired(data: any[]) => ReactNode
Content of the body of the table
  • dataThe data from the "data" prop modified by the HOCs if any
"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-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-colspan"number
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
"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-errormessage"string
Identifies the element that provides an error message for the object.
"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-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-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-rowspan"number
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
"aria-selected"Booleanish
Indicates the current "selected" state of various widgets.
"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""none" | "ascending" | "descending" | "other"
Indicates if items in a table or grid are sorted in ascending or descending order.
"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.
aboutstring
accessKeystring
actionBarPrefixContentIContentProps
Content to add before the filter and actions in the table header
actionsReactNode[][]
The actions button to be displayed in the table header
autoCapitalizestring
autoCorrectstring
autoSavestring
childrenReactNode
classNamestring
colorstring
containerClassNamestring
Additionnal CSS classes for the outer most container of the table
contentEditableBooleanish | "inherit"
contextMenustring
dangerouslySetInnerHTML{ __html: string; }
datatypestring
defaultCheckedboolean
defaultValuestring | number | readonly string[]
dirstring
draggableBooleanish
hasActionButtonsbooleanfalse
Whether the table has action buttons
hiddenboolean
inlistany
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
isstring
Specify that a standard HTML element should behave like a defined custom built-in element
isLoadingbooleanfalse
Whether the table is loading
itemIDstring
itemPropstring
itemRefstring
itemScopeboolean
itemTypestring
langstring
loading{ isCard?: boolean; numberOfColumns?: number; defaultLoadingRow?: number; numberOfSubRow?: number; }isCard: false, numberOfColumns: 5, defaultLoadingRow: 10, numberOfSubRow: 3,
Additionnal loading options
noncestring
onAbortReactEventHandler<HTMLTableElement>
onAbortCaptureReactEventHandler<HTMLTableElement>
onAnimationEndAnimationEventHandler<HTMLTableElement>
onAnimationEndCaptureAnimationEventHandler<HTMLTableElement>
onAnimationIterationAnimationEventHandler<HTMLTableElement>
onAnimationIterationCaptureAnimationEventHandler<HTMLTableElement>
onAnimationStartAnimationEventHandler<HTMLTableElement>
onAnimationStartCaptureAnimationEventHandler<HTMLTableElement>
onAuxClickMouseEventHandler<HTMLTableElement>
onAuxClickCaptureMouseEventHandler<HTMLTableElement>
onBeforeInputFormEventHandler<HTMLTableElement>
onBeforeInputCaptureFormEventHandler<HTMLTableElement>
onBlurFocusEventHandler<HTMLTableElement>
onBlurCaptureFocusEventHandler<HTMLTableElement>
onCanPlayReactEventHandler<HTMLTableElement>
onCanPlayCaptureReactEventHandler<HTMLTableElement>
onCanPlayThroughReactEventHandler<HTMLTableElement>
onCanPlayThroughCaptureReactEventHandler<HTMLTableElement>
onChangeFormEventHandler<HTMLTableElement>
onChangeCaptureFormEventHandler<HTMLTableElement>
onClickMouseEventHandler<HTMLTableElement>
onClickCaptureMouseEventHandler<HTMLTableElement>
onCompositionEndCompositionEventHandler<HTMLTableElement>
onCompositionEndCaptureCompositionEventHandler<HTMLTableElement>
onCompositionStartCompositionEventHandler<HTMLTableElement>
onCompositionStartCaptureCompositionEventHandler<HTMLTableElement>
onCompositionUpdateCompositionEventHandler<HTMLTableElement>
onCompositionUpdateCaptureCompositionEventHandler<HTMLTableElement>
onContextMenuMouseEventHandler<HTMLTableElement>
onContextMenuCaptureMouseEventHandler<HTMLTableElement>
onCopyClipboardEventHandler<HTMLTableElement>
onCopyCaptureClipboardEventHandler<HTMLTableElement>
onCutClipboardEventHandler<HTMLTableElement>
onCutCaptureClipboardEventHandler<HTMLTableElement>
onDoubleClickMouseEventHandler<HTMLTableElement>
onDoubleClickCaptureMouseEventHandler<HTMLTableElement>
onDragDragEventHandler<HTMLTableElement>
onDragCaptureDragEventHandler<HTMLTableElement>
onDragEndDragEventHandler<HTMLTableElement>
onDragEndCaptureDragEventHandler<HTMLTableElement>
onDragEnterDragEventHandler<HTMLTableElement>
onDragEnterCaptureDragEventHandler<HTMLTableElement>
onDragExitDragEventHandler<HTMLTableElement>
onDragExitCaptureDragEventHandler<HTMLTableElement>
onDragLeaveDragEventHandler<HTMLTableElement>
onDragLeaveCaptureDragEventHandler<HTMLTableElement>
onDragOverDragEventHandler<HTMLTableElement>
onDragOverCaptureDragEventHandler<HTMLTableElement>
onDragStartDragEventHandler<HTMLTableElement>
onDragStartCaptureDragEventHandler<HTMLTableElement>
onDropDragEventHandler<HTMLTableElement>
onDropCaptureDragEventHandler<HTMLTableElement>
onDurationChangeReactEventHandler<HTMLTableElement>
onDurationChangeCaptureReactEventHandler<HTMLTableElement>
onEmptiedReactEventHandler<HTMLTableElement>
onEmptiedCaptureReactEventHandler<HTMLTableElement>
onEncryptedReactEventHandler<HTMLTableElement>
onEncryptedCaptureReactEventHandler<HTMLTableElement>
onEndedReactEventHandler<HTMLTableElement>
onEndedCaptureReactEventHandler<HTMLTableElement>
onErrorReactEventHandler<HTMLTableElement>
onErrorCaptureReactEventHandler<HTMLTableElement>
onFocusFocusEventHandler<HTMLTableElement>
onFocusCaptureFocusEventHandler<HTMLTableElement>
onGotPointerCapturePointerEventHandler<HTMLTableElement>
onGotPointerCaptureCapturePointerEventHandler<HTMLTableElement>
onInputFormEventHandler<HTMLTableElement>
onInputCaptureFormEventHandler<HTMLTableElement>
onInvalidFormEventHandler<HTMLTableElement>
onInvalidCaptureFormEventHandler<HTMLTableElement>
onKeyDownKeyboardEventHandler<HTMLTableElement>
onKeyDownCaptureKeyboardEventHandler<HTMLTableElement>
onKeyUpKeyboardEventHandler<HTMLTableElement>
onKeyUpCaptureKeyboardEventHandler<HTMLTableElement>
onLoadReactEventHandler<HTMLTableElement>
onLoadCaptureReactEventHandler<HTMLTableElement>
onLoadedDataReactEventHandler<HTMLTableElement>
onLoadedDataCaptureReactEventHandler<HTMLTableElement>
onLoadedMetadataReactEventHandler<HTMLTableElement>
onLoadedMetadataCaptureReactEventHandler<HTMLTableElement>
onLoadStartReactEventHandler<HTMLTableElement>
onLoadStartCaptureReactEventHandler<HTMLTableElement>
onLostPointerCapturePointerEventHandler<HTMLTableElement>
onLostPointerCaptureCapturePointerEventHandler<HTMLTableElement>
onMouseDownMouseEventHandler<HTMLTableElement>
onMouseDownCaptureMouseEventHandler<HTMLTableElement>
onMouseEnterMouseEventHandler<HTMLTableElement>
onMouseLeaveMouseEventHandler<HTMLTableElement>
onMouseMoveMouseEventHandler<HTMLTableElement>
onMouseMoveCaptureMouseEventHandler<HTMLTableElement>
onMouseOutMouseEventHandler<HTMLTableElement>
onMouseOutCaptureMouseEventHandler<HTMLTableElement>
onMouseOverMouseEventHandler<HTMLTableElement>
onMouseOverCaptureMouseEventHandler<HTMLTableElement>
onMouseUpMouseEventHandler<HTMLTableElement>
onMouseUpCaptureMouseEventHandler<HTMLTableElement>
onPasteClipboardEventHandler<HTMLTableElement>
onPasteCaptureClipboardEventHandler<HTMLTableElement>
onPauseReactEventHandler<HTMLTableElement>
onPauseCaptureReactEventHandler<HTMLTableElement>
onPlayReactEventHandler<HTMLTableElement>
onPlayCaptureReactEventHandler<HTMLTableElement>
onPlayingReactEventHandler<HTMLTableElement>
onPlayingCaptureReactEventHandler<HTMLTableElement>
onPointerCancelPointerEventHandler<HTMLTableElement>
onPointerCancelCapturePointerEventHandler<HTMLTableElement>
onPointerDownPointerEventHandler<HTMLTableElement>
onPointerDownCapturePointerEventHandler<HTMLTableElement>
onPointerEnterPointerEventHandler<HTMLTableElement>
onPointerEnterCapturePointerEventHandler<HTMLTableElement>
onPointerLeavePointerEventHandler<HTMLTableElement>
onPointerLeaveCapturePointerEventHandler<HTMLTableElement>
onPointerMovePointerEventHandler<HTMLTableElement>
onPointerMoveCapturePointerEventHandler<HTMLTableElement>
onPointerOutPointerEventHandler<HTMLTableElement>
onPointerOutCapturePointerEventHandler<HTMLTableElement>
onPointerOverPointerEventHandler<HTMLTableElement>
onPointerOverCapturePointerEventHandler<HTMLTableElement>
onPointerUpPointerEventHandler<HTMLTableElement>
onPointerUpCapturePointerEventHandler<HTMLTableElement>
onProgressReactEventHandler<HTMLTableElement>
onProgressCaptureReactEventHandler<HTMLTableElement>
onRateChangeReactEventHandler<HTMLTableElement>
onRateChangeCaptureReactEventHandler<HTMLTableElement>
onResetFormEventHandler<HTMLTableElement>
onResetCaptureFormEventHandler<HTMLTableElement>
onResizeReactEventHandler<HTMLTableElement>
onResizeCaptureReactEventHandler<HTMLTableElement>
onScrollUIEventHandler<HTMLTableElement>
onScrollCaptureUIEventHandler<HTMLTableElement>
onSeekedReactEventHandler<HTMLTableElement>
onSeekedCaptureReactEventHandler<HTMLTableElement>
onSeekingReactEventHandler<HTMLTableElement>
onSeekingCaptureReactEventHandler<HTMLTableElement>
onSelectReactEventHandler<HTMLTableElement>
onSelectCaptureReactEventHandler<HTMLTableElement>
onStalledReactEventHandler<HTMLTableElement>
onStalledCaptureReactEventHandler<HTMLTableElement>
onSubmitFormEventHandler<HTMLTableElement>
onSubmitCaptureFormEventHandler<HTMLTableElement>
onSuspendReactEventHandler<HTMLTableElement>
onSuspendCaptureReactEventHandler<HTMLTableElement>
onTimeUpdateReactEventHandler<HTMLTableElement>
onTimeUpdateCaptureReactEventHandler<HTMLTableElement>
onTouchCancelTouchEventHandler<HTMLTableElement>
onTouchCancelCaptureTouchEventHandler<HTMLTableElement>
onTouchEndTouchEventHandler<HTMLTableElement>
onTouchEndCaptureTouchEventHandler<HTMLTableElement>
onTouchMoveTouchEventHandler<HTMLTableElement>
onTouchMoveCaptureTouchEventHandler<HTMLTableElement>
onTouchStartTouchEventHandler<HTMLTableElement>
onTouchStartCaptureTouchEventHandler<HTMLTableElement>
onTransitionEndTransitionEventHandler<HTMLTableElement>
onTransitionEndCaptureTransitionEventHandler<HTMLTableElement>
onUpdate() => void
A callback function executed each time an HOC of the table changes. For example, it's useful to fetch new data with the server side table
onVolumeChangeReactEventHandler<HTMLTableElement>
onVolumeChangeCaptureReactEventHandler<HTMLTableElement>
onWaitingReactEventHandler<HTMLTableElement>
onWaitingCaptureReactEventHandler<HTMLTableElement>
onWheelWheelEventHandler<HTMLTableElement>
onWheelCaptureWheelEventHandler<HTMLTableElement>
placeholderstring
prefixstring
propertystring
radioGroupstring
resourcestring
resultsnumber
roleAriaRole
securitystring
showBorderBottombooleantrue
Whether the table header has the "mod-border-bottom" css class. The header must have actions buttons for the style to be applied
showBorderTopbooleanfalse
Whether the table header has the "mod-border-top" css class. The header must have actions buttons for the style to be applied
slotstring
spellCheckBooleanish
styleCSSProperties
suppressContentEditableWarningboolean
suppressHydrationWarningboolean
tabIndexnumber
tableHeaderReactNode
Content of the header of the table
tbodyClassNamestring
Additionnal CSS classes for body of the table
titlestring
translate"yes" | "no"
typeofstring
unselectable"on" | "off"
vocabstring
"aria-dropeffect"deprecated"link" | "none" | "copy" | "execute" | "move" | "popup"
in ARIA 1.1
Indicates what functions can be performed when a dragged object is released on the drop target.
"aria-grabbed"deprecatedBooleanish
in ARIA 1.1
Indicates an element's "grabbed" state in a drag-and-drop operation.
onKeyPressdeprecatedKeyboardEventHandler<HTMLTableElement>
onKeyPressCapturedeprecatedKeyboardEventHandler<HTMLTableElement>

Examples

No guidelines exist for TableHOC yet.

Create guidelines