Switch | Neural UI v2

Usage

Use Switch for an immediate on/off preference, not a command. Its model is checked, not value. Keep a visible label describing what the enabled state means. readonly preserves focus and prevents changing the state; disabled prevents interaction.

Examples

Interact with the example and open Code for its complete implementation.

Email notifications

Notifications disabled

Try and configure

Change the controls and try the live preview. Expand the application value or event to inspect its real data; the generated template stays with the configurator.

Live preview

Email notifications

Current application value

Disabled

Read only

Required

Invalid state

Advanced options · 7

Generated template: the options above. The Code tab contains the imports and state.

<neu-switch
  [(checked)]="checked"
  [label]="'Email notifications'"
/>

State and data for this configuration

These values match the current preview. Complete handlers, Core imports and templates are in Source.

import { signal } from '@angular/core';

export const checked = signal(false);

Data, callback and structured configuration inputs

Signal Forms

Bind FormField once to the component; the field owns value and validation. The schema requires the enabled state. Leave the control to mark it touched, then reset the field to clear both value and interaction state.

Signal Forms guide

Email notifications

Valid: false

Form value

Value and events

Use [(checked)] or [checked] with (checkedChange), not both. The model synchronizes application state; other Outputs communicate their documented events. touch reports leaving/visiting the control, not a new value.

Accessibility and keyboard

Describe the enabled preference with a stable label, not a label that changes from On to Off. Space changes checked, and the native checkbox exposes its current state. readonly keeps focus without allowing a change; disabled removes interaction. Associate any explanatory text through ariaDescribedBy.

Key	Action
`Tab`	Enters and leaves the control.
`Space`	Toggles the checked state unless readonly or disabled.

API

Inputs, models and Outputs come from the pinned Core contract. Click named types to open their definitions. This component has no public template slots.

Inputs

Configure the component with [property]="value". Your application supplies these values; the component does not replace the state you pass in.

Name	Type	Default	Template binding	Description
`dirty`	`boolean`	`false`	`[dirty]`	Form state indicating that the user has changed the value.
`disabled`	`boolean`	`false`	`[disabled]`	Prevents user interaction.
`errors`	`readonly ValidationError.WithOptionalFieldTree[]`	`[]`	`[errors]`	Validation errors supplied by the form or the application.
`hidden`	`boolean`	`false`	`[hidden]`	Hides the control according to the form state.
`inputId`	`string`	`inject(NeuIdGenerator).getId('neu-switch-')`Derived default	`[inputId]`	Stable identifier of the native control; automatically generated when omitted.
`invalid`	`boolean`	`false`	`[invalid]`	Displays the invalid state; it does not add a validation rule.
`label`	`string`	`''`	`[label]`	Visible label and accessible name of the control.
`name`	`string`	`''`	`[name]`	Name associated with the native form control.
`pending`	`boolean`	`false`	`[pending]`	Form state indicating that asynchronous validation is pending.
`readonly`	`boolean`	`false`	`[readonly]`	Keeps the control focusable and readable without accepting edits.
`required`	`boolean`	`false`	`[required]`	Marks the field as required; use a form validator to enforce it.
`touched`	`boolean`	`false`	`[touched]`	Form state indicating that the control has been visited.

Models

A model supports [(property)]="signal" or the [property] and (propertyChange) pair. Choose one form, not both.

Name	Type	Default	Template binding	Description
`checked`	`boolean`	`false`	`[(checked)]`	Boolean model. Bind [(checked)] or [checked] with (checkedChange), not value.

Outputs

Listen to an event with (event)="handler($event)". The table explains the data your handler receives and how to use it.

Name	Payload	Template binding	Description
`touch`	`void`	`(touch)="onTouch($event)"`	Notifies the form that the control has been touched; not a value change.

Templates

ng-content projects content into the component. TemplateRef inputs receive a template; ng-template directives identify templates with a typed context. A directive shared by an entrypoint is not necessarily a slot of this component.

This component does not expose content projection or public customization templates.

Styles and tokens

Load Core styles once. Use the public tokens below for local customization or a preset for application-wide changes. Keep labels, focus, selected options and disabled states readable in both light and dark themes.

Specific tokens

This component uses shared theme tokens rather than dedicated component hooks.

Shared tokens used

Override these on a local wrapper to affect this example. An override on :root affects other components that use the same token.

Token	Purpose here	Other impact	Default / fallback
`--neu-primary`	Brand color for active controls and emphasis	Shared by other Core consumers; scope the override.	`#007aff`
`--neu-surface-3`	Hover and raised control surfaces	Shared by other Core consumers; scope the override.	`#e2e8f0`
`--neu-text`	Main text and inherited icon color	Shared by other Core consumers; scope the override.	`#0f172a`
`--neu-font-sans`	Text typography	Shared by other Core consumers; scope the override.	`'Inter', system-ui, -apple-system, BlinkMacSystemFont, sans-serif`
`--neu-radius-full`	Corner radius	Shared by other Core consumers; scope the override.	`9999px`
`--neu-shadow-xs`	Surface or overlay elevation	Shared by other Core consumers; scope the override.	`0 1px 2px rgba(15, 23, 42, 0.04)`
`--neu-space-3`	Spacing between content and controls	Shared by other Core consumers; scope the override.	`0.75rem`
`--neu-text-sm`	Text size	Shared by other Core consumers; scope the override.	`0.875rem`

Related components

Use the related controls for a different kind of value or interaction.