HeaderContentDefinition

Since v0.1.1

Header content definition for plugins contributing to shell header center section.

Register via the shell plugin’s registerHeaderContent() to add content between the title and toolbar buttons.

Example

grid.getPluginByName('shell')?.registerHeaderContent({
  id: 'row-count',
  order: 10,
  render: (container) => {
    const span = document.createElement('span');
    span.className = 'row-count';
    span.textContent = `${grid.rows.length} rows`;
    container.appendChild(span);

    // Update on data changes
    const unsub = grid.on('data-change', () => {
      span.textContent = `${grid.rows.length} rows`;
    });

    return () => {
      unsub();
    };
  },
});

Properties

Property	Type	Description
id	string	Unique content ID
render	(container: HTMLElement) => void | () => void	Content factory - called once when shell header renders
onDestroy?	() => void	Called when content is removed (for cleanup)
order?	number	Order priority (lower = first, default: 100)

See Also

• ShellConfig for shell configuration