Skip to content

InjectGridReturn

Since v0.6.0

Return type for injectGrid function.

PropertyTypeDescription
elementSignal<DataGridElement<TRow> | unknown>Direct access to the typed grid element
isReadySignal<boolean>Whether the grid is ready
configSignal<GridConfig<TRow> | unknown>Current grid configuration
getConfig() => Promise<GridConfig<TRow> | unknown>Get the effective configuration
forceLayout() => Promise<void>Force a layout recalculation
toggleGroup(key: string) => Promise<void>Toggle a group row
registerStyles(id: string, css: string) => voidRegister custom styles
unregisterStyles(id: string) => voidUnregister custom styles
visibleColumnsSignal<ColumnConfig<TRow>[]>Get current visible columns
getPlugin(pluginClass: (args: unknown[]) => T) => T | undefinedLook up a plugin instance by its class constructor. Returns undefined if the plugin is not registered or the grid is not yet ready.
getPluginByName(name: K) => unknown | undefinedLook up a plugin instance by its registered name (e.g. 'tooltip', 'undoRedo'). Returns undefined if the plugin is not registered or the grid is not yet ready.
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