# unregisterGridComponent

Unregisters a custom component and returns success.

Canonical: https://grid.syidax.com/docs/methods/unregisterGridComponent/

<a id="meaning"></a>

## What does this API do?

Unregisters a custom component and returns success.

<a id="contract"></a>

## Exact input and result types

```typescript
unregisterGridComponent(scope: GridComponentRegistrationScope, kind: GridComponentKind, name: string): Promise<boolean>
```

| Arguments | Required | Type |
| --- | --- | --- |
| scope | Required | GridComponentRegistrationScope |
| kind | Required | GridComponentKind |
| name | Required | string |

The return type is `Promise<boolean>`.

<a id="usage"></a>

## 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.

<a id="types"></a>

## Read related types

- [GridComponentRegistrationScope](https://grid.syidax.com/docs/types/GridComponentRegistrationScope.md)
- [GridComponentKind](https://grid.syidax.com/docs/types/GridComponentKind.md)

<a id="recipes"></a>

## Feature explanations and examples

- [Customize cell appearance](https://grid.syidax.com/docs/features/custom-cells.md) — 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.