cuducos/elm-format-number

Format numbers as pretty strings


Keywords
elm, format, i18n, numbers
License
BSD-3-Clause
Install
elm-package install cuducos/elm-format-number 5.0.2

Contributors

Eduardo Cuducos Ophir LOJKINE Pedro Calderon Plínio Balduino Rogério Chaves Peter Gao


See all contributors


Documentation

Elm Format Number Build Status

This simple Elm package formats float numbers as pretty strings:

import FormatNumber exposing (format)
import FormatNumber.Locales exposing (spanishLocale, usLocale)

format usLocale (pi * 1000)  -- "3,141.59"
format spanishLocale (pi * 1000)  -- "3.141,59"

It is flexible enough to deal with different number of decimals, different thousand separators, diffetent decimal separator, and different ways to represent negative numbers — all that is possible using Locales.

Elm Format Number has a couple os predefined Locales and it is easy to customize your own:

import FormatNumber exposing (format)
import FormatNumber.Locales exposing (Locale, usLocale)

sharesLocale : Locale
sharesLocale =
    { usLocale
        | decimals = 3
        , negativePrefix = "("
        , negativeSuffix = ")"
    }

format usLocale -pi -- "−3.14"
format sharesLocale -pi -- "(3.142)"

The API is further documented in package.elm-lang.org.

Tests

This package uses elm-verify-examples, all the exemples in the documentation are automatically tested:

$ npm install
$ npm test