Function Table

Table<C extends string>(__namedParameters: TableProps<C>): Element
A table for displaying data. Analogous to the HTML <table> element.

For less advanced handling (with fewer prop requirements), see the BasicTable component.
Type Parameters
- C extends string
Parameters
- __namedParameters: TableProps<C>
Returns Element

Index

Properties

Methods

Body Cell Container FillerRow Footer Header Heading Row Toolbar

Properties

useScrollSync

useScrollSync: () => { scrollSyncID: number; synchronizeScroll: () => void }

Type Declaration

- (): { scrollSyncID: number; synchronizeScroll: () => void }
- Provides a scrollSyncID value a function to update its value. (Wraps useSync from Core). Utility for the scrollSyncID prop on the Table component.
  
  Returns { scrollSyncID: number; synchronizeScroll: () => void }

Methods

Body

Body(__namedParameters: TableBodyProps): Element
The body of a table. Analogous to the HTML <tbody> element.
Parameters
- __namedParameters: TableBodyProps
Returns Element

Cell

Cell(__namedParameters: TableCellProps): Element
A cell of a table. Analogous to the HTML <td> element.
Parameters
- __namedParameters: TableCellProps
Returns Element

Container

Container(__namedParameters: TableContainerProps): Element
A container for a table.
Parameters
- __namedParameters: TableContainerProps
Returns Element

FillerRow

FillerRow(__namedParameters: TableFillerRowProps): Element
A filler row of a table. Useful for maintaining table height with pagination or variable data.
Parameters
- __namedParameters: TableFillerRowProps
Returns Element

Footer(__namedParameters: TableFooterProps): Element
The footer of a table. Analogous to the HTML <tfoot> element.
Parameters
- __namedParameters: TableFooterProps
Returns Element

Header(__namedParameters: TableHeaderProps): Element
The header of a table. Analogous to the HTML <thead> element.
Parameters
- __namedParameters: TableHeaderProps
Returns Element

Heading

Heading<T extends string>(__namedParameters: TableHeadingProps<T>): Element
A heading of a table. Analogous to the HTML <th> element.
Type Parameters
- T extends string
Parameters
- __namedParameters: TableHeadingProps<T>
Returns Element

Row

Row(__namedParameters: TableRowProps): Element
A row of a table. Analogous to the HTML <tr> element.
Parameters
- __namedParameters: TableRowProps
Returns Element

Toolbar(__namedParameters: TableToolbarProps): Element
Toolbar for a table. Should contain controls for interacting with the table. Must be placed under the table and be a child of a <Table.Container> for sticky positioning to work correctly.
Parameters
- __namedParameters: TableToolbarProps
Returns Element