Packages
ex_cldr_numbers
0.1.0
2.38.3
2.38.2
2.38.1
2.38.0
2.37.0
2.36.0
2.35.2
2.35.1
2.35.0
2.34.1
2.34.0
2.33.6
2.33.5
2.33.4
2.33.3
2.33.2
2.33.1
2.33.0
2.32.4
2.32.3
2.32.2
2.32.1
2.32.0
retired
2.31.3
retired
2.31.2
2.31.1
2.31.0
2.30.1
2.30.0
2.29.0
2.28.0
2.27.3
2.27.2
2.27.1
2.27.0
2.26.0
2.25.2
2.25.1
2.25.0
2.24.0
2.23.3
2.23.2
2.23.1
2.23.0
2.23.0-rc.4
2.23.0-rc.3
2.23.0-rc.2
2.23.0-rc.1
2.23.0-rc.0
2.22.1
2.22.0
2.21.0
2.20.0
2.19.0
2.18.4
2.18.3
2.18.2
2.18.1
2.18.0
2.17.0
2.17.0-rc.1
2.17.0-rc.0
2.16.1
2.16.0
2.16.0-rc.0
2.15.4
2.15.3
2.15.2
2.15.1
2.15.0
2.14.0
2.13.2
2.13.1
2.13.0
2.13.0-rc.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.2
2.7.1
2.7.0
2.6.4
2.6.3
2.6.2
2.6.1
2.6.0
2.5.0
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.0
2.2.0
2.1.1
2.1.0
2.0.0
2.0.0-rc.0
1.6.0
1.5.2
1.5.1
1.5.0
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.1
1.3.0
1.3.0-rc.1
1.3.0-rc.0
retired
1.2.0
1.1.0
1.0.1
1.0.0
1.0.0-rc.0
retired
0.3.3
0.3.2
retired
0.3.1
retired
0.3.0
retired
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Number and currency localization and formatting functions for the Common Locale Data Repository (CLDR).
Current section
Files
Jump to
Current section
Files
ex_cldr_numbers
README.md
README.md
# Number and Currency Localization and Formatting
[](https://hex.pm/packages/ex_cldr_numbers)
[](https://github.com/kipcole9/cldr_numbers/blob/master/LICENSE)
## Introduction and Getting Started
`ex_cldr_numbers` is an addon library application for [ex_cldr](https://hex.pm/packages/ex_cldr) that provides localisation and formatting for numbers and currencies.
The primary api is `Cldr.Number.to_string/2`. The following examples demonstrate:
```elixir
iex> Cldr.Number.to_string 12345
{:ok, "12,345"}
iex> Cldr.Number.to_string 12345, locale: "fr"
{:ok, "12Â 345"}
iex> Cldr.Number.to_string 12345, locale: "fr", currency: "USD"
{:ok, "12Â 345,00Â $US"}
iex> Cldr.Number.to_string 12345, format: "#E0"
{:ok, "1.2345E4"}
```
For help in `iex`:
```elixir
iex> h Cldr.Date.to_string
iex> h Cldr.Time.to_string
iex> h Cldr.DateTime.to_string
iex> h Cldr.DateTime.Relative.to_string
```
## Documentation
Primary documentation is available on [as part of the ex_cldr documentation on hex](https://hexdocs.pm/ex_cldr/3_number_formats.html)
## Known restrictions and limitations
## Installation
Note that `:ex_numbers` requires Elixir 1.5 or later.
Add `ex_cldr_numbers` as a dependency to your `mix` project:
defp deps do
[
{:ex_cldr_numbers, "~> 0.1.0"}
]
end
then retrieve `ex_cldr_numbers` from [hex](https://hex.pm/packages/ex_numbers):
mix deps.get
mix deps.compile