i18next/io.github.sanyavertolet.jswrappers.i18next/I18nConfiguration

I18nConfiguration

@Serializable

Configuration class for i18next initialization.

This class encapsulates all the configuration options available for initializing i18next in a Kotlin/JS environment.

It uses kotlinx-serialization to serialize the configuration into a dynamic object that can be passed to the JavaScript init function.

Properties

appendNamespaceToCIMode

var appendNamespaceToCIMode: String?

Appends the namespace to the key when in CIMode.

appendNamespaceToMissingKey

var appendNamespaceToMissingKey: Boolean

If true, appends the namespace to missing keys.

backend

@Transient

var backend: dynamic

Holds the backend configuration. This is a dynamic field and is not serialized to dynamic with kotlinx-serialization.

cache

@Transient

var cache: dynamic

Holds the cache configuration. This is a dynamic field and is not serialized to dynamic with kotlinx-serialization.

cleanCode

var cleanCode: Boolean

If true, cleans the language code.

contextSeparator

var contextSeparator: String

Separator used for contexts.

debug

var debug: Boolean

Enables debug mode if set to true.

defaultNamespace

@SerialName(value = "defaultNS")

var defaultNamespace: String

Default namespace used if not specified in the translation function.

detection

@Transient

var detection: dynamic

Holds the detection configuration. This is a dynamic field and is not serialized to dynamic with kotlinx-serialization.

fallbackLanguage

@SerialName(value = "fallbackLng")

var fallbackLanguage: String

Fallback language if the specified language is not available. Defaults to "dev".

fallbackNamespaces

@SerialName(value = "fallbackNS")

var fallbackNamespaces: List<String>

List of fallback namespaces.

ignoreJsonStructure

var ignoreJsonStructure: Boolean

If true, ignores the JSON structure when flattening translations.

initImmediate

var initImmediate: Boolean

If false, initialization is delayed until resources are loaded.

interpolation

@Transient

var interpolation: dynamic

Holds the interpolation configuration. This is a dynamic field and is not serialized to dynamic with kotlinx-serialization.

joinArrays

var joinArrays: String?

Specifies how to join arrays in translations.

keySeparator

var keySeparator: String

Separator used for keys.

language

@SerialName(value = "lng")

var language: String?

Specifies the initial language to load.

loadStrategy

@SerialName(value = "load")

var loadStrategy: String

Strategy for loading resources.

lowerCaseLanguageCode

@SerialName(value = "lowerCaseLng")

var lowerCaseLanguageCode: Boolean

If true, language codes are converted to lower case.

maxParallelReads

var maxParallelReads: Int

Maximum number of parallel reads when loading resources.

missingKeyNoValueFallbackToKey

var missingKeyNoValueFallbackToKey: Boolean

If true, falls back to the key if no value is found and the key is missing.

namespaces

@SerialName(value = "ns")

var namespaces: List<String>

List of namespaces to load.

namespaceSeparator

var namespaceSeparator: String

Separator used for namespaces.

nonExplicitSupportedLanguages

var nonExplicitSupportedLanguages: Boolean

If true, non-explicit supported languages are allowed.

partialBundledLanguages

var partialBundledLanguages: Boolean

If true, partially bundles languages.

pluralSeparator

var pluralSeparator: String

Separator used for plurals.

postProcess

var postProcess: List<String>

List of post-processing steps.

preload

var preload: List<String>?

List of languages to preload.

returnDetails

var returnDetails: Boolean

If true, returns detailed information for missing translations.

returnEmptyString

var returnEmptyString: Boolean

If true, returns an empty string for missing translations.

returnNull

var returnNull: Boolean

If true, returns null for missing translations.

returnObjects

var returnObjects: Boolean

If true, returns objects instead of strings for missing translations.

saveMissing

var saveMissing: Boolean

If true, missing keys are sent to the backend.

saveMissingPlurals

var saveMissingPlurals: Boolean

If true, saves missing plurals.

saveMissingTo

var saveMissingTo: String

Specifies where to save missing keys.

skipInterpolation

var skipInterpolation: Boolean

If true, skips interpolation.

supportedLanguages

@SerialName(value = "supportedLngs")

var supportedLanguages: List<String>?

List of supported languages.

updateMissing

var updateMissing: Boolean

If true, updates missing keys.

Functions

getAsDynamic

fun getAsDynamic(): dynamic

Serializes the configuration into a dynamic object suitable for passing to JavaScript.

interpolation

fun I18nConfiguration.interpolation(interpolationBuilder: InterpolationConfiguration.() -> Unit)

Configures the interpolation using InterpolationConfiguration builder.

rawInterpolation

fun rawInterpolation(interpolationObject: dynamic)

Configures the interpolation options using a dynamic builder.

rawResources

fun rawResources(resourcesObject: dynamic)

Configures the resources (translations) using a dynamic object.

resources

fun I18nConfiguration.resources(resourcesBuilder: Resources.() -> Unit)

Configures the resources (translations) using Resources builder.

I18nConfiguration

See also

Properties

Functions