@languine/react-email
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

A lightweight i18n library for React Email.


$ npm install @languine/react-email

What is this?

This is a lightweight i18n library for React Email built on top of i18n-js.

Language files are automatically included in the locales folder.

How to use

import { setupI18n } from "@languine/react-email";

export function WelcomeEmail({ locale, name }) {
  const i18n = setupI18n(locale);

  return (
    <Html>
      <Head />
      <Preview>{i18n.t("preview")}</Preview>
      <Body>
         <Text>{i18n.t("welcome", { name  })}</Text>
      </Body>
    </Html>
  );
}

Translation files (en.json)

Add your translation files in the locales folder.

{
    "preview": "Welcome to our app!",
    "welcome": "Hello, %{name}!"
}

Rendering the email

import { render } from '@react-email/render';
import { WelcomeEmail } from "./emails/welcome";

const html = await render(<WelcomeEmail locale="en" name="John" />, {
  pretty: true,
});

console.log(html);

Works together with Languine CLI

Automatically add and translate your email templates with Languine CLI.

$ npx languine@latest

Readme

Keywords

none

Package Sidebar

Install

npm i @languine/react-email

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

102 kB

Total Files

4

Last publish

Collaborators

  • pontus-midday