HeaderSlotProps

Since v1.9.0

Slot context for #header slot in TbwGridColumn. Gives the consumer full control over the header cell label — sort icons and filter buttons are NOT added automatically; use the renderSortIcon and renderFilterButton helpers to opt in. Resize handles are appended automatically by the grid for resizable columns.

Example

<TbwGridColumn field="status" sortable>
  <template #header="{ value, sortState, renderSortIcon }">
    <div class="custom-header">
      <span>{{ value }}</span>
      <component :is="renderSortIcon()" v-if="sortState" />
    </div>
  </template>
</TbwGridColumn>

Properties

Property	Type	Description
column	ColumnConfig<TRow>	Column configuration reference.
value	string	The header text (from column.header or column.field).
sortState	desc | asc | unknown	Current sort state for this column.
filterActive	boolean	Whether the column has an active filter.
cellEl	HTMLElement	The header cell DOM element being rendered into.
renderSortIcon	() => HTMLElement | unknown	Render the standard sort indicator icon. Returns null if not sortable.
renderFilterButton	() => HTMLElement | unknown	Render the standard filter button. Returns null if filtering is not active for this column.