ember-short-number

ember-short-number

Short number formatting based on cldr locale data. Particularly useful for statistical data, showing financial numbers in charts, and abbreviating number of ratings.

• 1234 is converted to 1K in English
• 101234 is converted to 101K in English and 101.1K if need 1 significant digit
• 1234 is converted to 1 mil in Espanol
• 101234 is converted to 101,1K in Espanol if need 1 significant digit

Based on cldr-numbers-full

Here is the related proposal for Compact Decimal Format.

Currently this only shortens with latin digits 0..9

For your information, known number systems include:

[adlm, ahom, arab, arabext, armn, armnlow, bali, beng, bhks, brah, cakm, cham, cyrl, deva, ethi, fullwide, geor, grek, greklow, gujr, guru, hanidays, hanidec, hans, hansfin, hant, hantfin, hebr, hmng, java, jpan, jpanfin, kali, khmr, knda, lana, lanatham, laoo, latn, lepc, limb, mathbold, mathdbl, mathmono, mathsanb, mathsans, mlym, modi, mong, mroo, ...]

Lastly, this work will be built into ember-intl in the near future and will use something like shortNumber notation style defined in ICU message syntax.

Installation

ember install ember-short-number

Configuration

Provide list of language codes applicable to your app in your environment.js file. See ISO 639-1 for more information.

If not provided, we will include the data for all CLDR number formatting options in your app. IMPORTANT - this adds ~28KB gzipped to your app so be sure to include all the languages you care about.

let ENV = {
  'ember-short-number': {
    locales: ['en', 'es'],
    threshold: 0.5 // default
  }
}

Usage

Note - the following APIs take the language code as the the second argument based on ISO 639-1

Template Helper

{{short-number 19634 "en"}}

{{short-number 19634 "en" significantDigits=1}}

{{short-number 101K "en" significantDigits=1 useShorterFormat=true}}

Alternatively use the Service API

this.shortNumber.format(19634, 'en');
// 19K

this.shortNumber.format(19634, 'ja');
// 2万

this.shortNumber.format(19634, 'en', { significantDigits: 1, minimumFractionDigits: 1, maximumFractionDigits: 2 });
// 19.6K

this.shortNumber.format(19634, 'es', { significantDigits: 1 });
// 19,6K

this.shortNumber.format(101, 'en', { significantDigits: 1, useShorterFormat: true });
// 0.1M

• Note when using significantDigits, this addon utilizes toLocaleString.

Contributing

Installation

• git clone [e-mail]:snewcomer/ember-short-number.git
• cd ember-short-number
• npm install

Linting

• npm run lint:js
• npm run lint:js -- --fix

Running tests

• ember test – Runs the test suite on the current Ember version
• ember test --server – Runs the test suite in "watch mode"
• ember try:each – Runs the test suite against multiple Ember versions

Running the dummy application

• ember serve
• Visit the dummy application at http://localhost:4200.

For more information on using ember-cli, visit https://ember-cli.com/.

License

This project is licensed under the MIT License.