@mi18n/format-icu

Mi18n ICU Format Plugin
The ICU Formatter Plugin for Mi18n JS integrations

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

Become part of the family. Join slack channel

What is Icu Format Plugin?

It's a plugin for Mi18n JS, which enables the rendering of messages in ICU message format. For more information about the Mi18n ICU Format plugin, visit the docs.

Quick links

• Mi18n JS SDK docs
• Mi18n Website
  • Product (Learn more about the great features)
    • Dev tools
    • Translation assistance
    • Collaboration
• Integrations (Learn how to integrate Mi18n with your favorite technology)
  • React
  • Angular
  • Vue
  • Svelte
  • Next.js
  • More...
• Mi18n platform docs

Installation

npm install @mi18n/format-icu

Usage

First, create a Mi18n instance and run it.

import { FormatIcu } from "@mi18n/format-icu";

const mi18n = Mi18n()
  .use(FormatIcu())
  .init(...)

...

Now you can use ICU format in your translations. Example:

mi18n.t('test', 'Hello, I am {name}.', { name: 'John' })
// 'Hello, I am John.'

Check our ICU format documentation to learn more.

Why to use Mi18n?

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 🔥

Read more on the Mi18n 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 web or any integration development script

pnpm develop:react

or

pnpm develop:web

This runs the development suite of this monorepo for the specific 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/format-icu directory.

Contributors