Class UmbLocalizationController<LocalizationSetType>

constructor

• new UmbLocalizationController<
      LocalizationSetType extends UmbLocalizationSetBase = UmbLocalizationSet,
  >(
      host: UmbControllerHost,
  ): UmbLocalizationController<LocalizationSetType>

  Type Parameters

  • LocalizationSetType extends UmbLocalizationSetBase = UmbLocalizationSet

  Parameters

  • host: UmbControllerHost

  Returns UmbLocalizationController<LocalizationSetType>

ReadonlycontrollerAlias

date

• date(dateToFormat: string | Date, options?: DateTimeFormatOptions): string

  Outputs a localized date in the specified format.

  Parameters

  • dateToFormat: string | Date

    the date to format.

  • Optionaloptions: DateTimeFormatOptions

    the options to use when formatting the date.

  Returns string

destroy

• destroy(): void

  Returns void

dir

• dir(): string

  Gets the host element's directionality as determined by the dir attribute. The return value is transformed to lowercase.

  Returns string

  • the directionality.

documentUpdate

• documentUpdate(): void

  Returns void

duration

• duration(fromDate: string | Date, toDate?: string | Date, options?: any): string

  Outputs a localized compounded time in a duration format.

  Parameters

  • fromDate: string | Date

    the date to compare from.

  • OptionaltoDate: string | Date

    the date to compare to, usually the current date (default: current date).

  • Optionaloptions: any

    the options to use when formatting the time.

  Returns string

  • the formatted time, example: "2 days, 3 hours, 5 minutes"

  Example

  "2 days, 3 hours and 5 minutes"
  Copy

hostConnected

• hostConnected(): void

  Returns void

hostDisconnected

• hostDisconnected(): void

  Returns void

keysChanged

• keysChanged(changedKeys: Set<UmbLocalizationSetKey>): void

  Parameters

  • changedKeys: Set<UmbLocalizationSetKey>

  Returns void

lang

• lang(): string

  Gets the host element's language as determined by the lang attribute. The return value is transformed to lowercase.

  Returns string

  • the language code.

list

• list(values: Iterable<string>, options?: ListFormatOptions): string

  Outputs a localized list of values in the specified format.

  Parameters

  • values: Iterable<string>

    the values to format.

  • Optionaloptions: ListFormatOptions

    the options to use when formatting the list.

  Returns string

  • the formatted list.

  Example

  "one, two, and three"
  Copy

number

• number(numberToFormat: string | number, options?: NumberFormatOptions): string

  Outputs a localized number in the specified format.

  Parameters

  • numberToFormat: string | number

    the number or string to format.

  • Optionaloptions: NumberFormatOptions

    the options to use when formatting the number.

  Returns string

  • the formatted number.

relativeTime

• relativeTime(
      value: number,
      unit: RelativeTimeFormatUnit,
      options?: RelativeTimeFormatOptions,
  ): string

  Outputs a localized time in relative format.

  Parameters

  • value: number

    the value to format.

  • unit: RelativeTimeFormatUnit

    the unit of time to format.

  • Optionaloptions: RelativeTimeFormatOptions

    the options to use when formatting the time.

  Returns string

  • the formatted time.

  Example

  "in 2 days"
  Copy

string

• string(text: undefined | string, ...args: unknown[]): string

  Translates a string containing one or more terms. The terms should be prefixed with a # character. If the term is found in the localization set, it will be replaced with the localized term. If the term is not found, the original term will be returned.

  Parameters

  • text: undefined | string

    The text to translate.

  • ...args: unknown[]

    The arguments to parse for this localization entry.

  Returns string

  The translated text.

term

• term<K extends string | number | symbol>(
      key: K,
      ...args: FunctionParams<LocalizationSetType[K]>,
  ): string

  Outputs a translated term.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    the localization key, the indicator of what localization entry you want to retrieve.

  • ...args: FunctionParams<LocalizationSetType[K]>

    the arguments to parse for this localization entry.

  Returns string

  • the translated term as a string.

  Example

  Retrieving a term without any arguments:

  this.localize.term('area_term');
  Copy

  Retrieving a term with arguments:

  this.localize.term('general_greeting', ['John']);
  Copy

termOrDefault

• termOrDefault<K extends string | number | symbol, D extends null | string>(
      key: K,
      defaultValue: D,
      ...args: FunctionParams<LocalizationSetType[K]>,
  ): string | D

  Returns the localized term for the given key, or the default value if not found. This method follows the same resolution order as term() (primary → secondary → fallback), but returns the provided defaultValue instead of the key when no translation is found.

  Type Parameters

  • K extends string | number | symbol
  • D extends null | string

  Parameters

  • key: K

    the localization key, the indicator of what localization entry you want to retrieve.

  • defaultValue: D

    the value to return if the key is not found in any localization set.

  • ...args: FunctionParams<LocalizationSetType[K]>

    the arguments to parse for this localization entry.

  Returns string | D

  • the translated term or the default value.

  Example

  Retrieving a term with fallback:

  this.localize.termOrDefault('general_close', 'X');
  Copy

  Retrieving a term with fallback and arguments:

  this.localize.termOrDefault('general_greeting', 'Hello!', userName);
  Copy

  Retrieving a term with null as fallback:

  this.localize.termOrDefault('general_close', null);
  Copy