Navigation Menu

Skip to content

mattikl/react-intl

 
 

Repository files navigation

This library provides React Components and a Mixin for internationalizing React web apps. The components provide a declarative way to format dates, numbers, and string messages, including pluralization.

npm Version Build Status Dependency Status

Sauce Test Status

Overview

React Intl is part of FormatJS, the docs can be found on the website:

http://formatjs.io/react/

Features

  • Display numbers with separators.
  • Display dates and times correctly.
  • Display dates relative to "now".
  • Pluralize labels in strings.
  • Support for 150+ languages.
  • Runs in the browser and Node.js.
  • Built on standards.

Example

There are many examples on the website, but here's a comprehensive one:

var IntlMixin         = ReactIntl.IntlMixin;
var FormattedMessage  = ReactIntl.FormattedMessage;
var FormattedRelative = ReactIntl.FormattedRelative;

var PostMeta = React.createClass({
    mixins: [IntlMixin],

    render: function () {
        return (
            <FormattedMessage
                message={this.getIntlMessage('post.meta')}
                num={this.props.post.comments.length}
                ago={<FormattedRelative value={this.props.post.date} />} />
        );
    }
});

var post = {
    date    : 1422046290531,
    comments: [/*...*/]
};

var intlData = {
    locales : ['en-US'],
    messages: {
        post: {
            meta: 'Posted {ago}, {num, plural, one{# comment} other{# comments}}'
        }
    }
};

React.render(
    <PostMeta post={post} {...intlData} />,
    document.getElementById('container')
);

This example would render: "Posted 3 days ago, 1,000 comments" into the container element on the page. The post.meta message is written in the industry standard ICU Message syntax, which you can also learn about on the FormatJS website.

CDLR pluralization rules: In some languages you have more then one and other. For example in ru there are the following plural rules: one, few, many and other. Check out the official CDLR documentation from unicode.org http://www.unicode.org/cldr/charts/27/supplemental/language_plural_rules.html for all languages.

Note: You could also write =0 { No comments yet }

Contribute

Let's make React Intl and FormatJS better! If you're interested in helping, all contributions are welcome and appreciated. React Intl is just one of many packages that make up the FormatJS suite of packages, and you can contribute to any/all of them, including the Format JS website itself.

Check out the Contributing document for the details. Thanks!

License

This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.

About

React Components for internationalization.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 90.3%
  • HTML 8.7%
  • Shell 1.0%