---
title: boolean
subtitle: Switch
type: Widgets
---

Switching Selector.

## API

### schema

| Property     | Description                  | Type      | Default |
| ------------ | ---------------------------- | --------- | ------- |
| `[readOnly]` | Whether to disable the state | `boolean` | -       |

### ui

| Property              | Description                                     | Type            | Default   |
| --------------------- | ----------------------------------------------- | --------------- | --------- |
| `[size]`              | Size of the `nz-switch`                         | `default,small` | `default` |
| `[checkedChildren]`   | Content to be shown when the state is checked   | `string`        | -         |
| `[unCheckedChildren]` | Content to be shown when the state is unchecked | `string`        | -         |