@ovok/native/language-switcher
Language switcher component, context and hook.
- Stable unknown
- Release candidate since 1.16.1-rc.3
- Development since 1.16.1-dev.2111+9796905
Language switcher component, context and hook.
Import from @ovok/native/language-switcher.
Components
LanguageSwitcher()
function LanguageSwitcher(__namedParameters): Element;List of language options; selectedLanguage marks the active one and onLanguageChange receives the user's choice.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | LanguageSwitcherProps |
Returns
Element
Hooks
useLanguageSwitcher()
function useLanguageSwitcher(): LanguageSwitcherContextType;Returns the selected language and its setter; must be used within a LanguageSwitcher.
Returns
Type Aliases
LanguageSwitcherContextType
type LanguageSwitcherContextType = object;Value of the language switcher context.
Properties
selectedLanguage
selectedLanguage: string;Currently selected language code.
setSelectedLanguage
setSelectedLanguage: (language) => void;Selects the given language.
Parameters
| Parameter | Type |
|---|---|
language | string |
Returns
void
Variables
LanguageSwitcherContext
const LanguageSwitcherContext: Context<LanguageSwitcherContextType | null>;Context holding the selected language and its setter.
Last updated on