Messages & plurals¶
Format ICU MessageFormat strings — placeholders, numbers, and especially
pluralisation and gender/word selection — without hardcoding any language's
grammar rules. A single pattern adapts: English needs one/other, Arabic needs six
categories, and message() picks the right branch from CLDR for you.
The pattern language¶
A pattern is plain text with {…} placeholders. There are four placeholder shapes:
| Shape | Example | Renders |
|---|---|---|
| Simple | Hello, {name}! |
substitutes the argument as-is |
| Number | {n, number} · {n, number, integer} · {n, number, percent} |
locale-formatted number |
| Plural | {n, plural, one {# item} other {# items}} |
picks a branch by plural category; # is the value |
| Select | {g, select, female {her} male {his} other {their}} |
picks a branch by exact string match |
Inside a plural/selectordinal branch, # is replaced by the (locale-formatted)
number. Two refinements:
- Exact matches —
=0 {none} one {# item} other {# items}uses the=0branch when the value is exactly 0, before falling back to the category. offset:n—{n, plural, offset:1 =0 {nobody} one {you and # other} other {you and # others}}subtractsnfrom#(for "you and 2 others" style phrasing).
An other branch is required in every plural/selectordinal/select — it's
the fallback when no category matches. Escape a literal brace or # by wrapping it
in single quotes: '{', '#', and '' for a literal apostrophe.
Messages¶
const c = new Cosmo("en");
c.message("{count, plural, one {# file} other {# files}}", { count: 3 });
// "3 files"
c.message("{n, number} of {m, number}", { n: 4560, m: 0.2 });
// "4,560 of 0.2"
c.message("{g, select, female {She} male {He} other {They}} replied", { g: "female" });
// "She replied"
Named vs positional arguments¶
Pass positional arguments in an array ({0}), or named arguments in an object
({name}). The built-in parser supports simple placeholders, number
(with integer, percent, and currency styles), plural, selectordinal,
select, offset:, exact matches (=N), and nesting. Date, time, spellout,
and number-skeleton argument formats are unsupported. Format those values
separately and pass them as strings.
Ordinals in messages¶
selectordinal works like plural but uses ordinal categories — the
"1st / 2nd / 3rd" wording rules:
const c = new Cosmo("en");
const p = "{n, selectordinal, one {#st} two {#nd} few {#rd} other {#th}} place";
c.message(p, { n: 1 }); // "1st place"
c.message(p, { n: 22 }); // "22nd place"
c.message(p, { n: 4 }); // "4th place"
Plural category¶
Sometimes you want the raw decision rather than a formatted message — e.g. to pick
an image or a CSS class. pluralCategory() returns the LDML category a number falls
into for the locale, the same choice message() makes internally.
const en = new Cosmo("en");
en.pluralCategory(1); // "one"
en.pluralCategory(2); // "other"
en.pluralCategory(2, true); // "two" (ordinal rules)
new Cosmo("ar").pluralCategory(0); // "zero"
Returns one of zero, one, two, few, many, other. Pass ordinal = true
for ordinal rules instead of cardinal.
Which categories does a locale use?
The set varies wildly: English has one/other (cardinal), Arabic has all six,
Japanese has only other. Write every plural branch you reference, but always
keep other — it covers any category you didn't spell out.
Practical examples¶
A notification badge sentence. One pattern handles zero, singular, and plural without branching in your code:
const c = new Cosmo("en");
const p = "{n, plural, =0 {No new messages} one {# new message} other {# new messages}}";
c.message(p, { n: 0 }); // "No new messages"
c.message(p, { n: 1 }); // "1 new message"
c.message(p, { n: 5 }); // "5 new messages"
"You and N others" with offset. The offset keeps the displayed # one less
than the real count: