@uxf/core 11.91.0 → 11.93.0

package/README.md

@@ -529,6 +529,28 @@ numberOrNull(null);       /* returns null */
 numberOrNull(undefined);  /* returns null */
 ```
 
+## plural
+
+Simple pluralization function for a specific language and set of terms.
+
+```tsx
+import { createPlural } from "@uxf/core/utils/plural";
+
+const terms = {
+    items: {
+        one: "položka",
+        few: "položky",
+        other: "položek",
+    },
+};
+
+const t = createPlural(terms, "cs");
+
+t("items", 1); // returns "položka"
+t("items", 3); // returns "položky"
+t("items", 5); // returns "položek"
+```
+
 ## slugify
 
 ```tsx

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@uxf/core",
-    "version": "11.91.0",
+    "version": "11.93.0",
     "description": "UXF Core",
     "author": "Petr Vejvoda <vejvoda@uxf.cz>",
     "homepage": "https://gitlab.com/uxf-npm/core#readme",

package/utils/plural.d.ts

@@ -0,0 +1,10 @@
+export interface PluralOptions {
+    zero?: string;
+    one?: string;
+    two?: string;
+    few?: string;
+    many?: string;
+    other: string;
+}
+export type PluralTerms<T extends string> = Record<T, PluralOptions>;
+export declare function createPlural<T extends string>(terms: PluralTerms<T>, locale: string): (key: T, count: number) => string;

package/utils/plural.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPlural = createPlural;
+function plural(count, options, locale) {
+    var _a;
+    const rules = new Intl.PluralRules(locale);
+    const category = rules.select(count);
+    return (_a = options[category]) !== null && _a !== void 0 ? _a : options.other;
+}
+function createPlural(terms, locale) {
+    return (key, count) => {
+        const options = terms[key];
+        return plural(count, options, locale);
+    };
+}

package/utils/plural.test.d.ts

@@ -0,0 +1 @@
+export {};

package/utils/plural.test.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const plural_1 = require("./plural");
+describe("pluralization", () => {
+    describe("createPlural", () => {
+        test("creates a typed plural function", () => {
+            const terms = {
+                items: {
+                    one: "item",
+                    other: "items",
+                },
+                apples: {
+                    one: "apple",
+                    other: "apples",
+                },
+            };
+            const t = (0, plural_1.createPlural)(terms, "en");
+            expect(t("items", 1)).toBe("item");
+            expect(t("items", 5)).toBe("items");
+            expect(t("apples", 1)).toBe("apple");
+            expect(t("apples", 10)).toBe("apples");
+        });
+        test("works with czech terms", () => {
+            const terms = {
+                items: {
+                    one: "položka",
+                    few: "položky",
+                    other: "položek",
+                },
+            };
+            const t = (0, plural_1.createPlural)(terms, "cs");
+            expect(t("items", 1)).toBe("položka");
+            expect(t("items", 3)).toBe("položky");
+            expect(t("items", 5)).toBe("položek");
+        });
+    });
+});