@wix/site-service-locale
v1.0.6
Published
A thin signal-backed service that exposes the current site language, text direction, regional locale, and time zone.
Maintainers
Keywords
Readme
@wix/site-service-locale
A thin signal-backed service that exposes the current site language, text direction, regional locale, and time zone.
Install
yarn add @wix/site-service-localeUsage
import { LocaleDefinition } from '@wix/site-service-locale/definition'
import { LocaleService } from '@wix/site-service-locale/implementations'
createServicesMap().addService(LocaleDefinition, LocaleService, config)
const service = servicesManager.getService(LocaleDefinition)
// getters:
service.language
service.direction
service.locale
service.timeZoneAPI
| Member | Type | Throws when | Description |
|---|---|---|---|
| language | Language | never | Site primary language code (for example en, fr). |
| direction | LanguageDirection | never | Site text direction (ltr or rtl). |
| locale | string | never | BCP-47 locale used for regional formatting (for example en-US, de-CH). |
| timeZone | string | never | IANA time zone of the site's business (for example America/New_York, Europe/Zurich). |
| _updateConfig | (Partial<ILocaleServiceConfig>) => void | never | Private replace-on-write updater for provided fields. |
Configuration
ILocaleServiceConfig:
type ILocaleServiceConfig = {
language: Language
direction: LanguageDirection
locale: string
timeZone: string
}Reactivity
This service is a thin signal wrapper over @wix/services-definitions/core-services/signals. Every property is signal-backed under the hood; wrap reads in effect / computed to react to changes. Signals are not exposed directly.
