Provides script name localization functions built on the Unicode CLDR repository.
Script display names are loaded on demand from the locale data provider. Each locale provides localized names for script codes in one or more styles.
Styles
Script display names come in several styles:
:standard— the default form, suitable for combining with a language name in a locale pattern (e.g., "Simplified").:short— a shorter form when available (e.g., "UCAS" instead of "Unified Canadian Aboriginal Syllabics"). Falls back to:standardwhen unavailable.:stand_alone— a stand-alone form when the script name differs from its combined form (e.g., "Simplified Han" instead of "Simplified"). Falls back to:standardwhen unavailable.:variant— an alternative variant name (e.g., "Perso-Arabic" instead of "Arabic"). Falls back to:standardwhen unavailable.
Summary
Functions
Returns the list of script codes for which a locale has display names.
Returns the localized display name for a script code.
Same as display_name/2 but raises on error.
Returns a map of script codes to their localized names in a locale.
Returns a map of script codes to their localized names in a locale.
Returns a sorted list of script codes that have localized names in a locale.
Functions
@spec available_scripts(Keyword.t()) :: {:ok, [atom()]} | {:error, Exception.t()}
Returns the list of script codes for which a locale has display names.
Deprecated — use scripts_for/1 instead.
@spec display_name(atom() | String.t(), Keyword.t()) :: {:ok, String.t()} | {:error, Exception.t()}
Returns the localized display name for a script code.
Arguments
scriptis a script code atom or string (e.g.,:Latn,"Cyrl").optionsis a keyword list of options.
Options
:localeis a locale identifier. The default isLocalize.get_locale().:styleis one of:standard,:short,:stand_alone, or:variant. The default is:standard. If the requested style is not available for a script, falls back to:standard.:fallbackis a boolean. Whentrueand the script is not found in the specified locale, falls back to the default locale. The default isfalse.
Returns
{:ok, name}wherenameis the localized script name.{:error, exception}if the script code is not found in the locale.
Examples
iex> Localize.Script.display_name(:Latn)
{:ok, "Latin"}
iex> Localize.Script.display_name("Cyrl")
{:ok, "Cyrillic"}
iex> Localize.Script.display_name(:Hans, style: :stand_alone)
{:ok, "Simplified Han"}
iex> Localize.Script.display_name(:Arab, style: :variant)
{:ok, "Perso-Arabic"}Same as display_name/2 but raises on error.
Options
- See
display_name/2for the supported options.
Examples
iex> Localize.Script.display_name!(:Latn)
"Latin"
iex> Localize.Script.display_name!(:Hans, style: :stand_alone)
"Simplified Han"@spec known_scripts(Keyword.t()) :: {:ok, %{required(atom()) => map()}} | {:error, Exception.t()}
Returns a map of script codes to their localized names in a locale.
Deprecated — use script_names_for/1 instead.
@spec script_names_for(Keyword.t()) :: {:ok, %{required(atom()) => map()}} | {:error, Exception.t()}
Returns a map of script codes to their localized names in a locale.
Arguments
optionsis a keyword list of options.
Options
:localeis a locale identifier. The default isLocalize.get_locale().
Returns
{:ok, scripts_map}wherescripts_mapis a map of%{script_atom => %{standard: name, ...}}.{:error, exception}if the locale data cannot be loaded.
Examples
iex> {:ok, scripts} = Localize.Script.script_names_for()
iex> scripts[:Latn]
%{standard: "Latin"}@spec scripts_for(Keyword.t()) :: {:ok, [atom()]} | {:error, Exception.t()}
Returns a sorted list of script codes that have localized names in a locale.
Arguments
optionsis a keyword list of options.
Options
:localeis a locale identifier. The default isLocalize.get_locale().
Returns
{:ok, codes}wherecodesis a sorted list of script code atoms.{:error, exception}if the locale data cannot be loaded.
Examples
iex> {:ok, codes} = Localize.Script.scripts_for()
iex> :Latn in codes
true