Pre-defined Badges

There are a number of pre-defined badges that come with storybook-addon-badges. These come styled out of the box, but you can be further customise the style, or add your own badges.

Badge ID	'default' Base Style	'github' Base Style
default	Badge	Badge
a11y_check	⚠︎ A11y	⚠︎ A11y
a11y_fail	✖︎ A11y	✖︎ A11y
a11y_pass	✔︎ A11y	✔︎ A11y
beta	Beta	Beta
deprecated	Deprecated	Deprecated
experimental	Experimental	Experimental
needs_revision	Needs Revision	Needs Revision
new	New	New
obsolete	Obsolete	Obsolete
stable	Stable	Stable
updated	Updated	Updated

info

storybook-addon-badges exports a BADGE utility mapping that contains the names of all pre-defined badges and allows for autocomplete with typescript.

import { BADGE } from 'storybook-addon-badges';

const Default: Story = {
  tags: [BADGE.BETA],
};