{/* Do not edit this file. It is automatically generated by API Documenter. */}


## ButtonCellRenderer

A renderer that displays a button

**Signature:**

```typescript
export interface ButtonCellRenderer extends CellRenderer
```
**Extends:** [CellRenderer](/refs/Interface/CellRenderer)

## Remarks

`TOP_EDGE`{/* */} and `BOTTOM_EDGE` cannot be used in auto height.

\[Superclass\]

[CellRenderer](/refs/Interface/CellRenderer)

## Example


```js
//string type
column.renderer = 'button';

//object type
column.renderer = {
      "type": "button",
      "hideWhenEmpty": false
}
```

## Properties

| Property |Type | Description |
| --- | --- | --- |
| [buttonStyle](/refs/Interface/ButtonCellRenderer#buttonstyle) | string | Style class name of the displayed button |
| [enterKey](/refs/Interface/ButtonCellRenderer#enterkey) | boolean | Whether button.click is executed when enter is entered |
| [hideWhenEmpty](/refs/Interface/ButtonCellRenderer#hidewhenempty) | boolean | Whether to display the button when the value is empty |
| [spaceKey](/refs/Interface/ButtonCellRenderer#spacekey) | boolean | Whether to execute button.click when spaceKey is entered |
| [type](/refs/Interface/ButtonCellRenderer#type) | 'button' | Type: Button |

## Properties Desc

### buttonStyle

Style class name of the displayed button

`Type` - string

<hr/>

### enterKey

Whether button.click is executed when enter is entered

`Type` - boolean

**Remarks:**

If true, button.click is executed when the enterKey is entered. If there is [GridBase.onCellItemClicked](/refs/Class/GridBase#oncellitemclicked){/* */}, the default action is not executed if the result is false after the event is called.

<hr/>

### hideWhenEmpty

Whether to show the button when the value is empty

`Type` - boolean

**Remarks:**

When `true`, `undefined`{/* */}, `null`{/* */}, `''`{/* */}, `NaN`, the button is not displayed.

<hr/>

### spaceKey

Whether button.click is executed when spaceKey is entered

`Type` - boolean

**Remarks:**

If true, button.click is executed when the space bar is entered. If there is [GridBase.onCellItemClicked](/refs/Class/GridBase#oncellitemclicked){/* */}, the default action is not executed if the result is false after the event is called.

<hr/>

### type

Type: Button

`Type` - 'button'

<hr/>