The AWS Amplify I18n module is a lightweight internationalization solution.

<!-- TODO Rewrite should we promote this in our library guides? or directs developers to the UI docs site? -->

## Installation

```javascript
import { I18n } from 'aws-amplify';
```

## Working with the API

### setLanguage()

Sets the active language.

```javascript
I18n.setLanguage('fr');
```

In the browser, Amplify detects browser language automatically. For mobile you may want to use other libraries to detect the language, and then set it using Amplify in your code.

### putVocabularies()

You can create your custom dictionary and set it as your `vocabularies` in your app. Dictionary is a JavaScript object that you can implement with different terms and languages.

```javascript
const dict = {
  fr: {
    'Sign In': 'Se connecter',
    'Sign Up': "S'inscrire"
  },
  es: {
    'Sign In': 'Registrarse',
    'Sign Up': 'Regístrate'
  }
};

I18n.putVocabularies(dict);
```

### get()

Retrieves a phrase from the dictionary for the active language. If the phrase does not have an entry in the dictionary, the original parameter value will be returned.

```javascript
I18n.get('Sign In');
```

### API Reference

For the complete API documentation for i18n module, visit our [API Reference](https://aws-amplify.github.io/amplify-js/api/classes/i18n.html)
