Skip to content

Commit

Permalink
feat: extended async table docs #132
Browse files Browse the repository at this point in the history
  • Loading branch information
flauc committed Dec 30, 2023
1 parent 0adbc47 commit 1cc3745
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/docs/async-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
| headers || [`TableHeader[]`](#tableheader) | column names |
| sort || [`TableSort`](#tablesort) | current sorting state of the table |
| service || [`TableService`](#tableservice) | table data service |
| showArrangingColumns | | `boolean` | should the button for arranging columns be shown |
| showExport | | `boolean` | should the button for export be shown |

<br></br>

Expand All @@ -30,6 +32,7 @@ Defines the structure of a table header.
| sortMethod | | `function` | used for custom sorting with ascending ( *'asc'* ) or descending ( *'desc'* ) direction |
| pipes | | [`TablePipe`](#tablepipe) | used for transforming table data |
| fallback | | `any` | optional value used as a replacement if the specific value isn't available |
| disabled | | `boolean` | disabled headers aren't shown by default but are available when arranging columns |

<br></br>

Expand Down Expand Up @@ -63,6 +66,8 @@ Defines the sorting configuration of data.
| :----: | :----: | :----: |
| get | `function` | retrieves data with optional sorting and returns a promise containing data rows |
| loadMore | `function`| loads additional data with optional sorting and returns a promise containing rows of data |
| export | `function` | retrieves all data that should be included when export is triggered by the table |
| arrangeColumns | `function` | This method is intended for persisting column organization |

<br></br>

Expand Down

0 comments on commit 1cc3745

Please sign in to comment.