API REFERENCE

unregisterGridComponent

Unregisters a custom component and returns success.

What does this API do?

Unregisters a custom component and returns success.

Exact input and result types

typescript
unregisterGridComponent(scope: GridComponentRegistrationScope, kind: GridComponentKind, name: string): Promise<boolean>
ArgumentsRequiredType
scopeRequiredGridComponentRegistrationScope
kindRequiredGridComponentKind
nameRequiredstring

The return type is Promise<boolean>.

Usage flow

After registering and initializing the Grid element, call grid.unregisterGridComponent(…). 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