IDataTableHeaderCellColumnSlot
interface
Component Slots
Slot props injected into per-column header cell slots of <OrigamDataTable> — provides the column definition plus sort helpers (isSorted, toggleSort, getSortIcon) and selection helpers (selectAll, someSelected, allSelected).
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.
- columnrequiredIInternalDataTableHeader
- The resolved internal column definition for this header cell.
- selectAllrequired(value: boolean) => void
- Selects or deselects all rows.
- isSortedrequired(column: IInternalDataTableHeader) => boolean
- Returns true when the column is part of the active sort.
- toggleSortrequired(column: IInternalDataTableHeader) => void
- Cycles the sort direction for the column (none → asc → desc).
- sortByrequiredArray<IDataTableSortItem>
- Reactive list of active sort columns.
- someSelectedrequiredboolean
- True when at least one row is selected (used for the indeterminate checkbox state).
- allSelectedrequiredboolean
- True when every visible row is selected.
- getSortIconrequired(column: IInternalDataTableHeader) => TIcon | undefined
- Returns the correct sort indicator icon for the column.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom header cell with sort indicator