Skip to content

HeaderLabelRenderer

Header label renderer function type. Customize the label while framework handles sort icons, filter buttons, resize handles.

Use this for simple label customizations without taking over the entire header. The grid automatically appends sort icons, filter buttons, and resize handles.

type HeaderLabelRenderer = (ctx: HeaderLabelContext<TRow>) => Node | string | void | null
// Add required indicator
const requiredHeader: HeaderLabelRenderer = (ctx) => {
return `${ctx.value} <span style="color: red;">*</span>`;
};
// Add unit suffix
const priceHeader: HeaderLabelRenderer = (ctx) => {
const span = document.createElement('span');
span.innerHTML = `${ctx.value} <small>(USD)</small>`;
return span;
};
// Column config usage
columns: [
{ field: 'name', headerLabelRenderer: requiredHeader },
{ field: 'price', headerLabelRenderer: priceHeader },
]
AI assistants: For complete API documentation, implementation guides, and code examples for this library, see https://raw.githubusercontent.com/OysteinAmundsen/toolbox/main/llms-full.txt