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.

Radio

Customize the native <input type="radio"> with CSS that changes the element’s initial appearance. Consistent, cross-browser and cross-device.

Our radios use custom icons to indicate checked states.

<div class="form-check">
  <input type="radio" id="151242aa-a074-4a55-a81c-db597c83cdad--default" class="form-check-input" />
  <label class="form-check-label" for="151242aa-a074-4a55-a81c-db597c83cdad--default">Label</label>
</div>
NameDescriptionDefaultControl
General
Label
Describes the content/topic of the component.
string
-
Hidden Label
Renders the component with or without a visible label.There are accessibility concerns with hidden labels.
Please read our label accessibility guide.
boolean
-
Size
Sets the size of the component's appearance.
string
-
States
Checked
When set to true, places the component in the checked state.
boolean
-
Disabled
When set to true, disables the component's functionality and places it in a disabled state.There are accessibility concerns with the disabled state.
Please read our disabled state accessibility guide.
boolean
-
Validation
Controls the display of the component's validation state.
string
-

Make sure the @swisspost/design-system-styles package is already present in your project or follow the installation guidelines.

To import all Design System styles:

@use '@swisspost/design-system-styles/index.scss';

To import only the styles required for this component:

@use '@swisspost/design-system-styles/basics.scss';
@use '@swisspost/design-system-styles/components/form-check.scss';

// required if you use validation feedbacks
@use '@swisspost/design-system-styles/components/form-feedback.scss';

The following examples show the different characteristics of the component. These can differ in the type of visualization, the HTML structure, as well as when, how and why they are displayed.

The size can be changed by simply adding a class:

  • Small: .form-check-sm
  • Large: default

To render a radio inline, simply add the class .form-check-inline to the .form-check wrapper element.

Remember to wrap your radio groups in a <fieldset> including a <legend> tag. This provides a label for your radio group.


For more information, read our grouping accessibility guide.

To visually hide the <legend> element, use the .visually-hidden class.

Legend

Simply add the classes .is-valid or .is-invalid to the radio element to show it in the expected state.
When the component has been validated, don't forget to add a <p className="valid-feedback">...</p> or <p className="invalid-feedback">...</p> element after the radio element to explain what went wrong. This enables the user to correct the mistake.

Eraro okazis!