Switch

Switch is used to select a boolean value.

Off

basic-demo

Usage#

import { Switch } from '@primereact/ui/switch';

<Switch>
    <Switch.Control>
        <Switch.Thumb />
    </Switch.Control>
</Switch>

Examples#

Controlled#

A controlled Switch requires managing the checked state with a state variable and handling the change event manually. This allows for complete control over the Switch's behavior.

Airplane Mode

controlled-demo

'use client';
import { SwitchChangeEvent } from '@primereact/types/shared/switch';
import { Switch } from '@primereact/ui/switch';
import React from 'react';

export default function ControlledDemo() {
    const [checked, setChecked] = React.useState(true);

    return (
        <div className="flex justify-center items-center gap-2">
            <Switch.Root inputId="mode" checked={checked} onCheckedChange={(event: SwitchChangeEvent) => setChecked(event.checked)}>
                <Switch.Control>
                    <Switch.Thumb />
                </Switch.Control>
            </Switch.Root>
            <label htmlFor="mode">Airplane Mode</label>
        </div>
    );
}

Uncontrolled#

For an uncontrolled Switch component, defaultChecked is used to set the initial state, and the component manages its own state internally.

uncontrolled-demo

import { Switch } from '@primereact/ui/switch';

export default function UncontrolledDemo() {
    return (
        <div className="flex justify-center">
            <Switch.Root defaultChecked>
                <Switch.Control>
                    <Switch.Thumb />
                </Switch.Control>
            </Switch.Root>
        </div>
    );
}

Template#

Switch.Thumb also allows displaying custom content inside itself.

template-demo

'use client';
import { Check } from '@primeicons/react/check';
import { Times } from '@primeicons/react/times';
import type { SwitchThumbInstance } from '@primereact/types/shared/switch';
import { Switch } from '@primereact/ui/switch';

export default function TemplateDemo() {
    return (
        <div className="flex justify-center">
            <Switch.Root>
                <Switch.Control>
                    <Switch.Thumb>
                        {(instance: SwitchThumbInstance) => {
                            const { switch: switchContext } = instance;

                            return <>{switchContext?.state.checked ? <Check /> : <Times />}</>;
                        }}
                    </Switch.Thumb>
                </Switch.Control>
            </Switch.Root>
        </div>
    );
}

Customization#

Switch component supports customization through CSS classes. The appearance, including colors and other visual properties, can be modified by applying custom classes to the component.

Try Beta Features

Experience upcoming features before they're officially released.

customization-demo

'use client';
import { SwitchChangeEvent } from '@primereact/types/shared/switch';
import { Switch } from '@primereact/ui/switch';
import * as React from 'react';

export default function CustomizationDemo() {
    const [checked, setChecked] = React.useState(true);

    return (
        <div className="flex justify-center items-center gap-2">
            <label
                htmlFor="custom"
                className="flex items-center gap-2 bg-surface-50 hover:bg-surface-100 dark:bg-slate-700 hover:dark:bg-slate-800 p-4 rounded-md"
            >
                <div className="flex flex-col gap-1">
                    <p className="m-0 text-medium">Try Beta Features</p>
                    <p className="m-0 text-sm text-slate-400">Experience upcoming features before they&apos;re officially released.</p>
                </div>

                <Switch.Root inputId="custom" checked={checked} onCheckedChange={(event: SwitchChangeEvent) => setChecked(event.checked)}>
                    <Switch.Control className={`${checked ? 'bg-blue-300' : 'bg-surface-300 dark:bg-surface-500'} rounded-md`}>
                        <Switch.Thumb className="bg-blue-900" />
                    </Switch.Control>
                </Switch.Root>
            </label>
        </div>
    );
}

Invalid#

Invalid state is displayed using the invalid prop to indicate a failed validation. This style is useful when integrating with form validation libraries.

invalid-demo

'use client';
import { SwitchChangeEvent } from '@primereact/types/shared/switch';
import { Switch } from '@primereact/ui/switch';
import * as React from 'react';

export default function InvalidDemo() {
    const [checked, setChecked] = React.useState(false);

    return (
        <div className="flex justify-center">
            <Switch.Root checked={checked} onCheckedChange={(event: SwitchChangeEvent) => setChecked(event.checked)} invalid={!checked}>
                <Switch.Control>
                    <Switch.Thumb />
                </Switch.Control>
            </Switch.Root>
        </div>
    );
}

Disabled#

When disabled is present, the element cannot be edited and focused.

disabled-demo

import { Switch } from '@primereact/ui/switch';

export default function DisabledDemo() {
    return (
        <div className="flex justify-center">
            <Switch.Root disabled>
                <Switch.Control>
                    <Switch.Thumb />
                </Switch.Control>
            </Switch.Root>
        </div>
    );
}

Accessibility#

Switch component uses a hidden native checkbox element with switch role internally that is only visible to screen readers. Value to describe the component can either be provided via label tag combined with id prop or using aria-labelledby, aria-label props.

<label htmlFor="switch1">Remember Me</label>
<Switch inputId="switch1" />
 
<span id="switch2">Remember Me</span>
<Switch aria-labelledby="switch2" />
 
<Switch aria-label="Remember Me" />

Keyboard Support#

Key	Function
`tab`	Moves focus to the switch.
`space`	Toggles the checked state.