No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

The component failed to render properly, likely due to a configuration issue in Storybook. Here are some common causes and how you can address them:

  1. Missing Context/Providers: You can use decorators to supply specific contexts or providers, which are sometimes necessary for components to render correctly. For detailed instructions on using decorators, please visit the Decorators documentation.
  2. Misconfigured Webpack or Vite: Verify that Storybook picks up all necessary settings for loaders, plugins, and other relevant parameters. You can find step-by-step guides for configuring Webpack or Vite with Storybook.
  3. Missing Environment Variables: Your Storybook may require specific environment variables to function as intended. You can set up custom environment variables as outlined in the Environment Variables documentation.

Switch

When to use

Switch is a representation of an on-off state – like a light switch. So you can use Switch to toggle binary states.

Switches trigger changes immediately. If your component should trigger a change only after sending a form, it's better to use either RadioButtonGroup or Checkbox instead. Furthermore, switches cannot be grouped – each Switch triggers an independent state. If you want multiple mutually exclusive choices, the RadioButtonGroup is the better option. To offer multiple choices within the same group or context which are not mutually exclusive, use Checkbox instead.

Usage

import { Switch } from '@grafana/ui';

<Switch disabled={...} value={...} onChange={...} />

Props

NameDescriptionDefault
value
boolean
-
invalid
Show an invalid state around the input
boolean
false

InlineSwitch

When to use

Same as for Switch but for inline forms.