View Source Cldr.HTML.Territory (Cldr HTML v1.6.0)

Implements an HTML Form select specifically localised territory display.

Summary

Types

select_options()
territory()

Territory type passed to a collator for ordering in the select box.

Functions

select(form, field, options \\ [])

Generate an HTML select tag for a territory list that can be used with a Phoenix.HTML.Form.t.

territory_options(options \\ [])

Generate a list of options for a territory list that can be used with Phoenix.HTML.Form.options_for_select/2 or to create a <datalist>.

Types

Link to this type

select_options()

View Source 
@type select_options() :: [
  territories: [atom() | binary(), ...],
  locale: Cldr.Locale.locale_name() | Cldr.LanguageTag.t(),
  collator: function(),
  mapper: (Cldr.Locale.territory_code() -> String.t()),
  backend: module(),
  selected: atom() | binary()
]
Link to this type

territory()

View Source 
@type territory() :: %{
  territory: Cldr.Locale.territory_code(),
  name: String.t(),
  flag: String.t()
}

Territory type passed to a collator for ordering in the select box.

The default collator orders by :name using Elixir standard comparison which is by codepoint and is therefore not Unicode aware.

Functions

Link to this function

select(form, field, options \\ [])

View Source 
@spec select(
  form :: Phoenix.HTML.Form.t(),
  field :: Phoenix.HTML.Form.field(),
  select_options()
) ::
  Phoenix.HTML.safe()
  | {:error, {Cldr.UnknownTerritoryError, binary()}}
  | {:error, {Cldr.UnknownLocaleError, binary()}}

Generate an HTML select tag for a territory list that can be used with a Phoenix.HTML.Form.t.

Arguments

Options

For select options see Phoenix.HTML.Form.options_for_select/2

  • :territories defines the list of territories to be displayed in the the select tag. The list defaults to the territories returned by Cldr.Territory.country_codes/0.

  • :style is the format of the territory name to be used. The options are :standard (the default), :short and :variant. Not all territories have :short or :variant names in which case :standard is used for those territories.

  • :locale defines the locale to be used to localise the description of the territories. The default is the locale returned by Cldr.get_locale/1

  • :backend is any backend module. The default is Cldr.default_backend!/0

  • :collator is a function used to sort the territories in the selection list. It is passed a list of maps where each map represents a territory and has the keys :territory, :name and :flag. See t:territory. The default collator sorts by name_1 < name_2. As a result, default collation sorts by code point which will not return expected results for scripts other than Latin.

  • :mapper is a function that creates the text to be displayed in the select tag for each territory. It is passed the territory definition as a t:territory map containing the keys :territory_code, :name and :flag. The default function is &({&1.flag <> " " <> &1.name, &1.territory_code})

  • :selected identifies the territory that is to be selected by default in the select tag. The default is nil. This is passed unmodified to the form generator.

  • :prompt is a prompt displayed at the top of the select box. This is passed unmodified to the form generator.

Examples

 Cldr.HTML.Territory.select(:my_form, :territory, selected: :AU)

 Cldr.HTML.Territory.select(:my_form, :territory, selected: :AU, locale: "ar")

 Cldr.HTML.Territory.select(:my_form, :territory, territories: [:US, :AU, :JP],
      mapper: &({&1.name, &1.territory_code}))
Link to this function

territory_options(options \\ [])

View Source 
@spec territory_options(select_options()) ::
  [tuple()]
  | {:error, {Cldr.UnknownTerritoryError, binary()}}
  | {:error, {Cldr.UnknownLocaleError, binary()}}

Generate a list of options for a territory list that can be used with Phoenix.HTML.Form.options_for_select/2 or to create a <datalist>.

Arguments

Options

See Cldr.HTML.Territory.select/3 for options.