Referencei18n

resolveTranslation

Translate a key with the params its English default requires

Import

import { resolveTranslation } from "@videojs/react/i18n";

resolveTranslation calls a translator from createTranslator with a key and its params. Unlike calling the translator directly with a variable key, its type requires the params that key’s English default interpolates, such as seconds for seek.forward.

import { createTranslator, getI18nTranslations, resolveTranslation } from '@videojs/react/i18n';

const t = createTranslator(getI18nTranslations('fr'), 'fr');

resolveTranslation(t, 'buttons.play');
resolveTranslation(t, 'seek.forward', { seconds: 10 });

API Reference

resolveTranslation<Key extends string>(translator, key, ...args): string

Parameters

Parameter	Type	Default
`translator*`	`object`	—
Description Translator from `createTranslator`. Type `{ <Key extends string>(key: Key, ...args: Key extends TranslationKey ? TranslationParams[Key] extends never ? [params?: TranslationOptions] : [params: TranslationParams[Key] & TranslationOptions] : [params?: TextParams & TranslationOptions]): string; (text: Text, params?: TextParams): string }`
`key*`	`Key`	—
Description Translation key, such as `seek.forward`.
`args`	`Key extends TranslationKey ? Translat...`	—
Description The key's template params, plus an optional `default` string. Type `Key extends TranslationKey ? TranslationParams[Key] extends never ? [params?: TranslationOptions] : [params: TranslationParams[Key] & TranslationOptions] : [params?: Record<string, string \| number> & TranslationOptions]`

Return Value

string