Type Definitions


DisplayHandlerResult

Properties
Name Type Description
rows Array.<TRow> The actual rows to display
totalRowCount number The total number of rows in the table. It counts also items on other pages. The pages in the pagination component are calculated using this value.
Details
Object

SettingsProps

Description
An object representing customizable classes & HTML used for a certain table type.
Properties
Name Type Description
table.class string The classes to apply on the `table` tag itself.
table.row.class string | function The classes to apply on each row (`tr` tag).
table.sorting.sortNone string The HTML representing the sort icon when the column isn't sorted.
table.sorting.sortAsc string The HTML representing the sort icon when sorting the column ascending.
table.sorting.sortDesc string The HTML representing the sort icon when sorting the column descending.
pager.classes.pager string The class to apply on the pager's `ul` tag.
pager.classes.li string The class to apply on the page's `li` tag.
pager.classes.selected string The class to apply on the current page's `li` tag.
pager.classes.disabled string The class to apply on a disabled page's `li` tag.
pager.icons.previous string The HTML representing the *Previous page* icon.
pager.icons.next string The HTML representing the *Next page* icon.
Details
Object

DataFnParams

Description
Parameters passed to the `data` function, to handle by custom logic.
Properties
Name Type Description
filter: string | Array.<stringp> The string(s) used to filter entries.
sortBy: string | null The name of the field we are sorting on.
sortDir: 'asc' | 'desc' | null The direction of the sort.
perPage: number The number of items per page.
page: number The current page index.
Details
Object