View Source Cldr.LocaleDisplay (Cldr Locale Display v1.5.0)

Implements the CLDR locale display name algorithm to format a t:Cldr.LanguageTag structs for presentation uses.

Summary

Types

display_options()

Functions

display_name(language_tag, options \\ [])

Returns a localised display name for a locale.

display_name!(language_tag, options \\ [])

Returns a localised display name for a locale.

Types

Link to this type

display_options()

View Source 
@type display_options() :: [
  compound_locale: boolean(),
  prefer: atom(),
  locale: Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
  backend: Cldr.backend()
]

Functions

Link to this function

display_name(language_tag, options \\ [])

View Source 
@spec display_name(Cldr.Locale.locale_reference(), display_options()) ::
  {:ok, String.t()} | {:error, {module(), String.t()}}

Returns a localised display name for a locale.

UI applications often have a requirement to present locale choices to an end user.

This function takes a t.Cldr.LanguageTag and using the CLDR locale display name algorithm produces a string suitable for presentation.

Arguments

  • language_tag is any t:Cldr.LanguageTag or a locale name as an atom or string.

  • options is a keyword list of options.

Options

  • :compound_locale is a boolean indicating if the combination of language, script and territory should be used to resolve a language name. The default is true.

  • :prefer signals the preferred name for a subtag when there are alternatives. The default is :default. Few subtags provide alternative renderings. Some of the alternative preferences are:short, :long, :menu and :variant.

  • :locale is a t:Cldr.LanguageTag or any valid locale name returned by Cldr.known_locale_names/1.

  • :backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0.

Returns

  • {:ok, string} representing a name suitable for presentation purposes or

  • {:error, {exception, reason}}

Examples 

iex> Cldr.LocaleDisplay.display_name "en"
{:ok, "English"}

iex> Cldr.LocaleDisplay.display_name "en-US"
{:ok, "American English"}

iex> Cldr.LocaleDisplay.display_name "en-US", compound_locale: false
{:ok, "English (United States)"}

iex> Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud"
{:ok, "American English (Gregorian Calendar, Currency: A$)"}

iex> Cldr.LocaleDisplay.display_name "en-US-u-ca-gregory-cu-aud", locale: "fr"
{:ok, "anglais américain (calendrier grégorien, devise : A$)"}

iex> Cldr.LocaleDisplay.display_name "nl-BE"
{:ok, "Flemish"}

iex> Cldr.LocaleDisplay.display_name "nl-BE", compound_locale: false
{:ok, "Dutch (Belgium)"}
Link to this function

display_name!(language_tag, options \\ [])

View Source 
@spec display_name!(Cldr.Locale.locale_reference(), display_options()) ::
  String.t() | no_return()

Returns a localised display name for a locale.

UI applications often have a requirement to present locale choices to an end user.

This function takes a t.Cldr.LanguageTag and using the CLDR locale display name algorithm produces a string suitable for presentation.

Arguments

  • language_tag is any t:Cldr.LanguageTag or a locale name as an atom or string.

  • options is a keyword list of options.

Options

  • :compound_locale is a boolean indicating if the combination of language, script and territory should be used to resolve a language name. The default is true.

  • :prefer signals the preferred name for a subtag when there are alternatives. The default is :default. Few subtags provide alternative renderings. Some of the alternative preferences are:short, :long, :menu and :variant.

  • :locale is a t:Cldr.LanguageTag or any valid locale name returned by Cldr.known_locale_names/1.

  • :backend is any module that includes use Cldr and therefore is a Cldr backend module. The default is Cldr.default_backend!/0.

Returns

  • a string representation of the language tag suitable for presentation purposes or

  • raises an exception.

Examples 

iex> Cldr.LocaleDisplay.display_name! "en"
"English"

iex> Cldr.LocaleDisplay.display_name! "en-US"
"American English"

iex> Cldr.LocaleDisplay.display_name! "en-US", compound_locale: false
"English (United States)"

iex> Cldr.LocaleDisplay.display_name! "en-US-u-ca-gregory-cu-aud"
"American English (Gregorian Calendar, Currency: A$)"

iex> Cldr.LocaleDisplay.display_name! "en-US-u-ca-gregory-cu-aud", locale: "fr"
"anglais américain (calendrier grégorien, devise : A$)"