@localizer

Appearance

Configuration
@localizer/core 1.0.1
​

Use the configure() method to customize @localizer behavior. Apply configuration early, preferably in the application shell, for consistent behavior throughout the app lifecycle.

The configure() method offers maximum flexibility by accepting two arguments: an array of configuration domains and a corresponding configuration object. The domains specify the library components to configure, while the configuration object defines their respective settings.

typescript
import { configure, Core } from '@localizer/core';

const configuration = {
  Core: {
    fallbackLocales: ['fi', 'en'];
  },
}

configure({ Core }, configuration);

This approach centralizes configuration in a single location while providing the flexibility to selectively configure specific domains as needed.

When only one single domain needs to be configured, it is possible to use simpler notation:

typescript
import { configure, Core } from '@localizer/core';

configure(Core, { fallbackLocales: ['fi', 'en'] });

WARNING

Configurations are globally managed as singleton objects stored in globalThis.$Localizer. To ensure consistent behavior, initialize configurations as early as possible in the application lifecycle. Avoid modifying configuration properties at runtime unless explicitly supported and documented, as doing so may result in unpredictable behavior.

Below is a list of configuration domains that can be customized using the configure() method. Each domain corresponds to a specific aspect of the library, enabling fine-grained control over its behavior.

Core
@localizer/core 1.0.1
​

This is the basic configuration for @localizer. Below are the key configuration properties available:

typescript
configure(
  { Core },
  {
    Core: {
      fallbackLocales: ['en'],
      activeLocale: undefined,
    },
  },
);

fallbackLocales ​

Defines fallback locales used when a translation is missing. See the locale resolution process for details.

Type: LocaleCode[]

Default: ['en']

activeLocale
experimental
​

Enables implicit localization by setting the current locale. If undefined, implicit localization is disabled.

Type: LocaleCode | undefined

Default: undefined

TIP

You can dynamically change the active locale at runtime using the setActiveLocale() method:

typescript
import { setActiveLocale } from '@localizer/core';

setActiveLocale('en');

DefaultFormatters
@localizer/format 1.0.1
​

This configuration allows to change the default behavior of autoFormat formatter:

typescript
configure(
  { DefaultFormatters },
  {
    DefaultFormatters: {
      number: decimal,
      date: date,
      array: list,
      boolean: stringify,
      string: stringify,
      default: stringify,
    },
  },
);

number ​

Specifies the formatter to use for number and bigint values.

Type: ValueFormatter<number | bigint>

Default: decimal

date ​

Specifies the formatter to use for Date values.

Type: ValueFormatter<Date>

Default: date

array ​

Specifies the formatter to use for arrays.

Type: ValueFormatter<Localizable[]>

Default: list

boolean ​

Specifies the formatter to use for boolean values.

Type: ValueFormatter<boolean>

Default: stringify

string ​

Specifies the formatter to use for string values.

Type: ValueFormatter<string>

Default: stringify

default ​

Specifies the formatter to use for all other values.

Type: ValueFormatter<boolean>

Default: stringify