Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
storybook-react-i18next
Advanced tools
Easy react-i18next Storybook integration.
Required Peer Dependencies:
^7.0.0
^22.0.0
^7.0.0
^2.0.0
^12.0.0
This Storybook addon assumes your project is already set up with i18next and react-i18next, with all the required packages installed, and that it is properly configured and working.
Install this addon as a dev dependency.
npm i -D storybook-react-i18next
yarn add -D storybook-react-i18next
You will need to install i18next
and react-i18next
as dependencies to your project if they are not already installed.
npm i -S i18next react-i18next i18next-browser-languagedetector i18next-http-backend
yarn add i18next react-i18next i18next-browser-languagedetector i18next-http-backend
After installing, follow these 3 steps to enable this addon in Storybook.
Insert this addon into your addons array:
{
addons: [
// other addons...
'storybook-react-i18next',
]
}
Create a file in your .storybook
folder called i18next.ts
(or whatever you like).
In this file, copy and paste the below code and make whatever modifications you need (paths to resource files, languages, etc.).
import {initReactI18next} from 'react-i18next';
import i18n from 'i18next';
import Backend from 'i18next-http-backend';
import LanguageDetector from 'i18next-browser-languagedetector';
const ns = ['common'];
const supportedLngs = ['en', 'fr', 'ja'];
const resources = ns.reduce((acc, n) => {
supportedLngs.forEach((lng) => {
if (!acc[lng]) acc[lng] = {};
acc[lng] = {
...acc[lng],
[n]: require(`../public/locales/${lng}/${n}.json`),
};
});
return acc;
}, {});
i18n.use(initReactI18next)
.use(LanguageDetector)
.use(Backend)
.init({
//debug: true,
lng: 'en',
fallbackLng: 'en',
defaultNS: 'common',
ns,
interpolation: {escapeValue: false},
react: {useSuspense: false},
supportedLngs,
resources,
});
export default i18n;
Refer to the i18next Configuration Options documentation for detailed information about the configuration options.
In your preview.ts
, you need to add the locales
and locale
globals, as well as adding i18n
that you exported from the above file to parameters.
`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 what you want the default locale to be.
import i18n from './i18next';
const preview: Preview = {
globals: {
locale: 'en',
locales: {
en: 'English',
fr: 'Français',
ja: '日本語',
},
},
parameters: {
i18n,
},
};
You can also use full locale strings as keys. It depends on your i18next configuration.
import i18n from './i18next';
const preview: Preview = {
globals: {
locale: 'en_US',
locales: {
en_US: 'English (US)',
en_GB: 'English (GB)',
fr_FR: 'Français',
ja_JP: '日本語',
},
},
parameters: {
i18n,
},
};
The locales
object can also have values as an object with keys of title
, left
, or right
.
This is useful if you want to include an emoji flag or some other string to the left or right side.
For example:
import i18n from './i18next';
const preview: Preview = {
globals: {
locale: "en",
locales: {
en: {title: "English", left: '🇺🇸'},
fr: {title: "Français", left: '🇫🇷'},
ja: {title: "日本語", left: '🇯🇵'},
},
},
parameters: {
i18n,
},
};
Or something like this:
import i18n from './i18next';
const preview: Preview = {
globals: {
locale: "en_US",
locales: {
en_US: {title: "English", right: 'US'},
en_GB: {title: "English", right: 'GB'},
fr_FR: {title: "Français", right: 'FR'},
ja_JP: {title: "日本語", right: 'JP'},
},
},
parameters: {
i18n,
},
};
If you want to have a story use a specific locale, set it in that Story's parameters.
export const Default: StoryObj = {
render: () => <YourComponent/>,
};
export const Japanese: StoryObj = {
parameters: {
locale: 'ja',
},
render: () => <YourComponent/>,
};
Note that doing this switches the current locale to the parameter one, so when you change to a story without a parameter, it will stay at the last selected locale.
In the above example, if you view the Japanese story and then click back on the Default story, the locale will stay ja
.
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 locale json files.
In .storybook/preview.ts
, move the locale/locales to be under globals
instead of parameters
.
v2.0.11 (Wed Mar 06 2024)
FAQs
Add react-i18next support to Storybook
The npm package storybook-react-i18next receives a total of 78,360 weekly downloads. As such, storybook-react-i18next popularity was classified as popular.
We found that storybook-react-i18next demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.