ICU Parameter Guide

Example

Content: "Hello @{name}, welcome!"

Params:

{
  "paramName": "name",
  "type": "simple"
}

Usage: t.greeting("John") → "Hello John, welcome!"

Example - Currency

Content: "Price: @{price}"

Params:

{
  "paramName": "price",
  "type": "number",
  "numberFormat": {
    "style": "currency",
    "currency": "CNY"
  }
}

Usage: t.product.price(42) → "Price: CNY42.00"

Example - Percent

Content: "Completion: @{progress}"

Params:

{
  "paramName": "progress",
  "type": "number",
  "numberFormat": {
    "style": "percent"
  }
}

Usage: t.task.progress(0.42) → "Completion: 42%"

Example - Compact (Short)

Content: "Population: @{pop}"

Params:

{
  "paramName": "pop",
  "type": "number",
  "numberFormat": {
    "style": "decimal",
    "compact": "short",
    "precisionLength": 1
  }
}

Usage: t.stats.population(4200000) → "Population: 4.2M"

Example - Gender Selection

Content: "@{name} is @{gender}"

Params:

{
  "paramName": "gender",
  "type": "select",
  "list": [
    { "value": "male", "text": "a man" },
    { "value": "female", "text": "a woman" },
    { "value": "other", "text": "someone" }
  ]
}

Usage: t.person.gender("Alice", "female") → "Alice is a woman"

Example - Category Selection

Content: "Order status: @{status}"

Params:

{
  "paramName": "status",
  "type": "select",
  "list": [
    { "value": "pending", "text": "Pending" },
    { "value": "processing", "text": "Processing" },
    { "value": "completed", "text": "Completed" },
    { "value": "cancelled", "text": "Cancelled" }
  ]
}

Usage: t.order.status("pending") → "Order status: Pending"

Example - Item Count

Content: "You have @{count} @{itemCount}"

Params:

{
  "paramName": "count",
  "type": "simple"
},
{
  "paramName": "itemCount",
  "type": "plural",
  "options": { "type": "cardinal" },
  "list": [
    { "value": "one", "text": "item" },
    { "value": "other", "text": "items" }
  ]
}

Usage:

• t.cart.items(1) → "You have 1 item"
• t.cart.items(5) → "You have 5 items"

Example - Complex Plural (Russian)

Content: "You have @{count} @{itemCount}"

Params:

{
  "paramName": "count",
  "type": "simple"
},
{
  "paramName": "itemCount",
  "type": "plural",
  "options": { "type": "cardinal" },
  "list": [
    { "value": "one", "text": "товар" },
    { "value": "few", "text": "товара" },
    { "value": "many", "text": "товаров" },
    { "value": "other", "text": "товара" }
  ]
}

Example - Position in Queue

Content: "You are @{position}th in line"

Params:

{
  "paramName": "position",
  "type": "selectordinal",
  "list": [
    { "value": "one", "text": "#st" },
    { "value": "two", "text": "#nd" },
    { "value": "few", "text": "#rd" },
    { "value": "other", "text": "#th" }
  ]
}

Usage:

• t.queue.position(1) → "You are 1st in line"
• t.queue.position(2) → "You are 2nd in line"
• t.queue.position(3) → "You are 3rd in line"
• t.queue.position(4) → "You are 4th in line"

Example - Short Date

Content: "Delivery date: @{date}"

Params:

{
  "paramName": "date",
  "type": "date",
  "style": "short",
  "zoneId": "Asia/Shanghai"
}

Usage: t.order.deliveryDate(new Date("2024-12-25")) → "Delivery date: 2024-12-25"

Example - Custom Format with Timezone

Content: "Check-in: @{checkin}"

Params:

{
  "paramName": "checkin",
  "type": "date",
  "format": "yyyy-MM-dd HH:mm",
  "zoneId": "Asia/Shanghai"
}

Usage: t.hotel.checkin(someDate) → "Check-in: 2024-12-25 14:30"

Example - Short Time

Content: "Start time: @{start}"

Params:

{
  "paramName": "start",
  "type": "time",
  "style": "short",
  "zoneId": "Asia/Shanghai"
}

Usage: t.meeting.start(someTime) → "Start time: 14:30"

Example - 12-hour Format with AM/PM

Content: "Meeting at @{time}"

Params:

{
  "paramName": "time",
  "type": "time",
  "format": "hh:mm a",
  "zoneId": "America/New_York"
}

Usage: t.meeting.at(someTime) → "Meeting at 02:30 PM"

Example - Short Duration

Content: "Duration: @{dur}"

Params:

{
  "paramName": "dur",
  "type": "duration",
  "style": "short"
}

Usage:

• t.video.duration(90) → "Duration: 1m 30s"
• t.video.duration(3600) → "Duration: 1h"
• t.video.duration(7200) → "Duration: 2h"

Example - Digital Duration

Content: "Elapsed: @{elapsed}"

Params:

{
  "paramName": "elapsed",
  "type": "duration",
  "style": "digital"
}

Usage: t.timer.elapsed(3723) → "Elapsed: 01:02:03"