npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mobx-react-intl

v1.4.0

Published

Connectors between mobx-react and react-intl

Downloads

116

Readme

Internationalization with mobx and react-intl

A library to use react-intl along with a mobx store for the selected locale with typescript support.

npm version CircleCI semantic-release

Example

Since an example is worth a thousand words.

You can see this example running on Stackblitz

import React, { Component } from 'react';
import { render } from 'react-dom';
import { Provider, inject, observer } from "mobx-react"; 
import { MobxIntlProvider, LocaleStore } from "mobx-react-intl"; 
import {addLocaleData, injectIntl, FormattedMessage} from "react-intl";
import enLocale from 'react-intl/locale-data/en';
import deLocale from 'react-intl/locale-data/de';
addLocaleData([...deLocale, ...enLocale]);


const translations = {
  en: {
    hello: "Hello", 
    world: "World"
  }, 
  de: {
    hello: "Hallo", 
    world: "Wereld"
  }
}

// Internationalization
const localeStore = new LocaleStore("en", translations);

const store = {
    locale: localeStore, // The locale store has to be called locale. 
};

const _Home = ({intl: {formatMessage}, locale}) => <div>
    <h1>{formatMessage({id: "hello"})}</h1>
    <FormattedMessage id="world" />
    <br/>
    <select value={locale.value} onChange={(event) => locale.value = event.target.value}>
        <option value="de">Deutsch</option>
        <option value="en">English</option>
    </select>
</div>
const Home = inject("locale")(injectIntl(observer(_Home)));

const App = () => <div>
    <Provider {...store}> 
        <MobxIntlProvider>
            <Home />
        </MobxIntlProvider>
    </Provider>
</div>;

render(<App />, document.getElementById('root'));

I18n mobx store

LocaleStore is a mobx store that contains the locale data and persists the locale to the browser LocalStorage (if it exists).

The store expects the default locale and the translations for all supported locales as arguments.

Intl Provider

MobxIntlProvider.js: Creates the I18n provider for mobx. Note that it relies on IntlProvider from react-intl.

This component has the same interface as IntlProvider except that the locale and messages attributes are injected through mobx.

Using locale data in other stores.

It is possible to also use the i18n without being in the react scope. For example when initializing a store that needs locale data, just pass the locale store as a prop. You can see that a formatMessage method is implemented in the LocaleStore for this case.

Example

A running example with some file structure is provided in examples/simple-app.

Run the example locally:

To run this create-react-app project, run the following commands (yarn can be replaced by npm)

yarn install 
yarn start

Introduction

To have internationalization (i18n) working with react, mobx and react-intl, we need to:

  1. Create a store for the i18n data (locale used and locale data)
  2. Uhe use a custom provider to provide internationalization from the mobx store.
  3. Inject the provider to UI components.
  4. Use the provided code.

I18n translations.

We create two files to maintain locale data:

./translations/en.js and ./translations/de.js provide translations for English and German.

Language Switcher

./Toolbar.js is the component used to switch from one language to another.

Home

./Home.js is a UI component that uses i18n to display texts.

Application initializer

In ./App.js we finally wrap up all components.

The app is initialized initialized with the Provider and shows the Home component.