columns
RequiredDescription
The array of column defs to use for the table.
Type
Column<Y, any>[]PagingTable
PagingTable is a table component with pagination functionality.
Props
PagingTableProps
cellProps
Description
Props for table cell component.
Type
CellProps<Y>checkboxProps
Description
Props for table checkbox element.
Type
CheckboxProps<string>colorScheme
Description
The visual color appearance of the component.
Type
"blackAlpha" | "whiteAlpha" | "amber" | "blue" | "info" | "link" | "primary" | "cyan" | "emerald" | "flashy" | "fuchsia" | "gray" | "green" | "success" | "indigo" | "lime" | "neutral" | "orange" | "warning" | "pink" | "purple" | "red" | "danger" | "rose" | "sky" | "teal" | "violet" | "secondary" | "yellow"Default
"gray"containerProps
Description
Props for table container element.
Type
HTMLUIPropsdefaultColumn
Description
Default column options to use for all column defs supplied to the table.
Type
Partial<Column<Y, any>>defaultPageIndex
Description
The initial page index of the paging table.
Type
numberDefault
0defaultPageSize
Description
The initial page size of the paging table.
Type
numberDefault
20defaultSelectedRowIds
Description
The initial ids of the selected row.
Type
string[]defaultSort
Description
The initial sort of the table.
Type
Sort<Y>disabledRowIds
Description
The ids that disabled in selection.
Type
string[]footerGroupProps
Description
Props for table footer group component.
Type
HeaderGroupProps<Y>footerProps
Description
Props for table footer component.
Type
HeaderProps<Y>formatPageSizeLabel
Description
Function to format the label used for the options in a select.
Type
(pageSize: number) => stringheaderGroupProps
Description
Props for table header group component.
Type
HeaderGroupProps<Y>headerProps
Description
Props for table header component.
Type
HeaderProps<Y>highlightOnHover
Description
If true, highlight the row when the table row is hovered.
Type
booleanDefault
falsehighlightOnSelected
Description
If true, highlight the row when the table row is selected.
Type
booleanDefault
falseisFocusable
Description
If true, the table cell will be focusable.
Type
booleanDefault
truelayout
Description
The CSS table-layout property.
Type
"auto" | "fixed" | "-moz-initial" | "inherit" | "initial" | "revert" | "revert-layer" | "unset" | [TableLayout | { [x: string]: TableLayout | undefined; ... 5 more ...; xl?: TableLayout | undefined; }, TableLayout | { ...; }] | { ...; } | [...] | { ...; } | ((theme: StyledTheme) => UIValue<...>)onChangePageIndex
Description
The callback invoked when page index is changed.
Type
(pageIndex: number) => voidonChangePageSize
Description
The callback invoked when page size is changed.
Type
(pageIndex: number) => voidonChangeSelect
Description
The callback invoked when row is selected.
Type
(rowSelection: string[]) => voidonChangeSort
Description
The callback invoked when table sort is changed.
Type
(sort: Sort<Y>) => voidonClickRow
Description
The callback invoked when a row is clicked.
Type
(row: Row<Y>) => voidonDoubleClickRow
Description
The callback invoked when a row is double clicked.
Type
(row: Row<Y>) => voidpageIndex
Description
The page index of the paging table.
Type
numberpageSize
Description
The page size of the paging table.
Type
numberpageSizeList
Description
The list of the page size.
Type
number[]Default
'[20, 50, 100]'paginationProps
Description
Props for pagination element.
Type
Omit<PaginationProps,
"page" | "onChange" | "defaultPage" | "total">pagingControlProps
Description
Props for paging control element.
Type
HTMLUIPropsrowHeader
Description
The role used for the row header. This is used for accessibility to announce the selected row.
Type
keyof YrowId
Description
The id used to store the value when selected.
Type
keyof YrowProps
Description
Props for table row component.
Type
RowProps<Y>rowsClickSelect
Description
If true, allows selection by clicking on a row.
Type
booleanDefault
falseselectColumnProps
Description
Props for table select column component.
Type
false | SelectColumn<Y, any>selectedRowIds
Description
The ids of the selected row.
Type
string[]selectProps
Description
Props for select element.
Type
Omit<SelectProps,
| "children"
| "defaultValue"
| "onChange"
| "data"
| "value"
| "placeholderInOptions">size
Description
The size of the PagingTable.
Type
"sm" | "md" | "lg" | "xl"Default
"md"sort
Description
The sort of the table.
Type
Sort<Y>sortIconProps
Description
Props for table sort icon element.
Type
IconPropstbodyProps
Description
Props for table tbody element.
Type
TableBodyPropstfootProps
Description
Props for table tfoot element.
Type
TableFootPropstheadProps
Description
Props for table thead element.
Type
TableHeadPropsvariant
Description
The variant of the PagingTable.
Type
"simple" | "striped" | "unstyled"Default
"simple"withBorder
Description
If true, display the outer border of the table.
Type
booleanDefault
falsewithColumnBorders
Description
If true, display line on the columns of the table.
Type
booleanDefault
falsewithFooter
Description
If true, display the table footer.
Type
booleanDefault
falsewithFooterSelect
Description
If true, display the checkbox in table footer.
Type
booleanDefault
falsewithPagingControl
Description
If true, display the paging control.
Type
booleanDefault
trueEdit this page on GitHub