API REFERENCE

toolPanelToggled

Emitted when column/filter tool panel visibility changes.

What does this API do?

Emitted when column/filter tool panel visibility changes.

API for Pro features: Columns / Filters tool panels

Exact input and result types

typescript
toolPanelToggled: { id: SideBarPanelId; open: boolean }

Usage flow

Subscribe with grid.addEventListener('toolPanelToggled', handler). The result is in event.detail, and event names are case-sensitive. Remove subscriptions when disposing of the view.

javascript
const controller = new AbortController();
grid.addEventListener('toolPanelToggled', event => {
  console.log(event.detail);
}, { signal: controller.signal });
// On view disposal: controller.abort();

Read related types

Feature explanations and examples