New
Integrate Next.js and Storybook automaticallyAutomate with Chromatic
Star75,440
Back to integrations
Add your integration
Categories
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon
Storybook react-intl addon
Add react-intl support to Storybook
npm install @plutovr/storybook-react-intl
Last updated 5 months ago
2
Downloads per week
Readme View on GitHub

Storybook react-intl addon

Add react-intl support to Storybook.

Required Versions:

  • storybook - ^6.5.0
  • react-intl - ^5.24.0 || ^6.0.0

This Storybook addon assumes your project is already set up with react-intl, and that it is properly configured and working.

Installation

This addon should be added as a dev dependency.

npm i -D storybook-react-intl
yarn add -D storybook-react-intl

You will need to install react-intl as a dependency of your project if it is not already installed.

npm i -S react-intl
yarn add react-intl

Usage

After installing, follow these steps to enable this addon in Storybook.

main.js

Insert this addon into your addons array:

{
  addons: [
    // other addons...
    'storybook-react-intl',
  ]
}

reactIntl.js

Create a file in your .storybook folder called reactIntl.js (or whatever you like). This is where you will set up your react-intl configuration.

In this file, copy and paste the below code and make whatever modifications you need.

const locales = ['en', 'de'];

const messages = locales.reduce((acc, lang) => ({
  ...acc,
  [lang]: require(`../locale/${lang}.json`), // whatever the relative path to your messages json is
}), {});

const formats = {}; // optional, if you have any formats

export const reactIntl = {
  defaultLocale: 'en',
  locales,
  messages,
  formats,
};

preview.js

In your preview.js, you need to add the locales and locale parameters, as well as the reactIntl that you exported from the above file.

locales is an object where the keys are the "ids" of the locales/languages and the values are the names you want to display in the dropdown.

locale is the default locale, which can be read from reactIntl or set manually if you choose.

import {reactIntl} from './reactIntl.js';

export const parameters = {
  reactIntl,
  locale: reactIntl.defaultLocale,
  locales: {
    en: 'English',
    de: 'Deutsche',  
  },
};

You can also set locales to Storybook compatible objects as documented in the storybook-i18n addon (which is included as part of this addon).

export const parameters = {
    locales: {
        en: {title: "English", left: '🇺🇸'},
        fr: {title: "Français", left: '🇫🇷'},
        ja: {title: "日本語", left: '🇯🇵'},
    },
};

Once you have finished these steps and launch storybook, you should see a globe icon in the toolbar.

Clicking this globe icon will show a dropdown with the locales you defined in parameters.

Switching locales will use the strings defined in your messages.

Join the community
5,858 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI