# UI: Checkbox

> A checkbox with its label.

Source: https://pithyx.org/docs/reference/sdk/ui/checkbox/
Markdown: https://pithyx.org/docs/reference/sdk/ui/checkbox.md

A checkbox with its label. Import the token file once (`@pithyx/ui/tokens.css`) and wrap the app in `UiProvider`; see [@pithyx/ui](https://pithyx.org/docs/sdk/ui/).

Generated from the TSDoc comments of @pithyx/ui 1.0.0-rc.9 at build time; the text below the headings is the comment in the source.

## Interfaces

### CheckboxProps

The props of [Checkbox](#checkbox): React Aria's checkbox field props plus the label.

#### Extends

- `Omit`\<`CheckboxFieldProps`, `"className"` \| `"children"`\>

#### Properties

##### children

```ts
children: ReactNode;
```

The label, also the accessible name.

## Functions

### Checkbox()

```ts
function Checkbox(props): Element;
```

A checkbox with its label.

#### Parameters

| Parameter | Type                              | Description                                                                                |
| --------- | --------------------------------- | ------------------------------------------------------------------------------------------ |
| `props`   | [`CheckboxProps`](#checkboxprops) | React Aria's checkbox field props (`isSelected`, `onChange`, `isDisabled`) plus the label. |

#### Returns

`Element`

The checkbox with its label.