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.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

page
required
number
Current page number (1-based).
itemsPerPage
required
number
Number of rows shown per page.
sortBy
required
readonly IDataTableSortItem[] | undefined
Active sort descriptors (key + direction).
pageCount
required
number
Total number of pages.
toggleSort
required
IDataTableProvideSort['toggleSort']
Cycles the sort state of the given column.
setItemsPerPage
required
IDataTableProvidePagination['setItemsPerPage']
Changes the rows-per-page setting.
someSelected
required
boolean
True when at least one row is selected.
allSelected
required
boolean
True when all selectable rows are selected.
isSelected
required
IDataTableProvideSelection['isSelected']
Checks whether all passed items are selected.
select
required
IDataTableProvideSelection['select']
Sets selection state for an array of items.
selectAll
required
IDataTableProvideSelection['selectAll']
Selects or deselects all rows on the current page.
toggleSelect
required
IDataTableProvideSelection['toggleSelect']
Toggles selection for a single item.
isExpanded
required
IDataTableProvideExpanded['isExpanded']
Checks whether an item row is expanded.
toggleExpand
required
IDataTableProvideExpanded['toggleExpand']
Toggles the expansion state of an item row.
isGroupOpen
required
IDataTableProvideGroup['isGroupOpen']
Checks whether a group node is open.
toggleGroup
required
IDataTableProvideGroup['toggleGroup']
Toggles the open/closed state of a group node.
items
required
T[]
Raw items on the current page.
internalItems
required
Array<IDataTableGroupableItem<T>>
Enriched internal items on the current page.
groupedItems
required
ReadonlyArray<IDataTableItem<T> | IDataTableGroup<IDataTableItem<T>>>
Items and group nodes as rendered in the tbody.
columns
required
Array<IInternalDataTableHeader>
Resolved column descriptors in display order.
headers
required
Array<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

vue