Header

Header objects are instances representing column headers in the table. They are generated by the table and contain references to their associated column, header group, and rendering context. See the Headers guide for usage examples.

API

Properties and methods for header objects. Includes column references, header group information, hierarchy details (depth, index), placeholder state, and methods to retrieve rendering context and nested leaf headers.

Prop	Type
colSpan The colspan for the header.	number
column The header's associated column object.	Column< TData, TValue, TColumnMeta >
depth The depth of the header, zero-indexed based.	number
getContext Returns the rendering context (or props) for column-based components like headers, footers and filters.	() => { column: Column< TData, TValue, TColumnMeta > header: Header< TData, TValue, TColumnMeta > table: TableInstance<TData> }
getLeafHeaders Returns the leaf headers hierarchically nested under this header.	() => Header< TData, any, TColumnMeta >[]
getResizeHandler Returns an event handler function that can be used to resize the header. It can be used as an: - `onMouseDown` handler - `onTouchStart` handler The dragging and release events are automatically handled for you.	() => ( event: unknown, ) => void
getSize Returns the current size of the header.	() => number
getStart Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.	( position?: \| false \| 'left' \| 'right', ) => number
headerGroup The header's associated header group object.	HeaderGroup<TData>
id The unique identifier for the header.	string
index The index for the header within the header group.	number
isPlaceholder A boolean denoting if the header is a placeholder header.	boolean
placeholderId If the header is a placeholder header, this will be a unique header ID that does not conflict with any other headers across the table.	string
rowSpan The row-span for the header.	number
subHeaders The header's hierarchical sub/child headers. Will be empty if the header's associated column is a leaf-column.	Header[]

colSpan

Type

number

Description

The colspan for the header.

column

Type

Column<
  TData,
  TValue,
  TColumnMeta
>

Description

The header's associated column object.

depth

Type

number

Description

The depth of the header, zero-indexed based.

getContext

Type

() => {
  column: Column<
    TData,
    TValue,
    TColumnMeta
  >
  header: Header<
    TData,
    TValue,
    TColumnMeta
  >
  table: TableInstance<TData>
}

Description

Returns the rendering context (or props) for column-based components like headers, footers and filters.

getLeafHeaders

Type

() => Header<
  TData,
  any,
  TColumnMeta
>[]

Description

Returns the leaf headers hierarchically nested under this header.

getResizeHandler

Type

() => (
  event: unknown,
) => void

Description

Returns an event handler function that can be used to resize the header. It can be used as an:
- onMouseDown handler
- onTouchStart handler

The dragging and release events are automatically handled for you.

getSize

Type

() => number

Description

Returns the current size of the header.

getStart

Type

(
  position?:
    | false
    | 'left'
    | 'right',
) => number

Description

Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.

headerGroup

Type