vi18n

VI18N

Simple number, currency, type and date formatters based on the Internationalization API.

Requirements

• Intl object (ECMAScript Internationalization API) see the support.
  • You can include the polyfill when supporting older environments.
  • Or use the Financial Times polyfill service at cdn.polyfill.io.

Installation

npm install --save vi18n // or --save-dev

Examples

Creating a locale

import VI18N from 'vi18n';
  
const nl = new VI18N(); // Default locale is Dutch with the Euro as currency
const uk = new VI18N('en-GB', 'GBP');

Number formatting

nl.formatNumber(12.50); // '12,50'
uk.formatNumber(12.50); // '12.50'

Currency formatting

nl.formatCurrency(12.50); // '€ 12,50'
uk.formatCurrency(12.50); // '£12.50'

// In another currency
nl.formatCurrency(12.50, { currency: 'JPY' }); // 'JP¥ 12,50'
uk.formatCurrency(12.50, { currency: 'JPY' }); // '¥12.50'

// Or without decimals
nl.formatCurrency(12.50, { minimumFractionDigits: 0, maximumFractionDigits: 0 }); // '€ 12'
uk.formatCurrency(12.50, { currency: 'JPY', minimumFractionDigits: 0, maximumFractionDigits: 0 }); // '¥12'

Percent formatting

nl.formatPercent(0.75); // '75%'
uk.formatPercent(0.75); // '75%'

Date and time formatting

var date = new Date();

nl.formatDate(date); // '2-9-2015'
uk.formatDate(date); // '02/09/2015'

nl.formatTime(date); // '12:38:09'
uk.formatTime(date); // '12:38:09'

Decimal and thousand separator

nl.getDecimalSeparator();   // ','
nl.getThousandSeparator();  // '.'

Months and days

// Possible representations are 'narrow', 'short' or 'long' (default).

uk.getMonths()          // [ 'January', 'February', 'March', etc. ]
uk.getMonths('short')   // [ 'Jan', 'Feb', 'Mar', etc. ]
uk.getMonths('narrow')  // [ 'J', 'F', 'M', etc. ]

uk.getDays()            // [ 'Sunday', 'Monday', 'Tuesday', etc. ]
uk.getDays('short')     // [ 'Sun', 'Mon', 'Tue', etc. ]
uk.getDays('narrow')    // [ 'S', 'M', 'T', etc. ]

Static methods

// Get locale instances
var dutch = VI18N.getLocale('nl-NL');

// Check for native browser support or the presence of a polyfill.
VI18N.isSupported();

License

MIT © VI Company