Skip to content

feat: support locale prop #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: support locale prop #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"test": "vitest",
"package": "bun --run dlz",
"format": "bun --bun prettier --write . --cache",
"upgrade-examples": "bun scripts/upgrade-examples.ts"
"upgrade-examples": "bun scripts/upgrade-examples.ts",
"generate-locales": "bun scripts/generate-locales.ts"
},
"dependencies": {
"dayjs": "^1.11.13"
Expand Down
20 changes: 20 additions & 0 deletions scripts/generate-locales.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import localeDayjs from "dayjs/locale.json" with { type: "json" };
import { format } from "prettier";

const locales: string[] = [];

for (const { key, name } of localeDayjs) {
if (key === "en") {
locales.unshift(`'${key}'`);
} else {
locales.push(`'${key}'`);
}
}

const localesType = await format(
`/** @default "en" */\nexport type Locales = ${locales.join(" | ")};`,
{ parser: "typescript" },
);
Bun.write("src/locales.d.ts", localesType);

export {};
14 changes: 11 additions & 3 deletions src/Time.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@
* @type {boolean | number}
*/
live = false,

/**
* The locale to use for formatting
* @type {import("./locales").Locales}
*/
locale = "en",
...rest
} = $props();

Expand All @@ -40,7 +46,7 @@
if (relative && live !== false) {
interval = setInterval(
() => {
formatted = dayjs(timestamp).from();
formatted = dayjs(timestamp).locale(locale).from(dayjs());
},
Math.abs(typeof live === "number" ? live : DEFAULT_INTERVAL),
);
Expand All @@ -54,11 +60,13 @@
* @type {string}
*/
let formatted = $state(
relative ? dayjs(timestamp).from() : dayjs(timestamp).format(format),
relative
? dayjs(timestamp).locale(locale).from(dayjs())
: dayjs(timestamp).locale(locale).format(format),
);

const title = $derived(
relative ? dayjs(timestamp).format(format) : undefined,
relative ? dayjs(timestamp).locale(locale).format(format) : undefined,
);
</script>

Expand Down
7 changes: 7 additions & 0 deletions src/Time.svelte.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import type { ConfigType, OptionType } from "dayjs";
import type { Component } from "svelte";
import type { SvelteHTMLElements } from "svelte/elements";
import type { Locales } from "./locales";

type RestProps = SvelteHTMLElements["time"];

Expand Down Expand Up @@ -33,6 +34,12 @@ export interface TimeProps extends RestProps {
*/
live?: boolean | number;

/**
* The locale to use for formatting
* @default "en"
*/
locale?: Locales;

/**
* Formatted timestamp.
* Result of invoking `dayjs().format()`
Expand Down
145 changes: 145 additions & 0 deletions src/locales.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
/** @default "en" */
export type Locales =
| "en"
| "af"
| "am"
| "ar-dz"
| "ar-iq"
| "ar-kw"
| "ar-ly"
| "ar-ma"
| "ar-sa"
| "ar-tn"
| "ar"
| "az"
| "be"
| "bg"
| "bi"
| "bm"
| "bn-bd"
| "bn"
| "bo"
| "br"
| "bs"
| "ca"
| "cs"
| "cv"
| "cy"
| "de-at"
| "da"
| "de-ch"
| "de"
| "dv"
| "el"
| "en-au"
| "en-ca"
| "en-gb"
| "en-ie"
| "en-il"
| "en-in"
| "en-nz"
| "en-sg"
| "en-tt"
| "eo"
| "es-do"
| "es-mx"
| "es-pr"
| "es-us"
| "et"
| "es"
| "eu"
| "fa"
| "fo"
| "fi"
| "fr-ca"
| "fr-ch"
| "fr"
| "fy"
| "ga"
| "gd"
| "gom-latn"
| "gl"
| "gu"
| "he"
| "hi"
| "hr"
| "hu"
| "ht"
| "hy-am"
| "id"
| "is"
| "it-ch"
| "it"
| "ja"
| "jv"
| "ka"
| "kk"
| "km"
| "kn"
| "ko"
| "ku"
| "ky"
| "lb"
| "lo"
| "lt"
| "lv"
| "me"
| "mi"
| "mk"
| "ml"
| "mn"
| "mr"
| "ms-my"
| "ms"
| "mt"
| "my"
| "nb"
| "ne"
| "nl-be"
| "nl"
| "pl"
| "pt-br"
| "pt"
| "rn"
| "ro"
| "ru"
| "rw"
| "sd"
| "se"
| "si"
| "sk"
| "sl"
| "sq"
| "sr-cyrl"
| "ss"
| "sv-fi"
| "sr"
| "sv"
| "sw"
| "ta"
| "te"
| "tet"
| "tg"
| "th"
| "tk"
| "tl-ph"
| "tlh"
| "tr"
| "tzl"
| "tzm-latn"
| "tzm"
| "ug-cn"
| "uk"
| "ur"
| "uz-latn"
| "uz"
| "vi"
| "x-pseudo"
| "yo"
| "zh-cn"
| "zh-hk"
| "zh-tw"
| "zh"
| "oc-lnc"
| "nn"
| "pa-in";
2 changes: 1 addition & 1 deletion src/svelte-time.svelte.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { TimeProps } from "./Time.svelte";
export interface SvelteTimeOptions
extends Pick<
TimeProps,
"timestamp" | "format" | "relative" | "live" | "title"
"timestamp" | "format" | "relative" | "live" | "title" | "locale"
> {}

export const svelteTime: Action<
Expand Down
7 changes: 4 additions & 3 deletions src/svelte-time.svelte.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ export const svelteTime = (node, options = {}) => {
const format = options.format || "MMM DD, YYYY";
const relative = options.relative === true;
const live = options.live ?? false;
const locale = options.locale ?? "en";

let formatted_from = dayjs(timestamp).from();
let formatted = dayjs(timestamp).format(format);
let formatted_from = dayjs(timestamp).locale(locale).from();
let formatted = dayjs(timestamp).locale(locale).format(format);

if (relative) {
if ("title" in options) {
Expand All @@ -33,7 +34,7 @@ export const svelteTime = (node, options = {}) => {
if (live !== false) {
interval = setInterval(
() => {
node.innerText = dayjs(timestamp).from();
node.innerText = dayjs(timestamp).locale(locale).from();
},
Math.abs(typeof live === "number" ? live : DEFAULT_INTERVAL),
);
Expand Down
117 changes: 117 additions & 0 deletions tests/SvelteTimeLocale.test.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<script lang="ts">
import Time, { svelteTime } from "svelte-time";
import dayjs from "dayjs";
import "dayjs/locale/de"; // German
import "dayjs/locale/es"; // Spanish
import "dayjs/locale/fr"; // French
import "dayjs/locale/ja"; // Japanese

const fixedDate = "2024-01-01T12:00:00.000Z";

// Pre-format dates with locales
const germanDate = dayjs(fixedDate).locale("de").format("dddd, D. MMMM YYYY");
const spanishDate = dayjs(fixedDate)
.locale("es")
.format("dddd, D [de] MMMM [de] YYYY");
const frenchDate = dayjs(fixedDate).locale("fr").format("dddd D MMMM YYYY");
const japaneseDate = dayjs(fixedDate)
.locale("ja")
.format("YYYY年M月D日(dddd)");
</script>

<!-- German Locale -->
<Time
data-test="german-full"
timestamp={fixedDate}
format="dddd, D. MMMM YYYY"
locale="de"
/>

<span data-test="german-formatted">{germanDate}</span>

<Time
data-test="german-short"
timestamp={fixedDate}
format="dd., D. MMM YYYY"
locale="de"
/>

<Time
data-test="german-month-year"
timestamp={fixedDate}
format="MMMM YYYY"
locale="de"
/>

<!-- Spanish Locale -->
<Time
data-test="spanish-full"
timestamp={fixedDate}
format="dddd, D [de] MMMM [de] YYYY"
locale="es"
/>

<span data-test="spanish-formatted">{spanishDate}</span>

<Time
data-test="spanish-short"
timestamp={fixedDate}
format="dd., D MMM YYYY"
locale="es"
/>

<!-- French Locale -->
<Time
data-test="french-full"
timestamp={fixedDate}
format="dddd D MMMM YYYY"
locale="fr"
/>

<span data-test="french-formatted">{frenchDate}</span>

<Time
data-test="french-short"
timestamp={fixedDate}
format="dd. D MMM YYYY"
locale="fr"
/>

<!-- Japanese Locale -->
<Time
data-test="japanese-full"
timestamp={fixedDate}
format="YYYY年M月D日(dddd)"
locale="ja"
/>

<span data-test="japanese-formatted">{japaneseDate}</span>

<Time
data-test="japanese-short"
timestamp={fixedDate}
format="YYYY年M月D日"
locale="ja"
/>

<!-- Relative Time in Different Locales -->
<Time data-test="german-relative" timestamp={fixedDate} relative locale="de" />

<Time data-test="spanish-relative" timestamp={fixedDate} relative locale="es" />

<Time data-test="french-relative" timestamp={fixedDate} relative locale="fr" />

<Time
data-test="japanese-relative"
timestamp={fixedDate}
relative
locale="ja"
/>

<time data-test="action-locale-es" use:svelteTime={{ locale: "es" }}></time>

<time data-test="action-locale-fr" use:svelteTime={{ locale: "fr" }}></time>

<time data-test="action-locale-ja" use:svelteTime={{ locale: "ja" }}></time>

<time data-test="action-locale-de" use:svelteTime={{ locale: "de" }}></time>
Loading