IInternalDataTableHeader

interface
Data Display

Normalised header descriptor used internally by <OrigamDataTable> after the raw IDataTableHeader array has been processed. Extends IDataTableHeader (omitting key, value, children) with resolved types and layout hints.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

key
required
string | null
Resolved column key used for sorting and filtering. null for columns without a key.
value
required
TSelectItemKey | null
Resolved value accessor for reading cell data from a row object. null when no value is defined.
sortable
required
boolean
Whether the column is sortable. Derived from the raw header definition during normalisation.
fixedOffset
number
Pixel offset applied to sticky fixed columns.
lastFixed
boolean
Marks the last fixed column so a drop-shadow separator can be rendered.
nowrap
boolean
Prevents text wrapping inside the header cell.
padding
string | number
Override cell padding for this column.
colspan
number
HTML colspan for merged header cells.
rowspan
number
HTML rowspan for merged header cells.
children
Array<IInternalDataTableHeader>
Nested sub-headers for grouped column structures.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Reading a resolved header in a custom header slot

vue