Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@tolgee/react

Package Overview
Dependencies
Maintainers
0
Versions
378
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@tolgee/react

React implementation for Tolgee localization framework

  • 5.32.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
26K
decreased by-7.41%
Maintainers
0
Weekly downloads
 
Created
Source

Tolgee for React
The Tolgee i18n SDK for React

Logo

Tolgee is an open-source alternative to Crowdin, Phrase, or Lokalise with its very own revolutionary integrations.

test workflow

@tolgee/react version

types typescript typescript licence github stars github stars Github discussions

What is Tolgee for React?

React integration library of Tolgee. This package makes it super simple to add i18n to your React app! For more information about using Tolgee with React, visit the docs 📖.

Localize (translate) your CRA, Next.js, or other React projects to multiple languages with Tolgee. Integration of Tolgee is extremely simple! 🇯🇵 🇰🇷 🇩🇪 🇨🇳 🇺🇸 🇫🇷 🇪🇸 🇮🇹 🇷🇺 🇬🇧

Installation

npm install @tolgee/react

Then use the library in your app:

import { TolgeeProvider, ReactPlugin, FormatSimple } from "@tolgee/react";

const tolgee = Tolgee()
  .use(ReactPlugin())
  .use(FormatSimple())
  .init({
    language: 'en',
    apiUrl: process.env.REACT_APP_TOLGEE_API_URL,
    apiKey: process.env.REACT_APP_TOLGEE_API_KEY
  });


<TolgeeProvider
  tolgee={tolgee}
>
  <Your app components>
</TolgeeProvider>

Usage

react-infinite

To translate texts using Tolgee React integration, you can use T component or useTranslate hook.

T component

import { T } from "@tolgee/react";

...

<T>translation_key</T>

or

<T keyName="translation_key">Default value</T>

useTranslate hook

import { useTranslate } from "@tolgee/react";

...

const { t } = useTranslate();

...

t("key_to_translate")

Prerequisites

  1. You have some React-based project
  2. You have generated an API key from Tolgee Cloud or a self-hosted Tolgee instance.

Why to use Tolgee?

Because it saves a lot of time, you would spend on localization tasks without it. Because it enables you to provide perfectly translated software.

Features

  • All-in-one localization solution for your JS application 🙌
  • Out-of-box in-context localization 🎉
  • Automated screenshot generation 📷
  • Translation management platform 🎈
  • Open-source 🔥

Frame 47 Read more on the Tolgee website

Development

We welcome your PRs.

To develop the package locally:

  1. Clone the repository
  2. Install the packages in the repository root
pnpm install
  1. Run the development script
pnpm develop:react

This runs the development suite of this monorepo for the react integration. The changes in each dependency package are automatically built and propagated to the test application, which you can open and play within the browser.

Testing

To run Jest tests of this package, execute

npm run test

In the /packages/react directory.

End-to-end (e2e) testing

To run the e2e tests, simply execute

pnpm run e2e run react

To open and play with e2e tests, run:

pnpm run e2e open react

Contributors

contributors

Keywords

FAQs

Package last updated on 21 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc