# Toggle

## Overview

Toggle is a switcher for Boolean value. The component supports required field and custom validation.

<figure><img src="https://837703843-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FUX6zPRMFFK0yrTghj7cY%2Fuploads%2F4uu8a4uYopWdchPi0Hi5%2FCleanShot%202025-09-09%20at%2017.35.11%402x-min.png?alt=media&#x26;token=09e020f9-f973-428a-8ca6-afa4490c112c" alt=""><figcaption></figcaption></figure>

### Properties

<table><thead><tr><th width="109.73046875">Name</th><th width="138.73046875">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><tr><td><code>disabled</code></td><td><code>boolean</code></td><td>Indicates whether the component is disabled</td></tr></tbody></table>

### Methods

<table><thead><tr><th width="157.125">Name</th><th width="173.41796875">Parameters</th><th width="99.28515625">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 inital value</td></tr><tr><td><code>validate</code></td><td>–</td><td><code>void</code></td><td>Trigger component validation</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><tr><td><code>setRequired</code></td><td><code>required: boolean</code></td><td><code>void</code></td><td>Set component required state</td></tr></tbody></table>

### Triggers

<table><thead><tr><th width="163.0390625">Name</th><th>Description</th></tr></thead><tbody><tr><td><strong>On Init</strong></td><td>Triggered when the component is initialized</td></tr><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></tbody></table>