l10n

Namespace for localization-related functionality in the extension API. To use this properly, you must have l10n defined in your extension manifest and have bundle.l10n..json files. For more information on how to generate bundle.l10n..json files, check out the vscode-l10n repo.

Note: Built-in extensions (for example, Git, TypeScript Language Features, GitHub Authentication) are excluded from the l10n property requirement. In other words, they do not need to specify a l10n in the extension manifest because their translated strings come from Language Packs.

Online Documentation

Types

TOptions

interface TOptions

Properties

bundle

val bundle: ReadonlyRecord<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for JsString>?

The bundle of localized strings that have been loaded for the extension. It's undefined if no bundle has been loaded. The bundle is typically not loaded if there was no bundle found or when we are running with the default language.

uri

val uri: Uri?

The URI of the localization bundle that has been loaded for the extension. It's undefined if no bundle has been loaded. The bundle is typically not loaded if there was no bundle found or when we are running with the default language.

Functions

fun t(options: l10n.TOptions): String

Marks a string for localization. If a localized bundle is available for the language specified by env.language and the bundle has a localized value for this message, then that localized value will be returned (with injected args values for any templated values).

fun t(message: String, args: ReadonlyRecord<ERROR CLASS: Symbol not found for JsString, ERROR CLASS: Symbol not found for JsString??>): String

fun t(message: String, vararg args: ERROR CLASS: Symbol not found for JsAny): String