IDataTableSlotProps
interface
Component Props
Full slot scope injected into top-level slots (#default, #body, #footer…) of <OrigamDataTable> — aggregates pagination, sort, selection, expansion, grouping state and all toggle helpers.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- pagerequirednumber
- Current page number (1-based).
- itemsPerPagerequirednumber
- Number of rows shown per page.
- sortByrequiredreadonly IDataTableSortItem[] | undefined
- Active sort descriptors (key + direction).
- pageCountrequirednumber
- Total number of pages.
- toggleSortrequiredIDataTableProvideSort['toggleSort']
- Cycles the sort state of the given column.
- setItemsPerPagerequiredIDataTableProvidePagination['setItemsPerPage']
- Changes the rows-per-page setting.
- someSelectedrequiredboolean
- True when at least one row is selected.
- allSelectedrequiredboolean
- True when all selectable rows are selected.
- isSelectedrequiredIDataTableProvideSelection['isSelected']
- Checks whether all passed items are selected.
- selectrequiredIDataTableProvideSelection['select']
- Sets selection state for an array of items.
- selectAllrequiredIDataTableProvideSelection['selectAll']
- Selects or deselects all rows on the current page.
- toggleSelectrequiredIDataTableProvideSelection['toggleSelect']
- Toggles selection for a single item.
- isExpandedrequiredIDataTableProvideExpanded['isExpanded']
- Checks whether an item row is expanded.
- toggleExpandrequiredIDataTableProvideExpanded['toggleExpand']
- Toggles the expansion state of an item row.
- isGroupOpenrequiredIDataTableProvideGroup['isGroupOpen']
- Checks whether a group node is open.
- toggleGrouprequiredIDataTableProvideGroup['toggleGroup']
- Toggles the open/closed state of a group node.
- itemsrequiredT[]
- Raw items on the current page.
- internalItemsrequiredArray<IDataTableGroupableItem<T>>
- Enriched internal items on the current page.
- groupedItemsrequiredReadonlyArray<IDataTableItem<T> | IDataTableGroup<IDataTableItem<T>>>
- Items and group nodes as rendered in the tbody.
- columnsrequiredArray<IInternalDataTableHeader>
- Resolved column descriptors in display order.
- headersrequiredArray<Array<IInternalDataTableHeader>>
- Multi-row header matrix (for column-group headers).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom footer using IDataTableSlotProps