Learn about the Table component for use in UI extensions.
Table
component renders a table for displaying and organizing data.
Below, learn how to implement buttons in a UI extension. For guidance on table design, check out the Table design patterns.
To format the table, you can use the following subcomponents:
TableHead
: the header section of the table containing column labels.TableRow
: individual table rows.TableHeader
: cells containing bolded column labels.TableBody
: container for the main table contents (rows and cells).TableCell
: individual cells within the main body.TableFooter
: a row at the bottom of the table, typically to summarize the columns.Prop | Type | Description |
---|---|---|
bordered | Boolean | When set to false , the table will not include borders. Default is true . |
flush | Boolean | When set to true , the table will not include bottom margin. Default is false . |
paginated | Boolean | When set to true , the table will include pagination navigation. Default is false .See the paginated tables section for pagination props. |
Prop | Type | Description |
---|---|---|
align | 'center' | 'left' | 'right' | Sets the alignment of a table header. |
sortDirection | 'none' (default) | 'ascending' | 'descending' | 'never' | A visual indicator of the current direction in which the column is sorted. Does not modify the table data. See the sortable tables section for more sorting props. |
width | Number | 'min' | 'max' | 'auto' | Sets the width of a table header.
|
Prop | Type | Description |
---|---|---|
align | 'center' | 'left' | 'right' | Sets the alignment of a table cell. |
width | Number | 'min' | 'max' | 'auto' | Sets the width of a table cell.
|
colSpan | Number | Sets the number of columns a cell should span. |
Table
prop paginated
to true
.
Prop | Type | Description |
---|---|---|
maxVisiblePageButtons | Number | The maximum number of page buttons to display. |
page | Number | Denotes the current page number. |
pageCount | Number | The total number of pages available. |
showButtonLabels | Boolean | When set to false , hides the text labels for First/Prev/Next buttons. The button labels will still be accessible to screen readers. Default is true . |
showFirstLastButtons | Boolean | When set to true , displays the First/Last page buttons. Default is false . |
onPageChange | (pagenumber: number) => void | A function that is invoked when the page pagination button is clicked. It receives the new page number as an argument. |
sortDirection
and onSortChange
props in the table’s TableHeader
components. To enable table data to dynamically reorder based on user input, you’ll need to store your table data in variables rather than hard coding it into table cells. Below is an example of a sortable table with a static table footer.
Prop | Type | Description |
---|---|---|
sortDirection | 'none' (default) | 'ascending' | 'descending' | Visually indicates with an arrow which way the rows are sorted. |
onSortChange | (value: "none" | "ascending" | "descending") => void | A function that will be invoked when the header is clicked. It receives a sortDirection as an argument (cannot be none or a null value). |
disabled | Boolean | When set to true , users cannot change the sort ordering. It has no effect if sortDirection is set to never or undefined. Default is false . |