Referencei18n

createTranslator

Build a typed translator from a resolved translation map

Import

import { createTranslator } from "@videojs/html/i18n";

createTranslator wraps the flat map returned by getI18nTranslations and returns a typed translator. Providers call this internally after merging registry, lazy-loaded built-in packs, browser-translated fallback copy, and provider layers. Use it directly for custom UI outside built-in controls.

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

const t = createTranslator(getI18nTranslations('fr'), 'fr');
t('buttons.play', { default: 'Play' });
t('seek.forward', { seconds: 5, default: 'Seek forward {seconds} seconds' });

API Reference

createTranslator(translations, locale): Translator

Parameters

Parameter	Type	Default
`translations*`	`object`	—
Description Merged translation map for the active locale. Type `{ [Key in TranslationKey]?: TranslationParams[Key] extends never ? string : Key extends keyof ParametricTranslations ? ParametricTranslations[Key] : string; } & Record<string, string \| undefined>`
`locale*`	`(typeof LOCALES)[number] \| string & {}`	—
Description BCP 47 tag associated with the map (reserved for future locale-aware behavior).

Return Value

Type Details

object

Type	Details
`object`
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 }`

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 }