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.

This is a pre-release version and is not production ready. For new and ongoing projects, please refer to the latest Design System version.

Badge

Figma Design
Highlight a numerical characteristic or mark an item with a status.
1
<div class="badge">1</div>
NameDescriptionDefaultControl
Content
Show Number
If true, the badge contains a number otherwise it is empty.
boolean
-
Number
The number contained in the badge.
number
-
General
Size
The size of the badge.
string
-
Background
You can use the background classes to color the cards
-
-

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/post-compact.scss';

To import only the styles required for this component:

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

You can change the badge color simply by applying a .bg-* class to it.

1
1
1
1

A large number will extend the badge with. To prevent the badge from being too large you can simply use the + notation as shown hereafter.

256
+99

As inline elements, the badges can be placed inside other element such as tags. They can also be place absolutely to appear above other elements such as icons for example.

3