Cldr Lists v1.2.0 Cldr.List View Source

Cldr incudes patterns that enable list to be catenated together to form a grammatically correct language construct for a given locale.

If we have a list of days like ["Monday", "Tuesday", "Wednesday"] then we can format that list for a given locale by:

iex> Cldr.List.to_string(["Monday", "Tuesday", "Wednesday"], locale: "en")
{:ok, "Monday, Tuesday, and Wednesday"}

Link to this section Summary

Functions

Returns the styles of list patterns available for a locale

Returns the list patterns for a locale

Formats a list using to_string/2 but raises if there is an error

Formats a list into a string according to the list pattern rules for a locale

Link to this section Types

Link to this type pattern_type() View Source
pattern_type() :: :or | :standard | :unit | :unit_narrow | :unit_short

Link to this section Functions

Link to this function list_pattern_styles_for(binary) View Source
list_pattern_styles_for(Cldr.locale()) :: [atom()]

Returns the styles of list patterns available for a locale.

Returns a list of atoms of of the list format styles that are available in CLDR for a locale.

Example

iex> Cldr.List.list_pattern_styles_for("en")
[:or, :or_narrow, :or_short, :standard, :standard_narrow, :standard_short, :unit, :unit_narrow, :unit_short]
Link to this function list_patterns_for(binary) View Source
list_patterns_for(Cldr.locale()) :: Map.t()

Returns the list patterns for a locale.

List patterns provide rules for combining multiple items into a language format appropriate for a locale.

Example

iex> Cldr.List.list_patterns_for "en"
%{
  or: %{
    "2": [0, " or ", 1],
    end: [0, ", or ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  or_narrow: %{
    "2": [0, " or ", 1],
    end: [0, ", or ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  or_short: %{
    "2": [0, " or ", 1],
    end: [0, ", or ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  standard: %{
    "2": [0, " and ", 1],
    end: [0, ", and ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  standard_narrow: %{
    "2": [0, " and ", 1],
    end: [0, ", and ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  standard_short: %{
    "2": [0, " and ", 1],
    end: [0, ", and ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  unit: %{
    "2": [0, ", ", 1],
    end: [0, ", ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  },
  unit_narrow: %{
    "2": [0, " ", 1],
    end: [0, " ", 1],
    middle: [0, " ", 1],
    start: [0, " ", 1]
  },
  unit_short: %{
    "2": [0, ", ", 1],
    end: [0, ", ", 1],
    middle: [0, ", ", 1],
    start: [0, ", ", 1]
  }
}
Link to this function to_string!(list, options \\ []) View Source
to_string!(List.t(), Keyword.t()) :: String.t() | Exception.t()

Formats a list using to_string/2 but raises if there is an error.

Examples

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

iex> Cldr.List.to_string!(["a", "b", "c"], locale: "en", format: :unit_narrow)
"a b c"
Link to this function to_string(list, options \\ []) View Source
to_string(List.t(), Keyword.t()) ::
  {:ok, String.t()} | {:error, {atom(), binary()}}

Formats a list into a string according to the list pattern rules for a locale.

  • list is any list of of terms that can be passed through Kernel.to_string/1

  • options are:

    • locale is any configured locale. See Cldr.known_locales(). The default is locale: Cldr.get_current_locale/0

    • format is one of those returned by Cldr.List.list_pattern_types_for/1. The default is format: :standard

Examples

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: :unit_narrow)
{:ok, "a b c"}

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

iex> Cldr.List.to_string([1,2,3,4,5,6])
{:ok, "1, 2, 3, 4, 5, and 6"}

iex> Cldr.List.to_string(["a"])
{:ok, "a"}

iex> Cldr.List.to_string([1,2])
{:ok, "1 and 2"}