![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
storybook-react-i18next
Advanced tools
Readme
Easy react-i18next Storybook integration.
Required Peer Dependencies:
^8.0.0
^22.0.0 || ^23.0.0
^7.0.0 || ^8.0.0
^2.0.0
^12.0.0 || ^13.0.0 || ^14.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 devDependency.
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
to 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,
},
};
export default preview;
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,
},
};
export default preview;
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: {icon: '🇺🇸', title: 'English', right: 'EN'},
fr: {icon: '🇫🇷', title: 'Français', right: 'FR'},
ja: {icon: '🇯🇵', title: '日本語', right: 'JP'},
},
},
parameters: {
i18n,
},
};
export default preview;
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,
},
};
export default preview;
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.
FAQs
Add react-i18next support to Storybook
The npm package storybook-react-i18next receives a total of 105,624 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.