UseGridReturn

Since v0.1.0

Return type for useGrid composable.

Properties

Property	Type	Description
gridElement	Ref<DataGridElement<TRow> | unknown>	The grid element reference
isReady	Ref<boolean>	Whether the grid is ready
config	Ref<GridConfig<TRow> | unknown>	Current grid configuration (reactive)
forceLayout	() => Promise<void>	Force a layout recalculation
getConfig	() => Promise<Readonly<GridConfig<any>>> | undefined	Get current grid configuration
ready	() => Promise<void>	Wait for grid to be ready
getPlugin	(pluginClass: (args: unknown[]) => T) => T | undefined	Get a plugin by its class
getPluginByName	(name: K) => unknown | undefined	Get a plugin by its registered name (preferred). Uses the type-safe PluginNameMap for auto-completion and return type narrowing.
toggleGroup	(key: string) => Promise<void>	Toggle a group row
registerStyles	(id: string, css: string) => void	Register custom styles via document.adoptedStyleSheets
unregisterStyles	(id: string) => void	Unregister previously registered custom styles
getVisibleColumns	() => ColumnConfig<TRow>[]	Get currently visible columns (excluding hidden columns)