react-intl-phraseapp

react-intl-phraseapp

react-intl-phraseapp is the official library for integrating Phrase Strings In-Context Editor with react-intl in your React application.

:scroll: Documentation

Prerequisites

To use react-intl-phraseapp with your application you have to:

• Sign up for a Phrase account: https://app.phrase.com/signup
• Use the excellent react-intl module by yahoo for localization in your react app

Demo

You can find a demo project on GitHub.

Installation

via NPM

npm install react-intl-phraseapp

Build from source

You can also build it directly from source to get the latest and greatest:

npm run dist

Development

# install deps
npm install

Configure

Add the following JavaScript snippet to your react app.

import {initializePhraseAppEditor} from 'react-intl-phraseapp'

let config = {
  projectId: '<YOUR_PROJECT_ID>',
  phraseEnabled: true,
  prefix: "[[__",
  suffix: "__]]",
  fullReparse: true
};

initializePhraseAppEditor(config);

You can find the Project-ID in the Project overview in the PhraseApp Translation Center.

If this does not work for you, you can also integrate the JavaScript snippet manually.

To use the old version of ICE, use option useOldICE: true in your PHRASEAPP_CONFIG or integration options

let config = {
  projectId: '<YOUR_PROJECT_ID>',
  phraseEnabled: true,
  useOldICE: true,
};

initializePhraseAppEditor(config);

Using the US Datacenter with ICE

In addition to phraseEnabled and projectId in the config, also add the US specific URLs to enable working through the US endpoint.

  baseUrl: "https://us.app.phrase.com",
  apiBaseUrl: 'https://api.us.app.phrase.com/api/v2',
  oauthEndpointUrl: "https://api.us.app.phrase.com/api/v2/authorizations",
  profileUrl: "https://us.app.phrase.com/settings/profile",

Import from react-intl-phraseapp rather than from react-intl

Find all imports of FormattedMessage, and change the source from react-intl to react-intl-phraseapp.

import {FormattedMessage} from 'react-intl-phraseapp'

Browser support

This library might not work out of the box for some older browser or IE11. We recommend to add Babel to the build pipeline if those browser need to be supported.

How does it work

The library inherits common components of the react-intl packages. In case you enabled Phrase by calling initializePhraseAppEditor the behaviour of the components will be changed.

Test

Run unit tests using jest:

npm test

:exclamation: Issues, Questions, Support

Please use GitHub issues to share the problem, and we will do our best to answer any questions or to support you in finding a solution.

:memo: Changelog

Detailed changes for each release are documented in the changelog.