npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@wojtekmaj/react-t

v0.10.4

Published

Simple translation module for React applications.

Downloads

909

Readme

npm downloads CI

React-T

Simple translation module for React applications.

tl;dr

  • Install by executing npm install @wojtekmaj/react-t or yarn add @wojtekmaj/react-t.
  • Setup by adding import { TProvider } from '@wojtekmaj/react-t' and wrapping your app in <TProvider />.
  • Add languages by creating a JSON file, like this:
    {
      "Hello world!": "Hallo Welt!"
    }
    and adding languageFiles to <TProvider />, like this:
    <TProvider languageFiles={{ 'de-DE': () => import('./de-DE.json') }} />
  • Use by adding import T from '@wojtekmaj/react-t' and wrapping your text in <T />.

Getting started

Compatibility

Your project needs to use React 16.8 or later.

React-T is also compatible with React Native.

Installation

Add React-T to your project by executing npm install @wojtekmaj/react-t or yarn add @wojtekmaj/react-t.

Setting up

Here's an example of basic setup:

import { createRoot } from 'react-dom/client';
import { TProvider } from '@wojtekmaj/react-t';

import Root from './Root';

const languageFiles = {
  'de-DE': () => import('./de-DE.json'),
};

createRoot(document.getElementById('react-root')).render(
  <TProvider languageFiles={languageFiles}>
    <Root />
  </TProvider>,
);

Usage

Here's an example of basic usage:

import T from '@wojtekmaj/react-t';

function MyComponent() {
  return (
    <p>
      <T>Hello world!</T>
    </p>
  );
}

How the locale is detected?

React-T detects locale to use by going through the list of possible sources:

  1. locale prop provided to <TProvider />
  2. <html lang="…"> attribute
  3. List of preferred user locales obtained using get-user-locale

On each step, React-T checks if a given locale is supported (provided in languageFiles, or defined as defaultLocale). If a given locale is supported, it'll use it. If not, it'll move to the next step on the list.

If no supported locale is detected, defaultLocale is used (no translation is being made).

User guide

Usage of TProvider component

Wrap your app in <TProvider />.

Define languageFiles prop that contains an object of:

  • functions that return promises:
    {
      'de-DE': () => import('./myLanguageFile.json'),
    }
  • functions that return language files:
    {
      'de-DE': () => myLanguageFile,
    }
  • language files:
    {
      'de-DE': myLanguageFile,
    }

Usage of the T component:

Define translatable string in the code using <T> tag:

<T>Original phrase</T>

If necessary, you may use variables like so:

<T name={name}>{'Hello, {name}'}</T>

Usage of the useTranslation hook

Define translatable string in the code using useTranslation hook:

const translatedPhrase = useTranslation('Original phrase');

If necessary, you may use variables like so:

const translatedPhrase = useTranslation('Hello, {name}', { name });

Translating strings

  1. If you're a translator, add a corresponding entry in language JSON files, for example:
{
  "Hello world!": "Hallo Welt!"
}

If a corresponding entry in language file for current locale is not found, default locale will be used.

License

The MIT License.

Author