## Checkbox Props

| Name         | Type                                                                         | Default     | Required | Description                            |
| ------------ | ---------------------------------------------------------------------------- | ----------- | -------- | -------------------------------------- |
| data         | `CheckboxItem[]`                                                             | `[]`        | Y        | Option data.                           |
| layout       | `'h'\|'v'\|'inline'`                                                         | `'v'`       | N        | Layout mode.                           |
| checkeds     | `string[]`                                                                   | `[]`        | N        | Array of selected option identifiers.  |
| textPosition | `'l'\|'r'\|'t'\|'b'`                                                         | `'r'`       | N        | Position of option text area.          |
| icon         | `'default'\|null`\|[`Icon`](https://stdf.design/components?nav=icon&tab=1) | `'default'` | N        | Content of unchecked option icon area. |
| iconChecked  | `'default'\|null`\|[`Icon`](https://stdf.design/components?nav=icon&tab=1) | `'default'` | N        | Content of checked option icon area.   |

## Checkbox Events

| Name     | Type                           | Parameters                                | Description                    |
| -------- | ------------------------------ | ----------------------------------------- | ------------------------------ |
| onchange | `(checkeds: string[]) => void` | checkeds - Array of selected identifiers. | Triggered when option clicked. |

## Checkbox Snippets

| Name          | Type                                                                                          | Parameters          | Description                        |
| ------------- | --------------------------------------------------------------------------------------------- | ------------------- | ---------------------------------- |
| checkboxChild | [`Snippet<[{ item: CheckboxItem }]>`](https://svelte.dev/docs/svelte/snippet#Typing-snippets) | item - Option data. | Used when customizing option area. |

## CheckboxItem Props

| Name         | Type                                                                         | Default     | Required | Description                            |
| ------------ | ---------------------------------------------------------------------------- | ----------- | -------- | -------------------------------------- |
| name         | `string`                                                                     | `''`        | Y        | Identifier.                            |
| label        | `string`                                                                     | `''`        | N        | Option text, mainly for display.       |
| layout       | `'h'\|'v'\|'inline'`                                                         | `'v'`       | N        | Layout mode.                           |
| textPosition | `'l'\|'r'\|'t'\|'b'`                                                         | `'r'`       | N        | Position of option text area.          |
| icon         | `'default'\|null`\|[`Icon`](https://stdf.design/components?nav=icon&tab=1) | `'default'` | N        | Content of unchecked option icon area. |
| iconChecked  | `'default'\|null`\|[`Icon`](https://stdf.design/components?nav=icon&tab=1) | `'default'` | N        | Content of checked option icon area.   |
| checked      | `boolean`                                                                    | `false`     | N        | Whether checked.                       |

## CheckboxItem Events

| Name    | Type                     | Parameters         | Description                    |
| ------- | ------------------------ | ------------------ | ------------------------------ |
| onclick | `(name: string) => void` | name - Identifier. | Triggered when option clicked. |

## CheckboxItem Snippets

| Name     | Type                                                                | Parameters | Description                  |
| -------- | ------------------------------------------------------------------- | ---------- | ---------------------------- |
| children | [`Snippet`](https://svelte.dev/docs/svelte/snippet#Typing-snippets) | -          | Content of option text area. |