# Checkbox

## Overview

A checkbox serves as a toggle for a boolean value.

<figure><img src="https://837703843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUX6zPRMFFK0yrTghj7cY%2Fuploads%2FWbnnA8zHH67opuhUKEfR%2FCleanShot%202025-07-23%20at%2010.49.02%402x-min.png?alt=media&#x26;token=a3c7e52e-914e-4756-8e5d-d359e904e4b3" alt=""><figcaption></figcaption></figure>

### Properties

<table><thead><tr><th width="139.45703125">Name</th><th width="128.8046875">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>string</code></td><td>Component name</td></tr><tr><td><code>value</code></td><td><code>boolean</code></td><td>Current component value</td></tr><tr><td><code>valid</code></td><td><code>boolean</code></td><td>Indicates if the component is valid</td></tr><tr><td><code>validating</code></td><td><code>boolean</code></td><td>Indicates if the component is validating</td></tr></tbody></table>

### Methods

<table><thead><tr><th width="157.203125">Name</th><th width="175.65234375">Parameters</th><th width="103.84375">Returns</th><th>Description</th></tr></thead><tbody><tr><td><code>setValue</code></td><td><code>value: boolean</code></td><td><code>void</code></td><td>Set component value</td></tr><tr><td><code>setDisabled</code></td><td><code>disabled: boolean</code></td><td><code>void</code></td><td>Disable or enable the component</td></tr><tr><td><code>reset</code></td><td>–</td><td><code>void</code></td><td>Reset component to the initial value</td></tr><tr><td><code>resetValidation</code></td><td>–</td><td><code>void</code></td><td>Clear validation errors</td></tr><tr><td><code>setErrors</code></td><td><p><code>errors: string |</code> </p><p><code>string[] | null</code></p></td><td><code>void</code></td><td>Mark the component as invalid and display errors</td></tr></tbody></table>

### Triggers

<table><thead><tr><th width="130.06640625">Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>On Change</strong></td><td>Triggered when the component's state changes</td></tr><tr><td><strong>On Focus</strong></td><td>Triggered when the component is in focus</td></tr><tr><td><strong>On Blur</strong></td><td>Triggered when the component loses focus</td></tr><tr><td><strong>On Init</strong></td><td>Triggered when the component is initialized</td></tr></tbody></table>