headerTooltip

A tooltip on the header, to say more than the title can.

Type	string
Default	not set
Live update (update())	Yes — give the columns again (update({ columns }))
Declared in	packages/core/src/columns/defs.ts

What it does

It shows when the pointer rests on the header (after the grid’s tooltips delay) and as soon as the keyboard focus reaches it. Give it already translated. To draw it yourself, name a part in ui.tooltip.

Example

import { createGrid } from '@dzgrid/dom';
import { EN } from '@dzgrid/dom/locales/en';

type Bee = { id: string; hive: string; honey: number };

createGrid<Bee>(document.getElementById('hives')!, {
  rows: [{ id: 'h1', hive: 'Clover hill', honey: 12.5 }],
  columns: [
    { id: 'hive', header: 'Hive' },
    { id: 'honey', header: 'Honey', type: 'number', headerTooltip: 'Kilograms this season' },
  ],
  getRowId: (r) => r.id,
  messages: EN,
});

Live demo

Rest the pointer on the Honey title.

See also

• tooltip, header.
• tooltips.