Cldr for Lists

Build Status Deps Status Hex pm License

Introduction and Getting Started

ex_cldr_lists is an addon library for ex_cldr that provides localisation and formatting for lists.

The primary api is Cldr.List.to_string/2. The following examples demonstrate:

iex> Cldr.List.list_pattern_styles_for "en"
[:or, :standard, :standard_short, :unit, :unit_narrow, :unit_short]

iex> Cldr.List.to_string(["a", "b", "c"], locale: "en")
{:ok, "a, b, and c"}

iex> Cldr.List.to_string(["a", "b", "c"], locale: "en", format: :or)
{:ok, "a, b, or c"}

iex> Cldr.List.to_string(["a", "b", "c"], locale: "en", format: :unit)
{:ok, "a, b, c"}

iex> Cldr.List.to_string!(["a", "b", "c"], locale: "en", format: :unit)
"a, b, c"

For help in iex:

iex> h Cldr.List.to_string

Documentation

Primary documentation is as part of the hex documentation for ex_cldr

Installation

Note that :ex_cldr_lists requires Elixir 1.5 or later.

Add ex_cldr_dates_time as a dependency to your mix project:

defp deps do
  [
    {:ex_cldr_lists, "~> 0.3.2"}
  ]
end

then retrieve ex_cldr_lists from hex:

mix deps.get
mix deps.compile