Skip to content

DataGridElement (Framework Adapters)

API for framework adapter developers (React, Angular, Vue, etc.). These methods are used by framework integration libraries to register adapters and manage column/renderer lifecycles.

See the public API documentation for consumer-facing members.

Register a framework adapter for handling framework-specific components. Adapters are checked in registration order when processing light DOM templates.

static registerAdapter(adapter: FrameworkAdapter): void
NameTypeDescription
adapterFrameworkAdapter
// In @toolbox-web/grid-angular
import { AngularGridAdapter } from '@toolbox-web/grid-angular';
// One-time setup in app
GridElement.registerAdapter(new AngularGridAdapter(injector, appRef));

Get all registered framework adapters. Used internally by light DOM parsing to find adapters that can handle templates.

static getAdapters(): unknown

Clear all registered adapters (primarily for testing).

static clearAdapters(): void

Re-parse light DOM column elements and refresh the grid. Call this after framework adapters have registered their templates. Uses the render scheduler to batch with other pending updates.

refreshColumns(): void

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