globalizejs/globalize

Docs: Use Globalize with Ecma-402

Open

#532 opened on Oct 10, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (4,759 stars) (645 forks)batch import
docshelp wantedquick change

Description

We should provide examples demonstrating how certain modules (e.g., message, relative time, unit formatters) could be used along with Ecma-402.

:boom: It's important to highlight that such mixture of libraries will decrease the supported browsers (or will require user to polyfill when needed).

I think this topic deserves presence in the main documentation (REDAME.md) and specific examples inside of each of the mentioned modules.

Requires:

  • Add unit formatting #512
  • Relative Time: Accept numberFormatter as option #531

Examples:

var ecmaNumberFmt = Intl.NumberFormat( "en" );

Globalize.loadMessages({
  en: {
    task: [
      "You have {count, plural,",
      "     =0 {no tasks}",
      "    one {one task}",
      "  other {{formattedCount} tasks}",
      "} remaining"
    ]
  }
});

taskFormatter = Globalize( "en" ).messageFormatter( "task" );

taskFormatter({
  count: 0,
  formattedCount: ecmaNumberFmt( 0 )
});

var relativeTimeFormatter = Globalize( "en" ).relativeTimeFormatter(  "month", {
  numberFormatter: ecmaNumberFmt
});

var unitFormatter = Globalize( "en" ).unitFormatter(  "month", {
  numberFormatter: ecmaNumberFmt
});

Ref #399

Contributor guide

Tech stack
javascript
Domain
documentationlocalization
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of GlobalizeFamiliarity with Intl API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
This issue aims to add documentation examples for using Globalize modules (message, relative time, unit) with Ecma 402 (Intl) APIs. The primary task is to add examples to the main README.md and to individual module documentation. However, this issue depends on #512 (Add unit formatting) and #531 (Relative Time: Accept numberFormatter as option), which are not yet merged. Once those are resolved, examples can be created following the pattern shown in the issue body. The examples should highlight browser compatibility and need for polyfills.