Git Product home page Git Product logo

react-multi-lang's Introduction

react-multi-lang

React Multilanguage Higher Order Component.

Works with React and React Native

Installation

npm i -S react-multi-lang

Usage

See the example folder for better understanding

// @flow

import * as React from 'react'

// Translation Higher Order Component
import { setTranslations, setDefaultLanguage, translate } from 'react-multi-lang'
import pt from 'pt.json'
import en from 'en.json'
import type { T } from 'react-multi-lang'

// Do this two lines only when setting up the application
setTranslations({pt, en})
setDefaultLanguage('en')

type Props = {
  t: T
}

type State = {}

class SomeComponent extends React.Component<Props, State> {
  render () {
    const { translate } = this.props
    return (
      <div>
        {t('home.Title')}
        {t('Hello', {name: 'João'})}
      </div>
    )
  }
}

export default translate(SomeComponent)

Injected Method

If using the Higher Order Component translate(SomeComponent)

t(path, params)

Params Type Description
path string translation path that identifies the text
params object {'param': 'value', ...} each param will be set on the string in its correct location

Exported Methods

setDefaultTranslations(translations)

Sets the translations

Params Type Description
translations object {'key': 'translations', ...}

setTranslations(translations)

Same as setDefaultTranslations, but this will update all components using translations

Params Type Description
translations object {'key': 'translations', ...}

setDefaultLanguage(key)

Sets the default application language

Params Type Description
key string translation key, in this example 'en' or 'pt'

setLanguage(key)

Same as setDefaultLanguage, but this will update all components using translations

Params Type Description
key string translation key, in this example 'en' or 'pt'

getLanguage()

Returns the current selected language

t(key, params)

Get text function, will return the translated string

Params Type Description
key string translation key that identifies the text
params object {'param': 'value', ...} each param will be set on the string in its correct location

react-multi-lang's People

Contributors

jwebcoder avatar

Watchers

uğur sözen avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.