---
title: "au-widget-checkbox/ICheckboxConfig | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-checkbox.ICheckboxConfig/"
---

# au-widget-checkbox/ICheckboxConfig

> Provides properties for a [checkbox](https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-checkbox.au-widget-checkbox.md#auwidgetcheckbox).

## Interfaces

### ICheckboxConfig

#### Properties

##### autoReset?

```ts
optional autoReset?: boolean;
```

If `true`, set false as value when step with checkbox displaying twice or more

##### enabled?

```ts
optional enabled?: boolean;
```

If `true`, displays the checkbox.

##### onChange?

```ts
optional onChange?: Function | Function[];
```

A function that is executed after changing a checkbox value.

##### prompt

```ts
prompt: string;
```

A text message associated with the checkbox.

##### value

```ts
value: boolean;
```

This value is `true` if the checkbox is selected.
