@d3plus/locales

International localizations for number, date, and UI labels.

Installing

If using npm, npm install @d3plus/locales. Otherwise, you can download the latest release from GitHub or load from a CDN.

import {*} from "@d3plus/locales";

In a vanilla environment, a d3plus global is exported from the pre-bundled version:

<script src="https://cdn.jsdelivr.net/npm/@d3plus/locales"></script>
<script>
  console.log(d3plus);
</script>

Examples

Live examples can be found on d3plus.org, which includes a collection of example visualizations using @d3plus/react.

API Reference

| Functions | Description | | --- | --- | | findLocale | Converts a 2-letter language code into a full language-region locale string (e.g., "en" to "en-US"). |

| Variables | Description | | --- | --- | | formatLocale | | | locale | | | translateLocale | |

| Interfaces | Description | | --- | --- | | FormatLocaleDefinition | formatLocale | | TimeLocaleDefinition | | | TranslationStrings | |

Functions

findLocale()

findLocale(locale: string): string

Defined in: findLocale.ts:49

Converts a 2-letter language code into a full language-region locale string (e.g., "en" to "en-US").

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | locale | string | A 2-letter language code (e.g., "en", "fr"). |

Returns

string

Variables

formatLocale

const formatLocale: Record<string, FormatLocaleDefinition>

Defined in: dictionaries/formatLocale.ts:17

locale

const locale: Record<string, TimeLocaleDefinition>

Defined in: dictionaries/timeLocale.ts:39

translateLocale

const translateLocale: Record<string, TranslationStrings>

Defined in: dictionaries/translateLocale.ts:21

Interfaces

FormatLocaleDefinition

Defined in: dictionaries/formatLocale.ts:6

Namespace

formatLocale A set of default locale formatters used when assigning suffixes and currency in numbers.

Properties

| Property | Type | Defined in | | ------ | ------ | ------ | | currency | [string, string] | dictionaries/formatLocale.ts:14 | | delimiters | object | dictionaries/formatLocale.ts:10 | | delimiters.decimal | string | dictionaries/formatLocale.ts:12 | | delimiters.thousands | string | dictionaries/formatLocale.ts:11 | | grouping | number[] | dictionaries/formatLocale.ts:9 | | separator? | string | dictionaries/formatLocale.ts:7 | | suffixes | string[] | dictionaries/formatLocale.ts:8 |

TimeLocaleDefinition

Defined in: dictionaries/timeLocale.ts:1

Properties

| Property | Type | Defined in | | ------ | ------ | ------ | | date | string | dictionaries/timeLocale.ts:3 | | dateTime | string | dictionaries/timeLocale.ts:2 | | days | [string, string, string, string, string, string, string] | dictionaries/timeLocale.ts:7 | | months | [string, string, string, string, string, string, string, string, string, string, string, string] | dictionaries/timeLocale.ts:9 | | periods | [string, string] | dictionaries/timeLocale.ts:6 | | quarter | string | dictionaries/timeLocale.ts:5 | | shortDays | [string, string, string, string, string, string, string] | dictionaries/timeLocale.ts:8 | | shortMonths | [string, string, string, string, string, string, string, string, string, string, string, string] | dictionaries/timeLocale.ts:23 | | time | string | dictionaries/timeLocale.ts:4 |

TranslationStrings

Defined in: dictionaries/translateLocale.ts:1

Properties

| Property | Type | Defined in | | ------ | ------ | ------ | | and | string | dictionaries/translateLocale.ts:2 | | Back | string | dictionaries/translateLocale.ts:3 | | Click to Expand | string | dictionaries/translateLocale.ts:4 | | Click to Hide | string | dictionaries/translateLocale.ts:5 | | Click to Highlight | string | dictionaries/translateLocale.ts:6 | | Click to Show | string | dictionaries/translateLocale.ts:7 | | Click to Show All | string | dictionaries/translateLocale.ts:8 | | Download | string | dictionaries/translateLocale.ts:9 | | Loading Visualization | string | dictionaries/translateLocale.ts:10 | | more | string | dictionaries/translateLocale.ts:11 | | No Data Available | string | dictionaries/translateLocale.ts:12 | | Powered by D3plus | string | dictionaries/translateLocale.ts:13 | | Share | string | dictionaries/translateLocale.ts:14 | | Shift+Click to Hide | string | dictionaries/translateLocale.ts:15 | | Shift+Click to Highlight | string | dictionaries/translateLocale.ts:16 | | Total | string | dictionaries/translateLocale.ts:17 | | Values | string | dictionaries/translateLocale.ts:18 |