nebula/docs/pages/components/switch.md

meta	layout
title description Switch Switches allow the user to toggle an option on or off.	component

<sl-switch>Switch</sl-switch>

import SlSwitch from '@onsonr/nebula/dist/react/switch';

const App = () => <SlSwitch>Switch</SlSwitch>;

:::tip This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation. :::

Examples

Checked

Use the checked attribute to activate the switch.

<sl-switch checked>Checked</sl-switch>

import SlSwitch from '@onsonr/nebula/dist/react/switch';

const App = () => <SlSwitch checked>Checked</SlSwitch>;

Disabled

Use the disabled attribute to disable the switch.

<sl-switch disabled>Disabled</sl-switch>

import SlSwitch from '@onsonr/nebula/dist/react/switch';

const App = () => <SlSwitch disabled>Disabled</SlSwitch>;

Sizes

Use the size attribute to change a switch's size.

<sl-switch size="small">Small</sl-switch>
<br />
<sl-switch size="medium">Medium</sl-switch>
<br />
<sl-switch size="large">Large</sl-switch>

import SlSwitch from '@onsonr/nebula/dist/react/switch';

const App = () => (
  <>
    <SlSwitch size="small">Small</SlSwitch>
    <br />
    <SlSwitch size="medium">Medium</SlSwitch>
    <br />
    <SlSwitch size="large">Large</SlSwitch>
  </>
);

Help Text

Add descriptive help text to a switch with the help-text attribute. For help texts that contain HTML, use the help-text slot instead.

<sl-switch help-text="What should the user know about the switch?">Label</sl-switch>

import SlSwitch from '@onsonr/nebula/dist/react/checkbox';

const App = () => <SlSwitch help-text="What should the user know about the switch?">Label</SlSwitch>;

Custom Styles

Use the available custom properties to change how the switch is styled.

<sl-switch style="--width: 80px; --height: 40px; --thumb-size: 36px;">Really big</sl-switch>

{% raw %}

import SlSwitch from '@onsonr/nebula/dist/react/switch';

const App = () => (
  <SlSwitch
    style={{
      '--width': '80px',
      '--height': '32px',
      '--thumb-size': '26px'
    }}
  />
);

{% endraw %}