langSelector: Language selector

Description Usage Arguments Value Available languages Default fallbacks Examples

View source: R/modules.R

Description

This Shiny module gets language that's currently selected in the language selector. It needs to be used in the Server to save the currently active (selected) language in a reactive. This reactive can then be passed to the i_ function to translate the text.

Usage

1
langSelector(input, output, session, i18n = NULL, showSelector = TRUE)

Arguments

i18n

List of language configurations; can only be set for i_. Options that can be set are:

defaultLang Default language used in Shiny app; default = "en"

availableLangs Language that can be chosen for translation in Shiny app; there are currently 15 Available languages (see below); defaults to all.

localeDir Directory to yaml files which contain custom keyword translations; default = "locale"

fallbacks List of fallback languages if translation for a word is not found in desired language; defaults to Default fallbacks (see below)

queryParameter String to define query parameter if language to be set through URL; default = "lang"

showSelector

Boolean to specify if language selector should be displayed or not. Even if selector is not displayed, language can always be set by query parameter; default = "lang"

Value

String of language code of currently selected languages.

Available languages

There are currently 15 languages available for translation:

code language
ar Arabic
ca Catalan
da Danish
de German
en English
es Spanish
fr French
he Hebrew
hi Hindi
it Italian
pt Portuguese
pt_BR Portuguese (Brazil)
ru Russian
sv Swedish
zh_CN Chinese

Default fallbacks

If no fallback languages are specified, translations automatically fall back onto the following languages.

original language fallback language
es pt
pt es
fr pt
de nl
nl de

Examples

1
2
3
4
5
6
7
8
## Not run: 
i18n <- list(
  defaultLang = "en",
  availableLangs = c("en", "de")
)
lang <- callModule(langSelector,"lang", i18n = i18n, showSelector = TRUE)

## End(Not run)

jpmarindiaz/shi18ny documentation built on March 31, 2021, 5:15 p.m.