- [`init`](#init) - [`getLocaleFromHostname`](#getlocalefromhostname) - [`getLocaleFromPathname`](#getlocalefrompathname) - [`getLocaleFromNavigator`](#getlocalefromnavigator) - [`getLocaleFromQueryString`](#getlocalefromquerystring) - [`getLocaleFromHash`](#getlocalefromhash) - [`addMessages`](#addmessages) - [`register`](#register) - [`waitLocale`](#waitlocale) - [`getDateFormatter`/`getTimeFormatter`/`getNumberFormatter`](#getdateformattergettimeformattergetnumberformatter) - [`getMessageFormatter`](#getmessageformatter) #### `init` > `import { init } from 'svelte-i18n'` `init(options: InitOptions): void` Method responsible for configuring some of the library behaviours such as the global fallback and initial locales. Must be called before setting a locale and displaying your view. ```ts interface InitOptions { /** The global fallback locale **/ fallbackLocale: string; /** The app initial locale **/ initialLocale?: string | null; /** Custom time/date/number formats **/ formats?: Formats; /** Loading delay interval **/ loadingDelay?: number; /** * @deprecated Use `handleMissingMessage` instead. * */ warnOnMissingMessages?: boolean; /** * Optional method that is executed whenever a message is missing. * It may return a string to use as the fallback. */ handleMissingMessage?: MissingKeyHandler; /** * Whether to treat HTML/XML tags as string literal instead of parsing them as tag token. * When this is false we only allow simple tags without any attributes * */ ignoreTag: boolean; } ``` **Example**: ```js import { init } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: 'pt-br', }); ``` ##### Custom formats It's possible to define custom format styles via the `formats` property if you want to quickly pass a set of options to the underlying `Intl` formatter. ```ts interface Formats { number: Record; date: Record; time: Record; } ``` Please refer to the [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/NumberFormat) and [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat) documentations to see available formatting options. **Example**: ```js import { init } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', formats: { number: { EUR: { style: 'currency', currency: 'EUR' }, }, }, }); ``` ```html

{$_.number(123456.789, { format: 'EUR' })}

``` #### `getLocaleFromHostname` > `import { getLocaleFromHostname } from 'svelte-i18n'` `getLocaleFromHostname(hostnamePattern: RegExp): string` Utility method to help getting a initial locale based on a pattern of the current `hostname`. **Example**: ```js import { init, getLocaleFromHostname } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: getLocaleFromHostname(/^(.*?)\./), }); ``` #### `getLocaleFromPathname` > `import { getLocaleFromPathname } from 'svelte-i18n'` `getLocaleFromPathname(pathnamePattern: RegExp): string` Utility method to help getting a initial locale based on a pattern of the current `pathname`. **Example**: ```js import { init, getLocaleFromPathname } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: getLocaleFromPathname(/^\/(.*?)\//), }); ``` #### `getLocaleFromNavigator` > `import { getLocaleFromNavigator } from 'svelte-i18n'` `getLocaleFromNavigator(): string` Utility method to help getting a initial locale based on the browser's `navigator` settings. **Example**: ```js import { init, getLocaleFromNavigator } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: getLocaleFromNavigator(), }); ``` #### `getLocaleFromQueryString` > `import { getLocaleFromQueryString } from 'svelte-i18n'` `getLocaleFromQueryString(queryKey: string): string` Utility method to help getting a initial locale based on a query string value. ```js import { init, getLocaleFromQueryString } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: getLocaleFromQueryString('lang'), }); ``` #### `getLocaleFromHash` > `import { getLocaleFromHash } from 'svelte-i18n'` `getLocaleFromHash(hashKey: string): string` Utility method to help getting a initial locale based on a hash `{key}={value}` string. **Example**: ```js import { init, getLocaleFromHash } from 'svelte-i18n'; init({ // fallback to en if current locale is not in the dictionary fallbackLocale: 'en', initialLocale: getLocaleFromHash('lang'), }); ``` #### `addMessages` > `import { addMessages } from 'svelte-i18n` `addMessages(locale: string, ...dicts: Dictionary[]): void` Merge one ore more dictionary of messages with the `locale` dictionary. **Example**: ```js addMessages('en', { field_1: 'Name' }) addMessages('en', { field_2: 'Last Name' }) addMessages('pt', { field_1: 'Nome' }) addMessages('pt', { field_2: 'Sobrenome' }) // Results in dictionary { en: { field_1: 'Name', field_2: 'Last Name' }, pt: { field_1: 'Nome', field_2: 'Sobrenome' } } ``` #### `register` > `import { register } from 'svelte-i18n'` `register(locale: string, loader: () => Promise