@uxf/core 11.93.0 → 11.97.0

package/README.md

@@ -171,6 +171,16 @@ import { capitalize } from "@uxf/core/utils/capitalize";
 const example = capitalize("hello world"); /* returns "Hello world" */
 ```
 
+## cn
+
+A simple tag for template literals that returns the string as-is. Useful for tooling (e.g. Tailwind CSS IntelliSense) to recognize class strings.
+
+```tsx
+import { cn } from "@uxf/core/utils/cn";
+
+const className = cn`flex items-center justify-center`;
+```
+
 ## composeRefs
 
 ```tsx
@@ -277,6 +287,18 @@ escapeQuotes('The "quick" fox');
 // Output: The \"quick\" fox
 ```
 
+## humanIndex
+
+Converts a 0-based index to a 1-based (human-readable) index.
+
+```tsx
+import { humanIndex } from "@uxf/core/utils/human-index";
+
+humanIndex(0);  /* returns 1 */
+humanIndex(9);  /* returns 10 */
+humanIndex(-1);  /* throws error */
+```
+
 ## filterNullish
 
 ```tsx

package/package.json

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

package/utils/cn.d.ts

@@ -0,0 +1 @@
+export declare function cn([className]: TemplateStringsArray): string;

package/utils/cn.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cn = cn;
+function cn([className]) {
+    return className;
+}

package/utils/cn.test.d.ts

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

package/utils/cn.test.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cn_1 = require("./cn");
+test("returns the class name", () => {
+    expect((0, cn_1.cn) `foo`).toBe("foo");
+    expect((0, cn_1.cn) `foo bar`).toBe("foo bar");
+});

package/utils/human-index.d.ts

@@ -0,0 +1 @@
+export declare function humanIndex(index: number): number;

package/utils/human-index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.humanIndex = humanIndex;
+function humanIndex(index) {
+    if (index < 0) {
+        throw Error("Negative indexes are not supported.");
+    }
+    return index + 1;
+}

package/utils/human-index.test.d.ts

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

package/utils/human-index.test.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const human_index_1 = require("./human-index");
+test("human-index", () => {
+    expect((0, human_index_1.humanIndex)(0)).toBe(1);
+    expect((0, human_index_1.humanIndex)(1)).toBe(2);
+    expect((0, human_index_1.humanIndex)(9)).toBe(10);
+    expect(() => (0, human_index_1.humanIndex)(-1)).toThrow();
+});