@shoelace-style/localize 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2.1.0
+
+- Added relative time method to 
+
+## 2.0.0
+
+- Reworked the library to use the [ReactiveController](https://lit.dev/docs/composition/controllers/) interface

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export declare function registerTranslation(...translation: Translation[]): void
 export declare function term<K extends keyof Translation>(lang: string, key: K, ...args: FunctionParams<Translation[K]>): any;
 export declare function date(lang: string, dateToFormat: Date | string, options?: Intl.DateTimeFormatOptions): string;
 export declare function number(lang: string, numberToFormat: number | string, options?: Intl.NumberFormatOptions): string;
+export declare function relativeTime(lang: string, value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions): string;
 export declare function updateLocalizedTerms(): void;
 export declare class LocalizeController implements ReactiveController {
     host: ReactiveControllerHost & HTMLElement;
@@ -19,4 +20,5 @@ export declare class LocalizeController implements ReactiveController {
     term<K extends keyof Translation>(key: K, ...args: FunctionParams<Translation[K]>): any;
     date(dateToFormat: Date | string, options?: Intl.DateTimeFormatOptions): string;
     number(numberToFormat: number | string, options?: Intl.NumberFormatOptions): string;
+    relativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions): string;
 }

package/dist/index.js

@@ -49,6 +49,9 @@ export function number(lang, numberToFormat, options) {
     numberToFormat = Number(numberToFormat);
     return isNaN(numberToFormat) ? '' : new Intl.NumberFormat(lang, options).format(numberToFormat);
 }
+export function relativeTime(lang, value, unit, options) {
+    return new Intl.RelativeTimeFormat(lang, options).format(value, unit);
+}
 export function updateLocalizedTerms() {
     documentLanguage = document.documentElement.lang || navigator.language;
     [...connectedElements.keys()].map((el) => {
@@ -77,4 +80,7 @@ export class LocalizeController {
     number(numberToFormat, options) {
         return number(this.host.lang || documentLanguage, numberToFormat, options);
     }
+    relativeTime(value, unit, options) {
+        return relativeTime(this.host.lang || documentLanguage, value, unit, options);
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shoelace-style/localize",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A micro library for localizing custom elements using Lit's Reactive Controller model.",
   "main": "/dist/index.js",
   "module": "/dist/index.js",

package/src/index.ts

@@ -84,6 +84,18 @@ export function number(lang: string, numberToFormat: number | string, options?:
   return isNaN(numberToFormat) ? '' : new Intl.NumberFormat(lang, options).format(numberToFormat);
 }
 
+//
+// Formats a relative date using the specified locale.
+//
+export function relativeTime(
+  lang: string,
+  value: number,
+  unit: Intl.RelativeTimeFormatUnit,
+  options?: Intl.RelativeTimeFormatOptions
+) {
+  return new Intl.RelativeTimeFormat(lang, options).format(value, unit);
+}
+
 //
 // Updates the locale for all localized elements that are currently connected
 //
@@ -142,4 +154,8 @@ export class LocalizeController implements ReactiveController {
   number(numberToFormat: number | string, options?: Intl.NumberFormatOptions) {
     return number(this.host.lang || documentLanguage, numberToFormat, options);
   }
+
+  relativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: Intl.RelativeTimeFormatOptions) {
+    return relativeTime(this.host.lang || documentLanguage, value, unit, options);
+  }
 }