Class IlcIntl

WARNING: this class shouldn't be imported directly in the apps or adapters. Use IlcAppSdk instead.

Hierarchy

IlcIntl

Index

Constructors

constructor

Methods

get getDefault getLocalisationManifestPath getSupported localizeUrl onChange parseUrl set unmount

Constructors

constructor

new IlcIntl(appId: string, adapter?: IntlAdapter, options?: OptionsIntl): IlcIntl
Parameters
- appId: string
- Optional adapter: IntlAdapter
- Optional options: OptionsIntl
Returns IlcIntl
- Defined in app/IlcIntl.ts:15

Methods

get

get(): Required<IntlConfig>
Allows to retrieve current i18n configuration

Returns Required<IntlConfig>
- Defined in app/IlcIntl.ts:30

getDefault

getDefault(): Required<IntlConfig>
Allows to retrieve default i18n configuration

Returns Required<IntlConfig>
- Defined in app/IlcIntl.ts:37

getLocalisationManifestPath

getLocalisationManifestPath(): undefined | string
Get localisation manifest file. File could be accessible optionally. The trick is useful

Returns undefined | string
- Defined in app/IlcIntl.ts:66

getSupported

getSupported(): {
currency: string[];
locale: string[];
}
Allows to fetch all supported values for currency & locale

Returns {
currency: string[];
locale: string[];
}
- currency: string[]
- locale: string[]
- Defined in app/IlcIntl.ts:44

localizeUrl

localizeUrl(url: string, configOverride?: {
locale?: string;
}): string
Allows to convert plain URL into a one that contains i18n information.
Parameters
- url: string
  
  absolute path or absolute URI. Ex: "/test?a=1" or "http://tst.com/"
- configOverride: {
  locale?: string;
  } = {}
  
  allows to override current i18n configuration & retrieve localized URL for desired configuration.
  - Optional locale?: string
Returns string
- Defined in app/IlcIntl.ts:76

onChange

onChange<T>(prepareForChange: ((event: IntlUpdateEvent) => T | Promise<T>), performChange: ((event: IntlUpdateEvent, preparedData: T) => void | Promise<void>)): (() => void)
[CSR ONLY] Allows to watch changes to locale or currency that are happening at the client side.

Returns
- callback that can be used to unsubscribe from changes
Type Parameters
- T
Parameters
- prepareForChange: ((event: IntlUpdateEvent) => T | Promise<T>)
  - - (event: IntlUpdateEvent): T | Promise<T>
    - Parameters
      
      event: IntlUpdateEvent
      
      Returns T | Promise<T>
- performChange: ((event: IntlUpdateEvent, preparedData: T) => void | Promise<void>)
  - - (event: IntlUpdateEvent, preparedData: T): void | Promise<void>
    - Parameters
      
      event: IntlUpdateEvent
      
      preparedData: T
      
      Returns void | Promise<void>
Returns (() => void)
- - (): void
  - Returns void
- Defined in app/IlcIntl.ts:95

parseUrl

parseUrl(url: string): {
cleanUrl: string;
locale: string;
}
Allows to parse URL and receive "non-localized" URL and information about locale that was encoded in URL.
Parameters
- url: string
  
  absolute path or absolute URI. Ex: "/test?a=1" or "http://tst.com/"
Returns {
cleanUrl: string;
locale: string;
}
- cleanUrl: string
- locale: string
- Defined in app/IlcIntl.ts:85

set

set(config: IntlConfig): void
Changes locale or currency for the whole page
Parameters
- config: IntlConfig
Returns void
- Defined in app/IlcIntl.ts:53

unmount

unmount(): void
[CSR ONLY] In apps that are running under ILC it shouldn't be used directly.

Returns void
- Defined in app/IlcIntl.ts:128

Class IlcIntl

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

appId: string

Optional adapter: IntlAdapter

Optional options: OptionsIntl

Returns IlcIntl

Methods

get

Returns Required<IntlConfig>

getDefault

Returns Required<IntlConfig>

getLocalisationManifestPath

Returns undefined | string

getSupported

Returns { currency: string[]; locale: string[]; }

currency: string[]

locale: string[]

localizeUrl

Parameters

url: string

configOverride: { locale?: string; } = {}

Optional locale?: string

Returns string

onChange

Returns

Type Parameters

T

Parameters

prepareForChange: ((event: IntlUpdateEvent) => T | Promise<T>)

Parameters

event: IntlUpdateEvent

Returns T | Promise<T>

performChange: ((event: IntlUpdateEvent, preparedData: T) => void | Promise<void>)

Parameters

event: IntlUpdateEvent

preparedData: T

Returns void | Promise<void>

Returns (() => void)

Returns void

parseUrl

Parameters

url: string

Returns { cleanUrl: string; locale: string; }

cleanUrl: string

locale: string

set

Parameters

config: IntlConfig

Returns void

unmount

Returns void

Settings

Member Visibility

Theme

`Optional` adapter: IntlAdapter

`Optional` options: OptionsIntl

Returns {
currency: string[];
locale: string[];
}

configOverride: {
locale?: string;
} = {}

`Optional` locale?: string

Returns {
cleanUrl: string;
locale: string;
}