@fluent/bundle
@fluent/bundle
is a JavaScript implementation of Project Fluent,
optimized for runtime performance.
Installation
@fluent/bundle
can be used both on the client-side and the server-side. You
can install it from the npm registry or use it as a standalone script (as the
FluentBundle
global).
npm install @fluent/bundle
How to use
The FluentBundle
constructor provides the core functionality of formatting
translations from FTL files.
import { FluentBundle, FluentResource } from "@fluent/bundle";
let resource = new FluentResource(`
-brand-name = Foo 3000
welcome = Welcome, {$name}, to {-brand-name}!
`);
let bundle = new FluentBundle("en-US");
let errors = bundle.addResource(resource);
if (errors.length) {
}
let welcome = bundle.getMessage("welcome");
if (welcome.value) {
bundle.formatPattern(welcome.value, { name: "Anna" });
}
The API reference is available at https://projectfluent.org/fluent.js/bundle.
Compatibility
@fluent/bundle
requires the following Intl
formatters:
Intl.DateTimeFormat
(standard, well-supported)Intl.NumberFormat
(standard, well-supported)Intl.PluralRules
(standard, new in ECMAScript 2018)
Intl.PluralRules
may already be available in some engines. In most cases,
however, a polyfill will be required. We recommend intl-pluralrules.
import "intl-pluralrules";
import { FluentBundle } from "@fluent/bundle";
See also the Compatibility article on the fluent.js
wiki.