InjectGridReturn
Since v0.6.0
Return type for injectGrid function.
Properties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
element | Signal<DataGridElement<TRow> | unknown> | Direct access to the typed grid element |
isReady | Signal<boolean> | Whether the grid is ready |
config | Signal<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) => void | Register custom styles |
unregisterStyles | (id: string) => void | Unregister custom styles |
visibleColumns | Signal<ColumnConfig<TRow>[]> | Get current visible columns |
getPlugin | (pluginClass: (args: unknown[]) => T) => T | undefined | Look 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 | undefined | Look 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