rsnext/examples/with-lingui/README.md
Marcos Bérgamo c3e5caf110
docs(examples): improve DX while copying command to create new project (#38410)
* docs(examples): improve DX while copy command to create new project

* chore: apply code review

Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00

2.1 KiB

With Lingui example

This example shows a way to use lingui.js with next.js.

It adds a webpack loader for the messages to avoid having to manually compile while developing as well as adds the compile step to the next build script for production builds.

The example also uses a Higher order Component which can be added to all pages which will be translated and that checks for a ?lang query string switch the language. Next.js will dynamically load in the messages for the locale when navigating using a Next.js <Link /> component.

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-lingui with-lingui-app
yarn create next-app --example with-lingui with-lingui-app
pnpm create next-app --example with-lingui with-lingui-app

Deploy it to the cloud with Vercel (Documentation).

How to add more translated strings

To add new strings use the react component <Trans /> and then run yarn export to export the messages into locale/{language}/messages.po.

How to add another language

To add another language simply run yarn add-locale <locale ...> and it will create a new locale in the locale/messages/ directory.