Skip to main content

Introducing Workflow Engine, try for FREE workflowengine.io.

Interface: EditableTableProps

The React component properties for the EditableTable component.

Extends​

  • TableProps<any, any>

Properties​

about?​

optional about: string

Inherited from​

TableProps.about

accessKey?​

optional accessKey: string

Inherited from​

TableProps.accessKey

affixHeader?​

optional affixHeader: number | boolean

Affix the table header to the specified position on the page

Inherited from​

TableProps.affixHeader

affixHorizontalScrollbar?​

optional affixHorizontalScrollbar: number | boolean

Affix the table horizontal scrollbar to the specified position on the page

Inherited from​

TableProps.affixHorizontalScrollbar

aria-activedescendant?​

optional aria-activedescendant: string

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

Inherited from​

TableProps.aria-activedescendant

aria-atomic?​

optional 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.

Inherited from​

TableProps.aria-atomic

aria-autocomplete?​

optional aria-autocomplete: "none" | "list" | "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.

Inherited from​

TableProps.aria-autocomplete

aria-busy?​

optional 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.

Inherited from​

TableProps.aria-busy

aria-checked?​

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

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

See​

  • aria-pressed
  • aria-selected.

Inherited from​

TableProps.aria-checked

aria-colcount?​

optional aria-colcount: number

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

See​

aria-colindex.

Inherited from​

TableProps.aria-colcount

aria-colindex?​

optional 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.

See​

  • aria-colcount
  • aria-colspan.

Inherited from​

TableProps.aria-colindex

aria-colspan?​

optional aria-colspan: number

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

See​

  • aria-colindex
  • aria-rowspan.

Inherited from​

TableProps.aria-colspan

aria-controls?​

optional aria-controls: string

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

See​

aria-owns.

Inherited from​

TableProps.aria-controls

aria-current?​

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

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

Inherited from​

TableProps.aria-current

aria-describedby?​

optional aria-describedby: string

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

See​

aria-labelledby

Inherited from​

TableProps.aria-describedby

aria-details?​

optional aria-details: string

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

See​

aria-describedby.

Inherited from​

TableProps.aria-details

aria-disabled?​

optional aria-disabled: Booleanish

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

See​

  • aria-hidden
  • aria-readonly.

Inherited from​

TableProps.aria-disabled

aria-dropeffect?​

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

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

Deprecated​

in ARIA 1.1

Inherited from​

TableProps.aria-dropeffect

aria-errormessage?​

optional aria-errormessage: string

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

See​

  • aria-invalid
  • aria-describedby.

Inherited from​

TableProps.aria-errormessage

aria-expanded?​

optional aria-expanded: Booleanish

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

Inherited from​

TableProps.aria-expanded

aria-flowto?​

optional 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.

Inherited from​

TableProps.aria-flowto

aria-grabbed?​

optional aria-grabbed: Booleanish

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

Deprecated​

in ARIA 1.1

Inherited from​

TableProps.aria-grabbed

aria-haspopup?​

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

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

Inherited from​

TableProps.aria-haspopup

aria-hidden?​

optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See​

aria-disabled.

Inherited from​

TableProps.aria-hidden

aria-invalid?​

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

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

See​

aria-errormessage.

Inherited from​

TableProps.aria-invalid

aria-keyshortcuts?​

optional aria-keyshortcuts: string

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

Inherited from​

TableProps.aria-keyshortcuts

aria-label?​

optional aria-label: string

Defines a string value that labels the current element.

See​

aria-labelledby.

Inherited from​

TableProps.aria-label

aria-labelledby?​

optional aria-labelledby: string

Identifies the element (or elements) that labels the current element.

See​

aria-describedby.

Inherited from​

TableProps.aria-labelledby

aria-level?​

optional aria-level: number

Defines the hierarchical level of an element within a structure.

Inherited from​

TableProps.aria-level

aria-live?​

optional 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.

Inherited from​

TableProps.aria-live

aria-modal?​

optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from​

TableProps.aria-modal

aria-multiline?​

optional aria-multiline: Booleanish

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

Inherited from​

TableProps.aria-multiline

aria-multiselectable?​

optional aria-multiselectable: Booleanish

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

Inherited from​

TableProps.aria-multiselectable

aria-orientation?​

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

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

Inherited from​

TableProps.aria-orientation

aria-owns?​

optional 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.

See​

aria-controls.

Inherited from​

TableProps.aria-owns

aria-placeholder?​

optional 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.

Inherited from​

TableProps.aria-placeholder

aria-posinset?​

optional 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.

See​

aria-setsize.

Inherited from​

TableProps.aria-posinset

aria-pressed?​

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

Indicates the current "pressed" state of toggle buttons.

See​

  • aria-checked
  • aria-selected.

Inherited from​

TableProps.aria-pressed

aria-readonly?​

optional aria-readonly: Booleanish

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

See​

aria-disabled.

Inherited from​

TableProps.aria-readonly

aria-relevant?​

optional aria-relevant: "text" | "all" | "additions" | "additions removals" | "additions text" | "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.

See​

aria-atomic.

Inherited from​

TableProps.aria-relevant

aria-required?​

optional aria-required: Booleanish

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

Inherited from​

TableProps.aria-required

aria-roledescription?​

optional aria-roledescription: string

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

Inherited from​

TableProps.aria-roledescription

aria-rowcount?​

optional aria-rowcount: number

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

See​

aria-rowindex.

Inherited from​

TableProps.aria-rowcount

aria-rowindex?​

optional 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.

See​

  • aria-rowcount
  • aria-rowspan.

Inherited from​

TableProps.aria-rowindex

aria-rowspan?​

optional aria-rowspan: number

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

See​

  • aria-rowindex
  • aria-colspan.

Inherited from​

TableProps.aria-rowspan

aria-selected?​

optional aria-selected: Booleanish

Indicates the current "selected" state of various widgets.

See​

  • aria-checked
  • aria-pressed.

Inherited from​

TableProps.aria-selected

aria-setsize?​

optional 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.

See​

aria-posinset.

Inherited from​

TableProps.aria-setsize

aria-sort?​

optional aria-sort: "none" | "other" | "ascending" | "descending"

Indicates if items in a table or grid are sorted in ascending or descending order.

Inherited from​

TableProps.aria-sort

aria-valuemax?​

optional aria-valuemax: number

Defines the maximum allowed value for a range widget.

Inherited from​

TableProps.aria-valuemax

aria-valuemin?​

optional aria-valuemin: number

Defines the minimum allowed value for a range widget.

Inherited from​

TableProps.aria-valuemin

aria-valuenow?​

optional aria-valuenow: number

Defines the current value for a range widget.

See​

aria-valuetext.

Inherited from​

TableProps.aria-valuenow

aria-valuetext?​

optional aria-valuetext: string

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

Inherited from​

TableProps.aria-valuetext

autoAdd?​

optional autoAdd: boolean

Flag, if true, one new row will be automatically added when editing the last row of the table, false otherwise.

autoCapitalize?​

optional autoCapitalize: string

Inherited from​

TableProps.autoCapitalize

autoCorrect?​

optional autoCorrect: string

Inherited from​

TableProps.autoCorrect

autoFocus?​

optional autoFocus: boolean

Inherited from​

TableProps.autoFocus

autoHeight?​

optional autoHeight: boolean

The height of the table will be automatically expanded according to the number of data rows, and no vertical scroll bar will appear

Inherited from​

TableProps.autoHeight

autoSave?​

optional autoSave: string

Inherited from​

TableProps.autoSave

bodyRef()?​

optional bodyRef: (ref) => void

A ref attached to the table body element

Parameters​

• ref: HTMLElement

Returns​

void

Deprecated​

use ref instead (see ref.current.body)

Inherited from​

TableProps.bodyRef

bordered?​

optional bordered: boolean

Show the border of the table

Inherited from​

TableProps.bordered

cellBordered?​

optional cellBordered: boolean

Display the borders of table cells

Inherited from​

TableProps.cellBordered

children?​

optional children: ReactNode | ReactNode[] | (props) => ReactNode | ReactNode[]

Inherited from​

TableProps.children

className?​

optional className: string

Additional classes

Inherited from​

TableProps.className

classPrefix?​

optional classPrefix: string

The prefix of the component CSS class

Inherited from​

TableProps.classPrefix

color?​

optional color: string

Inherited from​

TableProps.color

columns?​

optional columns: Element[]

The columns of the table.

contentEditable?​

optional contentEditable: "inherit" | Booleanish

Inherited from​

TableProps.contentEditable

contextMenu?​

optional contextMenu: string

Inherited from​

TableProps.contextMenu

dangerouslySetInnerHTML?​

optional dangerouslySetInnerHTML: object

__html​

__html: string

Inherited from​

TableProps.dangerouslySetInnerHTML

data​

data: RowDataType<any>[]

The table data.

Overrides​

TableProps.data

datatype?​

optional datatype: string

Inherited from​

TableProps.datatype

defaultChecked?​

optional defaultChecked: boolean

Inherited from​

TableProps.defaultChecked

defaultExpandAllRows?​

optional defaultExpandAllRows: boolean

Expand all nodes By default

Inherited from​

TableProps.defaultExpandAllRows

defaultExpandedRowKeys?​

optional defaultExpandedRowKeys: readonly any[]

Specify the default expanded row by rowkey

Inherited from​

TableProps.defaultExpandedRowKeys

defaultSortType?​

optional defaultSortType: SortType

Default sort type

Inherited from​

TableProps.defaultSortType

defaultValue?​

optional defaultValue: string | number | readonly string[]

Inherited from​

TableProps.defaultValue

dir?​

optional dir: string

Inherited from​

TableProps.dir

disabledScroll?​

optional disabledScroll: boolean

Disable scroll bar

Inherited from​

TableProps.disabledScroll

draggable?​

optional draggable: Booleanish

Inherited from​

TableProps.draggable

errorMessage?​

optional errorMessage: string

The error message.

expandedRowKeys?​

optional expandedRowKeys: readonly any[]

Specify the default expanded row by rowkey (Controlled)

Inherited from​

TableProps.expandedRowKeys

fillHeight?​

optional fillHeight: boolean

Force the height of the table to be equal to the height of its parent container. Cannot be used together with autoHeight.

Inherited from​

TableProps.fillHeight

headerHeight?​

optional headerHeight: number

The height of the table header

Inherited from​

TableProps.headerHeight

height?​

optional height: number

The visible height of the table (the height of the scrollable container).

Inherited from​

TableProps.height

hidden?​

optional hidden: boolean

Inherited from​

TableProps.hidden

hideHeader?​

optional hideHeader: boolean

Flag, if true then the table header will be hidden, false otherwise.

hover?​

optional hover: boolean

The row of the table has a mouseover effect

Inherited from​

TableProps.hover

id?​

optional id: string

Inherited from​

TableProps.id

inlist?​

optional inlist: any

Inherited from​

TableProps.inlist

inputMode?​

optional inputMode: "search" | "text" | "none" | "email" | "url" | "tel" | "numeric" | "decimal"

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

See​

https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

Inherited from​

TableProps.inputMode

is?​

optional is: string

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

See​

https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

Inherited from​

TableProps.is

isTree?​

optional isTree: boolean

The table will be displayed as a tree structure

Inherited from​

TableProps.isTree

itemID?​

optional itemID: string

Inherited from​

TableProps.itemID

itemProp?​

optional itemProp: string

Inherited from​

TableProps.itemProp

itemRef?​

optional itemRef: string

Inherited from​

TableProps.itemRef

itemScope?​

optional itemScope: boolean

Inherited from​

TableProps.itemScope

itemType?​

optional itemType: string

Inherited from​

TableProps.itemType

label?​

optional label: string

The table label.

lang?​

optional lang: string

Inherited from​

TableProps.lang

loadAnimation?​

optional loadAnimation: boolean

Whether to enable loading animation

Inherited from​

TableProps.loadAnimation

loading?​

optional loading: boolean

Show loading

Inherited from​

TableProps.loading

locale?​

optional locale: TableLocaleType

The component localized character set.

Inherited from​

TableProps.locale

maxRows?​

optional maxRows: number

Maximum number of rows to be displayed.

minHeight?​

optional minHeight: number

The minimum height of the table. The height is maintained even when the content is not stretched.

Inherited from​

TableProps.minHeight

nonce?​

optional nonce: string

Inherited from​

TableProps.nonce

onAbort?​

optional onAbort: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onAbort

onAbortCapture?​

optional onAbortCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onAbortCapture

onAnimationEnd?​

optional onAnimationEnd: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationEnd

onAnimationEndCapture?​

optional onAnimationEndCapture: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationEndCapture

onAnimationIteration?​

optional onAnimationIteration: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationIteration

onAnimationIterationCapture?​

optional onAnimationIterationCapture: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationIterationCapture

onAnimationStart?​

optional onAnimationStart: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationStart

onAnimationStartCapture?​

optional onAnimationStartCapture: AnimationEventHandler<HTMLElement>

Inherited from​

TableProps.onAnimationStartCapture

onAuxClick?​

optional onAuxClick: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onAuxClick

onAuxClickCapture?​

optional onAuxClickCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onAuxClickCapture

onBeforeInput?​

optional onBeforeInput: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onBeforeInput

onBeforeInputCapture?​

optional onBeforeInputCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onBeforeInputCapture

onBlur?​

optional onBlur: FocusEventHandler<HTMLElement>

Inherited from​

TableProps.onBlur

onBlurCapture?​

optional onBlurCapture: FocusEventHandler<HTMLElement>

Inherited from​

TableProps.onBlurCapture

onCanPlay?​

optional onCanPlay: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onCanPlay

onCanPlayCapture?​

optional onCanPlayCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onCanPlayCapture

onCanPlayThrough?​

optional onCanPlayThrough: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onCanPlayThrough

onCanPlayThroughCapture?​

optional onCanPlayThroughCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onCanPlayThroughCapture

onChange?​

optional onChange: FormEventHandler<HTMLElement>

The callback function called when data in the table is changed.

Overrides​

TableProps.onChange

onChangeCapture?​

optional onChangeCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onChangeCapture

onClick?​

optional onClick: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onClick

onClickCapture?​

optional onClickCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onClickCapture

onCompositionEnd?​

optional onCompositionEnd: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionEnd

onCompositionEndCapture?​

optional onCompositionEndCapture: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionEndCapture

onCompositionStart?​

optional onCompositionStart: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionStart

onCompositionStartCapture?​

optional onCompositionStartCapture: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionStartCapture

onCompositionUpdate?​

optional onCompositionUpdate: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionUpdate

onCompositionUpdateCapture?​

optional onCompositionUpdateCapture: CompositionEventHandler<HTMLElement>

Inherited from​

TableProps.onCompositionUpdateCapture

onContextMenu?​

optional onContextMenu: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onContextMenu

onContextMenuCapture?​

optional onContextMenuCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onContextMenuCapture

onCopy?​

optional onCopy: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onCopy

onCopyCapture?​

optional onCopyCapture: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onCopyCapture

onCut?​

optional onCut: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onCut

onCutCapture?​

optional onCutCapture: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onCutCapture

onDataUpdated()?​

optional onDataUpdated: (nextData, scrollTo) => void

Callback after table data update.

Parameters​

• nextData: any[]

• scrollTo

Returns​

void

Deprecated​

use shouldUpdateScroll instead

Inherited from​

TableProps.onDataUpdated

onDoubleClick?​

optional onDoubleClick: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onDoubleClick

onDoubleClickCapture?​

optional onDoubleClickCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onDoubleClickCapture

onDrag?​

optional onDrag: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDrag

onDragCapture?​

optional onDragCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragCapture

onDragEnd?​

optional onDragEnd: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragEnd

onDragEndCapture?​

optional onDragEndCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragEndCapture

onDragEnter?​

optional onDragEnter: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragEnter

onDragEnterCapture?​

optional onDragEnterCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragEnterCapture

onDragExit?​

optional onDragExit: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragExit

onDragExitCapture?​

optional onDragExitCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragExitCapture

onDragLeave?​

optional onDragLeave: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragLeave

onDragLeaveCapture?​

optional onDragLeaveCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragLeaveCapture

onDragOver?​

optional onDragOver: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragOver

onDragOverCapture?​

optional onDragOverCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragOverCapture

onDragStart?​

optional onDragStart: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragStart

onDragStartCapture?​

optional onDragStartCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDragStartCapture

onDrop?​

optional onDrop: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDrop

onDropCapture?​

optional onDropCapture: DragEventHandler<HTMLElement>

Inherited from​

TableProps.onDropCapture

onDurationChange?​

optional onDurationChange: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onDurationChange

onDurationChangeCapture?​

optional onDurationChangeCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onDurationChangeCapture

onEmptied?​

optional onEmptied: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEmptied

onEmptiedCapture?​

optional onEmptiedCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEmptiedCapture

onEncrypted?​

optional onEncrypted: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEncrypted

onEncryptedCapture?​

optional onEncryptedCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEncryptedCapture

onEnded?​

optional onEnded: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEnded

onEndedCapture?​

optional onEndedCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onEndedCapture

onError?​

optional onError: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onError

onErrorCapture?​

optional onErrorCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onErrorCapture

onExpandChange()?​

optional onExpandChange: (expanded, rowData) => void

Tree table, the callback function in the expanded node

Parameters​

• expanded: boolean

• rowData: any

Returns​

void

Inherited from​

TableProps.onExpandChange

onFocus?​

optional onFocus: FocusEventHandler<HTMLElement>

Inherited from​

TableProps.onFocus

onFocusCapture?​

optional onFocusCapture: FocusEventHandler<HTMLElement>

Inherited from​

TableProps.onFocusCapture

onGotPointerCapture?​

optional onGotPointerCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onGotPointerCapture

onGotPointerCaptureCapture?​

optional onGotPointerCaptureCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onGotPointerCaptureCapture

onInput?​

optional onInput: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onInput

onInputCapture?​

optional onInputCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onInputCapture

onInvalid?​

optional onInvalid: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onInvalid

onInvalidCapture?​

optional onInvalidCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onInvalidCapture

onKeyDown?​

optional onKeyDown: KeyboardEventHandler<HTMLElement>

Inherited from​

TableProps.onKeyDown

onKeyDownCapture?​

optional onKeyDownCapture: KeyboardEventHandler<HTMLElement>

Inherited from​

TableProps.onKeyDownCapture

onKeyPress?​

optional onKeyPress: KeyboardEventHandler<HTMLElement>

Deprecated​

Inherited from​

TableProps.onKeyPress

onKeyPressCapture?​

optional onKeyPressCapture: KeyboardEventHandler<HTMLElement>

Deprecated​

Inherited from​

TableProps.onKeyPressCapture

onKeyUp?​

optional onKeyUp: KeyboardEventHandler<HTMLElement>

Inherited from​

TableProps.onKeyUp

onKeyUpCapture?​

optional onKeyUpCapture: KeyboardEventHandler<HTMLElement>

Inherited from​

TableProps.onKeyUpCapture

onLoad?​

optional onLoad: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoad

onLoadCapture?​

optional onLoadCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadCapture

onLoadStart?​

optional onLoadStart: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadStart

onLoadStartCapture?​

optional onLoadStartCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadStartCapture

onLoadedData?​

optional onLoadedData: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadedData

onLoadedDataCapture?​

optional onLoadedDataCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadedDataCapture

onLoadedMetadata?​

optional onLoadedMetadata: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadedMetadata

onLoadedMetadataCapture?​

optional onLoadedMetadataCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onLoadedMetadataCapture

onLostPointerCapture?​

optional onLostPointerCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onLostPointerCapture

onLostPointerCaptureCapture?​

optional onLostPointerCaptureCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onLostPointerCaptureCapture

onMouseDown?​

optional onMouseDown: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseDown

onMouseDownCapture?​

optional onMouseDownCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseDownCapture

onMouseEnter?​

optional onMouseEnter: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseEnter

onMouseLeave?​

optional onMouseLeave: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseLeave

onMouseMove?​

optional onMouseMove: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseMove

onMouseMoveCapture?​

optional onMouseMoveCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseMoveCapture

onMouseOut?​

optional onMouseOut: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseOut

onMouseOutCapture?​

optional onMouseOutCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseOutCapture

onMouseOver?​

optional onMouseOver: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseOver

onMouseOverCapture?​

optional onMouseOverCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseOverCapture

onMouseUp?​

optional onMouseUp: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseUp

onMouseUpCapture?​

optional onMouseUpCapture: MouseEventHandler<HTMLElement>

Inherited from​

TableProps.onMouseUpCapture

onPaste?​

optional onPaste: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onPaste

onPasteCapture?​

optional onPasteCapture: ClipboardEventHandler<HTMLElement>

Inherited from​

TableProps.onPasteCapture

onPause?​

optional onPause: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPause

onPauseCapture?​

optional onPauseCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPauseCapture

onPlay?​

optional onPlay: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPlay

onPlayCapture?​

optional onPlayCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPlayCapture

onPlaying?​

optional onPlaying: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPlaying

onPlayingCapture?​

optional onPlayingCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onPlayingCapture

onPointerCancel?​

optional onPointerCancel: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerCancel

onPointerCancelCapture?​

optional onPointerCancelCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerCancelCapture

onPointerDown?​

optional onPointerDown: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerDown

onPointerDownCapture?​

optional onPointerDownCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerDownCapture

onPointerEnter?​

optional onPointerEnter: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerEnter

onPointerEnterCapture?​

optional onPointerEnterCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerEnterCapture

onPointerLeave?​

optional onPointerLeave: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerLeave

onPointerLeaveCapture?​

optional onPointerLeaveCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerLeaveCapture

onPointerMove?​

optional onPointerMove: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerMove

onPointerMoveCapture?​

optional onPointerMoveCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerMoveCapture

onPointerOut?​

optional onPointerOut: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerOut

onPointerOutCapture?​

optional onPointerOutCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerOutCapture

onPointerOver?​

optional onPointerOver: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerOver

onPointerOverCapture?​

optional onPointerOverCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerOverCapture

onPointerUp?​

optional onPointerUp: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerUp

onPointerUpCapture?​

optional onPointerUpCapture: PointerEventHandler<HTMLElement>

Inherited from​

TableProps.onPointerUpCapture

onProgress?​

optional onProgress: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onProgress

onProgressCapture?​

optional onProgressCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onProgressCapture

onRateChange?​

optional onRateChange: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onRateChange

onRateChangeCapture?​

optional onRateChangeCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onRateChangeCapture

onReset?​

optional onReset: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onReset

onResetCapture?​

optional onResetCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onResetCapture

onRowClick()?​

optional onRowClick: (rowData, event) => void

Click the callback function after the row and return to rowDate

Parameters​

• rowData: any

• event: MouseEvent<Element, MouseEvent>

Returns​

void

Inherited from​

TableProps.onRowClick

onRowContextMenu()?​

optional onRowContextMenu: (rowData, event) => void

Callback after right-click row

Parameters​

• rowData: any

• event: MouseEvent<Element, MouseEvent>

Returns​

void

Inherited from​

TableProps.onRowContextMenu

onScroll()?​

optional onScroll: (scrollX, scrollY) => void

Callback function for scroll bar scrolling

Parameters​

• scrollX: number

• scrollY: number

Returns​

void

Inherited from​

TableProps.onScroll

onScrollCapture?​

optional onScrollCapture: UIEventHandler<HTMLElement>

Inherited from​

TableProps.onScrollCapture

onSeeked?​

optional onSeeked: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSeeked

onSeekedCapture?​

optional onSeekedCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSeekedCapture

onSeeking?​

optional onSeeking: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSeeking

onSeekingCapture?​

optional onSeekingCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSeekingCapture

onSelect?​

optional onSelect: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSelect

onSelectCapture?​

optional onSelectCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSelectCapture

onSortColumn()?​

optional onSortColumn: (dataKey, sortType?) => void

Click the callback function of the sort sequence to return the value sortColumn, sortType

Parameters​

• dataKey: string

• sortType?: SortType

Returns​

void

Inherited from​

TableProps.onSortColumn

onStalled?​

optional onStalled: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onStalled

onStalledCapture?​

optional onStalledCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onStalledCapture

onSubmit?​

optional onSubmit: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onSubmit

onSubmitCapture?​

optional onSubmitCapture: FormEventHandler<HTMLElement>

Inherited from​

TableProps.onSubmitCapture

onSuspend?​

optional onSuspend: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSuspend

onSuspendCapture?​

optional onSuspendCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onSuspendCapture

onTimeUpdate?​

optional onTimeUpdate: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onTimeUpdate

onTimeUpdateCapture?​

optional onTimeUpdateCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onTimeUpdateCapture

onTouchCancel?​

optional onTouchCancel: TouchEventHandler<HTMLElement>

Inherited from​

TableProps.onTouchCancel

onTouchCancelCapture?​

optional onTouchCancelCapture: TouchEventHandler<HTMLElement>

Inherited from​

TableProps.onTouchCancelCapture

onTouchEnd()?​

optional onTouchEnd: (event) => void

Callback for the touchend event.

Parameters​

• event: TouchEvent<Element>

Returns​

void

Inherited from​

TableProps.onTouchEnd

onTouchEndCapture?​

optional onTouchEndCapture: TouchEventHandler<HTMLElement>

Inherited from​

TableProps.onTouchEndCapture

onTouchMove()?​

optional onTouchMove: (event) => void

Callback for the touchmove event.

Parameters​

• event: TouchEvent<Element>

Returns​

void

Inherited from​

TableProps.onTouchMove

onTouchMoveCapture?​

optional onTouchMoveCapture: TouchEventHandler<HTMLElement>

Inherited from​

TableProps.onTouchMoveCapture

onTouchStart()?​

optional onTouchStart: (event) => void

Callback for the touchstart event.

Parameters​

• event: TouchEvent<Element>

Returns​

void

Inherited from​

TableProps.onTouchStart

onTouchStartCapture?​

optional onTouchStartCapture: TouchEventHandler<HTMLElement>

Inherited from​

TableProps.onTouchStartCapture

onTransitionEnd?​

optional onTransitionEnd: TransitionEventHandler<HTMLElement>

Inherited from​

TableProps.onTransitionEnd

onTransitionEndCapture?​

optional onTransitionEndCapture: TransitionEventHandler<HTMLElement>

Inherited from​

TableProps.onTransitionEndCapture

onVolumeChange?​

optional onVolumeChange: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onVolumeChange

onVolumeChangeCapture?​

optional onVolumeChangeCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onVolumeChangeCapture

onWaiting?​

optional onWaiting: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onWaiting

onWaitingCapture?​

optional onWaitingCapture: ReactEventHandler<HTMLElement>

Inherited from​

TableProps.onWaitingCapture

onWheel?​

optional onWheel: WheelEventHandler<HTMLElement>

Inherited from​

TableProps.onWheel

onWheelCapture?​

optional onWheelCapture: WheelEventHandler<HTMLElement>

Inherited from​

TableProps.onWheelCapture

placeholder?​

optional placeholder: string

Inherited from​

TableProps.placeholder

prefix?​

optional prefix: string

Inherited from​

TableProps.prefix

property?​

optional property: string

Inherited from​

TableProps.property

radioGroup?​

optional radioGroup: string

Inherited from​

TableProps.radioGroup

renderEmpty()?​

optional renderEmpty: (info) => ReactNode

Customized data is empty display content

Parameters​

• info: ReactNode

Returns​

ReactNode

Inherited from​

TableProps.renderEmpty

renderLoading()?​

optional renderLoading: (loading) => ReactNode

Customize the display content in the data load

Parameters​

• loading: ReactNode

Returns​

ReactNode

Inherited from​

TableProps.renderLoading

renderRow()?​

optional renderRow: (children?, rowData?) => ReactNode

Custom row element

Parameters​

• children?: ReactNode

• rowData?: any

Returns​

ReactNode

Inherited from​

TableProps.renderRow

renderRowExpanded()?​

optional renderRowExpanded: (rowData?) => ReactNode

Customize what you can do to expand a zone

Parameters​

• rowData?: any

Returns​

ReactNode

Inherited from​

TableProps.renderRowExpanded

renderTreeToggle()?​

optional renderTreeToggle: (expandButton, rowData?, expanded?) => ReactNode

Tree table, the callback function in the expanded node

Parameters​

• expandButton: ReactNode

• rowData?: any

• expanded?: boolean

Returns​

ReactNode

Inherited from​

TableProps.renderTreeToggle

resource?​

optional resource: string

Inherited from​

TableProps.resource

results?​

optional results: number

Inherited from​

TableProps.results

role?​

optional role: AriaRole

Inherited from​

TableProps.role

rowClassName?​

optional rowClassName: string | (rowData, rowIndex) => string

Add an optional extra class name to row

Inherited from​

TableProps.rowClassName

rowExpandedHeight?​

optional rowExpandedHeight: number | (rowData?) => number

Set the height of an expandable area

Inherited from​

TableProps.rowExpandedHeight

rowHeight?​

optional rowHeight: number | (rowData?) => number

The row height of the table

Inherited from​

TableProps.rowHeight

rowKey?​

optional rowKey: RowKeyType

Each row corresponds to the unique key in data

Inherited from​

TableProps.rowKey

rtl?​

optional rtl: boolean

Right to left

Inherited from​

TableProps.rtl

security?​

optional security: string

Inherited from​

TableProps.security

shouldUpdateScroll?​

optional shouldUpdateScroll: boolean | (event) => object

Use the return value of shouldUpdateScroll to determine whether to update the scroll after the table size is updated.

Inherited from​

TableProps.shouldUpdateScroll

showHeader?​

optional showHeader: boolean

Whether to display the header of the table

Inherited from​

TableProps.showHeader

slot?​

optional slot: string

Inherited from​

TableProps.slot

sortColumn?​

optional sortColumn: string

Sort Column Name

Inherited from​

TableProps.sortColumn

sortType?​

optional sortType: SortType

Sort type

Inherited from​

TableProps.sortType

spellCheck?​

optional spellCheck: Booleanish

Inherited from​

TableProps.spellCheck

style?​

optional style: CSSProperties

Additional style

Inherited from​

TableProps.style

suppressContentEditableWarning?​

optional suppressContentEditableWarning: boolean

Inherited from​

TableProps.suppressContentEditableWarning

suppressHydrationWarning?​

optional suppressHydrationWarning: boolean

Inherited from​

TableProps.suppressHydrationWarning

tabIndex?​

optional tabIndex: number

Inherited from​

TableProps.tabIndex

title?​

optional title: string

Inherited from​

TableProps.title

translate?​

optional translate: "no" | "yes"

Inherited from​

TableProps.translate

translate3d?​

optional translate3d: boolean

Enable 3D transition rendering to improve performance when scrolling.

Inherited from​

TableProps.translate3d

typeof?​

optional typeof: string

Inherited from​

TableProps.typeof

unselectable?​

optional unselectable: "on" | "off"

Inherited from​

TableProps.unselectable

virtualized?​

optional virtualized: boolean

Effectively render large tabular data

Inherited from​

TableProps.virtualized

vocab?​

optional vocab: string

Inherited from​

TableProps.vocab

width?​

optional width: number

The width of the table. When it is not set, it will adapt according to the container

Inherited from​

TableProps.width

wordWrap?​

optional wordWrap: boolean | "break-all" | "break-word" | "keep-all"

Whether to appear line breaks where text overflows its content box https://developer.mozilla.org/en-US/docs/Web/CSS/word-break

Inherited from​

TableProps.wordWrap