Package Exports
- use-intl
- use-intl/dist/index.js
- use-intl/dist/src/core
- use-intl/dist/src/core/createBaseTranslator
- use-intl/dist/src/core/createBaseTranslator.js
- use-intl/dist/src/core/index.js
- use-intl/dist/src/react/getInitializedConfig
- use-intl/dist/src/react/getInitializedConfig.js
- use-intl/dist/use-intl.esm.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (use-intl) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
🌐 use-intl
Internationalization for React that gets out of your way.
Features
Internationalization is an essential part of the user experience. use-intl gives you everything you need to get language subtleties right and has always got your back whenever you need to fine-tune a translation.
- 🌟 ICU message syntax: Localize your messages with interpolation, plurals, ordinal pluralization, enum-based label selection and rich text.
- 📅 Dates, times & numbers: Apply appropriate formatting without worrying about server/client differences like time zones.
- ✅ Type-safe: Speed up development with autocompletion for message keys and catch typos early with compile-time checks.
- 💡 Hooks-only API: Learn a single API that can be used across your code base to turn translations into plain strings or rich text.
- ⚔️ Standards-based: Use the best parts of built-in JavaScript APIs and supplemental lower-level APIs from Format.JS.
What does it look like?
This library is based on the premise that messages can be grouped by namespaces (typically a component name).
// UserDetails.tsx
import {useTranslations, useFormatter} from 'next-intl';
function UserDetails({user}) {
const t = useTranslations('UserDetails');
const format = useFormatter();
return (
<section>
<h2>{t('title')}</h2>
<p>{t('followers', {count: user.followers.length})}</p>
<p>{t('lastSeen', {time: format.relativeTime(user.lastSeen)})</p>
<Image alt={t('portrait', {username: user.name})} src={user.portrait} />
</section>
);
}
// en.json
{
"UserDetails": {
"title": "User details",
"followers": "{count, plural, ↵
=0 {No followers yet} ↵
=1 {One follower} ↵
other {# followers} ↵
}",
"lastSeen": "Last seen {time}",
"portrait": "Portrait of {username}"
}
}
Installation
npm install use-intl
- Add the provider
import {IntlProvider} from 'use-intl';
// You can get the messages from anywhere you like. You can also
// fetch them from within a component and then render the provider
// along with your app once you have the messages.
const messages = {
"App": {
"hello": 'Hello {username}!'
}
};
function Root() {
return (
<IntlProvider messages={messages} locale="en">
<App user={{name: 'Jane'}} />
</IntlProvider>
);
}
function App({user}) {
const t = useTranslations('App');
return <h1>{t('hello', {username: user.name})}</h1>;
}
Have a look at the minimal setup example to explore a working app.
Usage
Please refer to the next-intl
usage docs for more advanced usage, but note that you should import from use-intl
instead of next-intl
.