API REFERENCE
registerGridComponent
Registers a custom Grid component under the public component contract.
What does this API do?
Registers a custom Grid component under the public component contract.
Exact input and result types
registerGridComponent<TKind extends GridComponentKind>(scope: GridComponentRegistrationScope, kind: TKind, name: string, definition: GridComponentDefinitionFor<
TKind,
GridData,
unknown,
unknown,
unknown
>): Promise<void>| Arguments | Required | Type |
|---|---|---|
| scope | Required | GridComponentRegistrationScope |
| kind | Required | TKind |
| name | Required | string |
| definition | Required | GridComponentDefinitionFor< TKind, GridData, unknown, unknown, unknown > |
The return type is Promise<void>.
Usage flow
After registering and initializing the Grid element, call grid.registerGridComponent(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
Feature explanations and examples
- Customize cell appearance
Cell renderers change how data is displayed. Use them for status badges, links, and action buttons while retaining the original values for sorting and filtering.