@vorlyn/utils
v0.1.1
Published
Readme
@vorlyn/utils
Shared utility functions for the Vorlyn ecosystem — a set of small, dependency-light helpers used across Vorlyn's components and packages.
Installation
npm install @vorlyn/utilsUsage
cn
Merges class names using clsx and resolves Tailwind CSS conflicts using tailwind-merge.
import { cn } from "@vorlyn/utils";
cn("px-2 py-1", isActive && "bg-primary", "px-4");
// => "py-1 bg-primary px-4"setLocalStorage
Saves a value to localStorage, serialized as JSON.
import { setLocalStorage } from "@vorlyn/utils";
setLocalStorage("theme", { mode: "dark" });getLocalStorage
Reads and parses a value from localStorage. Returns null if the key doesn't exist or parsing fails.
import { getLocalStorage } from "@vorlyn/utils";
const theme = getLocalStorage<{ mode: string }>("theme");removeLocalStorageItem
Removes a single key from localStorage.
import { removeLocalStorageItem } from "@vorlyn/utils";
removeLocalStorageItem("theme");removeAllFromLocalStorage
Clears all keys from localStorage.
import { removeAllFromLocalStorage } from "@vorlyn/utils";
removeAllFromLocalStorage();Note: The
localStorage-based utilities rely on the browserlocalStorageAPI and are intended for use in browser/React environments, not Node.js runtimes.
License
MIT © Zohair Ajmal
See LICENSE for details.
