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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

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

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Custom footer using IDataTableSlotProps

vue