Docebo libraries documentation site
vdevelop
Get Started
Guides
Overview Icons Illustrations Theme
Components
Accordion Avatar Badge Alert Badge Icon Badge Status Blank Slate Button Calendar Card Carousel Chip Data Browser Expandable Content Facet List
Filters
Filter Filter Container Filter Multiple Selection Filter Single Selection Filter Slider Range Selection Filter Slider Selection
Helper Message Icon Illustration
Inputs
Input Autocomplete Input Checkbox Input Checkbox Group Input Combobox Input Date Input Password Input Radio Group Input Rating Input Search Input Select Input Slider Input Text Input Toggle Input Upload
Link List List Listbox List Navigation List Presentation List Sheet List Tablist List Tree Menu Modal Dialog Navigation Notification Pagination Bar Popover Progress Skeleton Stepper Table Toast Tooltip
API References
@elemental/common / Function

translate

Returns a Signal containing the always-updated translation of the given phrase. The translation is re-calculated whenever:

  • A new translation is provided via the addTranslations function
  • The replacements change (if their value is represented by a Signal)
  • The language changes
  • The global label replacements change

Presentation

function translate(
  module: string,
  phrase: string,
  replacements: LmnLabelReplacements = {},
  variableDelimiters: [string, string] = ["{", "}"],
): Signal<string>;

Returns

Signal<string>

Parameters

NameTypeDescription
module
string

@param module The module containing the phrase to display.

phrase
string

@param phrase The phrase to display.

replacements
LmnLabelReplacements

@param replacements Any replacements to be applied to the translated phrase.

variableDelimiters
[string, string]

@param variableDelimiters The delimiters with which the parts to be replaced are padded in the label. Defaults to { }.