Interface SolutionLocalizationApi

interface SolutionLocalizationApi {
    getLocalizationBundle(): undefined | SolutionLocalizationBundle;
    getLocalizedResource(resourceKey: string): undefined | string;
    isEnabled(): boolean;
    localize(str: string, resourceKey?: string): string;
    localizeList<T>(list: T[], getProps: ((obj: T) => Record<string, undefined | string>)): T[];
    localizeObject<T>(obj: T, props: Record<string, undefined | string>): T;
}

Index

Methods

getLocalizationBundle getLocalizedResource isEnabled localize localizeList localizeObject

Methods

getLocalizationBundle

getLocalizationBundle(): undefined | SolutionLocalizationBundle
if isEnabled, returns the SolutionLocalizationBundle used to lookup translations.

Returns undefined | SolutionLocalizationBundle

getLocalizedResource

getLocalizedResource(resourceKey): undefined | string
returns the localized value for the given resource key, else, undefined.
Parameters
- resourceKey: string
Returns undefined | string

isEnabled

isEnabled(): boolean
returns true if solution localization is enabled. methods will return unmodified inputs if not enabled. note that solution localization is disabled in the administration application.

Returns boolean

localize

localize(str, resourceKey?): string
localize a string using a resourceKey. fallback to lookup by value if the resourceKey is not supplied/found. mappings are defined by the contents of getLocalizationBundle
Parameters
- str: string
  string to localize
- OptionalresourceKey: string
  a resource key used to lookup the localized value
Returns string
the localized string
Example
```
localize("red", "colours.red.txt") === "rouge"
```

localizeList

localizeList<T>(list, getProps): T[]
localize a list of objects. localizeObject is applied to each element in the list.
Type Parameters
- T extends object
Parameters
- list: T[]
  objects to translate
- getProps: ((obj: T) => Record<string, undefined | string>)
  callback to return a map of properties and resource keys for the given list element
  - - (obj): Record<string, undefined | string>
    - Parameters
      obj: T
      Returns Record<string, undefined | string>
Returns T[]
the localized list
Example
```
localizeList(
     [{ id: "red", label: "Red" }, { id: "blue", label: "Blue"} ],
     (item) => ({ "label": `colours.${item.id}.title` })
 ) === [{ id: "red", label: "Rouge" }, { id: "blue", label: "Bleu"} ]
```

localizeObject

localizeObject<T>(obj, props): T
localize string properties of an object, properties are provided as a map of <propertyKey, resourceKey>, deep property keys are accepted. localize is applied to each property with its given resourceKey.
Type Parameters
- T extends object
Parameters
- obj: T
  source object to localize
- props: Record<string, undefined | string>
  properties to localize and their resource keys
Returns T
the localized object
Example
```
localizeObject({ label: "red" }, { "label": "colours.red.txt" }) === { label: "rouge" }
```