@allem-sdk/hooks 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ahmed Allem
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/kingofmit/allem-sdk/main/.github/AllemSDK.png" alt="Allem SDK" />
+</p>
+
+<p align="center">
+  <a href="https://github.com/kingofmit/allem-sdk/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License" /></a>
+  <img src="https://img.shields.io/badge/react-18+-61dafb" alt="React 18+" />
+  <img src="https://img.shields.io/badge/typescript-strict-blue" alt="TypeScript" />
+  <img src="https://img.shields.io/badge/SSR-safe-brightgreen" alt="SSR Safe" />
+</p>
+
+# @allem-sdk/hooks
+
+Essential React hooks for modern applications. SSR-safe, zero dependencies, works with Next.js, Vite, and Remix.
+
+## Installation
+
+```bash
+npm install @allem-sdk/hooks
+```
+
+## Hooks
+
+| Hook | Description |
+|------|-------------|
+| `useDebounce` | Debounce a value by a given delay |
+| `useLocalStorage` | Persist state in localStorage with SSR safety |
+| `useMediaQuery` | Reactive CSS media query matching |
+| `useClickOutside` | Detect clicks outside a ref element |
+| `useToggle` | Boolean toggle state |
+| `useCopyToClipboard` | Copy text to clipboard with status |
+| `useIntersectionObserver` | Observe element visibility via IntersectionObserver |
+| `useWindowSize` | Reactive window dimensions |
+
+## Usage
+
+```tsx
+import { useDebounce, useLocalStorage, useMediaQuery } from "@allem-sdk/hooks";
+
+function Search() {
+  const [query, setQuery] = useLocalStorage("search", "");
+  const debouncedQuery = useDebounce(query, 300);
+  const isMobile = useMediaQuery("(max-width: 768px)");
+
+  return <input value={query} onChange={(e) => setQuery(e.target.value)} />;
+}
+```
+
+```tsx
+import { useClickOutside, useToggle } from "@allem-sdk/hooks";
+
+function Dropdown() {
+  const [isOpen, toggle] = useToggle(false);
+  const ref = useClickOutside<HTMLDivElement>(() => toggle(false));
+
+  return (
+    <div ref={ref}>
+      <button onClick={() => toggle()}>Menu</button>
+      {isOpen && <ul>...</ul>}
+    </div>
+  );
+}
+```
+
+## Part of [Allem SDK](https://github.com/kingofmit/allem-sdk)
+
+This package can be used standalone or as part of the full SDK. Install `allem-sdk` to get all packages in one install.
+
+## Support
+
+If you find Allem SDK useful, consider supporting its development:
+
+<a href="https://buymeacoffee.com/kingofmit" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="50" /></a>
+
+## License
+
+[MIT](https://github.com/kingofmit/allem-sdk/blob/main/LICENSE) - [Ahmed Allem](https://kingallem.com)

package/dist/index.d.mts

@@ -0,0 +1,31 @@
+import { RefObject } from 'react';
+
+declare function useDebounce<T>(value: T, delay?: number): T;
+
+declare function useLocalStorage<T>(key: string, initialValue: T): [T, (value: T | ((prev: T) => T)) => void, () => void];
+
+declare function useMediaQuery(query: string): boolean;
+
+declare function useClickOutside<T extends HTMLElement>(ref: RefObject<T | null>, handler: (event: MouseEvent | TouchEvent) => void): void;
+
+declare function useToggle(initialValue?: boolean): [boolean, () => void, (value: boolean) => void];
+
+declare function useCopyToClipboard(): [
+    boolean,
+    (text: string) => Promise<void>
+];
+
+interface UseIntersectionObserverOptions {
+    threshold?: number | number[];
+    root?: Element | null;
+    rootMargin?: string;
+}
+declare function useIntersectionObserver<T extends HTMLElement>(ref: RefObject<T | null>, options?: UseIntersectionObserverOptions): boolean;
+
+interface WindowSize {
+    width: number;
+    height: number;
+}
+declare function useWindowSize(): WindowSize;
+
+export { useClickOutside, useCopyToClipboard, useDebounce, useIntersectionObserver, useLocalStorage, useMediaQuery, useToggle, useWindowSize };

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { RefObject } from 'react';
+
+declare function useDebounce<T>(value: T, delay?: number): T;
+
+declare function useLocalStorage<T>(key: string, initialValue: T): [T, (value: T | ((prev: T) => T)) => void, () => void];
+
+declare function useMediaQuery(query: string): boolean;
+
+declare function useClickOutside<T extends HTMLElement>(ref: RefObject<T | null>, handler: (event: MouseEvent | TouchEvent) => void): void;
+
+declare function useToggle(initialValue?: boolean): [boolean, () => void, (value: boolean) => void];
+
+declare function useCopyToClipboard(): [
+    boolean,
+    (text: string) => Promise<void>
+];
+
+interface UseIntersectionObserverOptions {
+    threshold?: number | number[];
+    root?: Element | null;
+    rootMargin?: string;
+}
+declare function useIntersectionObserver<T extends HTMLElement>(ref: RefObject<T | null>, options?: UseIntersectionObserverOptions): boolean;
+
+interface WindowSize {
+    width: number;
+    height: number;
+}
+declare function useWindowSize(): WindowSize;
+
+export { useClickOutside, useCopyToClipboard, useDebounce, useIntersectionObserver, useLocalStorage, useMediaQuery, useToggle, useWindowSize };

package/dist/index.js

@@ -0,0 +1,175 @@
+"use client";
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  useClickOutside: () => useClickOutside,
+  useCopyToClipboard: () => useCopyToClipboard,
+  useDebounce: () => useDebounce,
+  useIntersectionObserver: () => useIntersectionObserver,
+  useLocalStorage: () => useLocalStorage,
+  useMediaQuery: () => useMediaQuery,
+  useToggle: () => useToggle,
+  useWindowSize: () => useWindowSize
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/hooks/useDebounce.ts
+var import_react = require("react");
+function useDebounce(value, delay = 300) {
+  const [debouncedValue, setDebouncedValue] = (0, import_react.useState)(value);
+  (0, import_react.useEffect)(() => {
+    const timer = setTimeout(() => setDebouncedValue(value), delay);
+    return () => clearTimeout(timer);
+  }, [value, delay]);
+  return debouncedValue;
+}
+
+// src/hooks/useLocalStorage.ts
+var import_react2 = require("react");
+function useLocalStorage(key, initialValue) {
+  const [storedValue, setStoredValue] = (0, import_react2.useState)(() => {
+    if (typeof window === "undefined") return initialValue;
+    try {
+      const item = window.localStorage.getItem(key);
+      return item ? JSON.parse(item) : initialValue;
+    } catch {
+      return initialValue;
+    }
+  });
+  const setValue = (0, import_react2.useCallback)(
+    (value) => {
+      setStoredValue((prev) => {
+        const next = value instanceof Function ? value(prev) : value;
+        if (typeof window !== "undefined") {
+          window.localStorage.setItem(key, JSON.stringify(next));
+        }
+        return next;
+      });
+    },
+    [key]
+  );
+  const removeValue = (0, import_react2.useCallback)(() => {
+    setStoredValue(initialValue);
+    if (typeof window !== "undefined") {
+      window.localStorage.removeItem(key);
+    }
+  }, [key, initialValue]);
+  return [storedValue, setValue, removeValue];
+}
+
+// src/hooks/useMediaQuery.ts
+var import_react3 = require("react");
+function useMediaQuery(query) {
+  const [matches, setMatches] = (0, import_react3.useState)(() => {
+    if (typeof window === "undefined") return false;
+    return window.matchMedia(query).matches;
+  });
+  (0, import_react3.useEffect)(() => {
+    if (typeof window === "undefined") return;
+    const mediaQuery = window.matchMedia(query);
+    const handler = (event) => setMatches(event.matches);
+    setMatches(mediaQuery.matches);
+    mediaQuery.addEventListener("change", handler);
+    return () => mediaQuery.removeEventListener("change", handler);
+  }, [query]);
+  return matches;
+}
+
+// src/hooks/useClickOutside.ts
+var import_react4 = require("react");
+function useClickOutside(ref, handler) {
+  (0, import_react4.useEffect)(() => {
+    const listener = (event) => {
+      if (!ref.current || ref.current.contains(event.target)) return;
+      handler(event);
+    };
+    document.addEventListener("mousedown", listener);
+    document.addEventListener("touchstart", listener);
+    return () => {
+      document.removeEventListener("mousedown", listener);
+      document.removeEventListener("touchstart", listener);
+    };
+  }, [ref, handler]);
+}
+
+// src/hooks/useToggle.ts
+var import_react5 = require("react");
+function useToggle(initialValue = false) {
+  const [value, setValue] = (0, import_react5.useState)(initialValue);
+  const toggle = (0, import_react5.useCallback)(() => setValue((prev) => !prev), []);
+  const set = (0, import_react5.useCallback)((v) => setValue(v), []);
+  return [value, toggle, set];
+}
+
+// src/hooks/useCopyToClipboard.ts
+var import_react6 = require("react");
+function useCopyToClipboard() {
+  const [copied, setCopied] = (0, import_react6.useState)(false);
+  const copy = (0, import_react6.useCallback)(async (text) => {
+    if (typeof navigator === "undefined") return;
+    await navigator.clipboard.writeText(text);
+    setCopied(true);
+    setTimeout(() => setCopied(false), 2e3);
+  }, []);
+  return [copied, copy];
+}
+
+// src/hooks/useIntersectionObserver.ts
+var import_react7 = require("react");
+function useIntersectionObserver(ref, options = {}) {
+  const [isIntersecting, setIsIntersecting] = (0, import_react7.useState)(false);
+  const { threshold = 0, root = null, rootMargin = "0px" } = options;
+  (0, import_react7.useEffect)(() => {
+    if (!ref.current || typeof IntersectionObserver === "undefined") return;
+    const observer = new IntersectionObserver(
+      ([entry]) => setIsIntersecting(entry.isIntersecting),
+      { threshold, root, rootMargin }
+    );
+    observer.observe(ref.current);
+    return () => observer.disconnect();
+  }, [ref, threshold, root, rootMargin]);
+  return isIntersecting;
+}
+
+// src/hooks/useWindowSize.ts
+var import_react8 = require("react");
+function useWindowSize() {
+  const [size, setSize] = (0, import_react8.useState)({ width: 0, height: 0 });
+  (0, import_react8.useEffect)(() => {
+    const handler = () => setSize({ width: window.innerWidth, height: window.innerHeight });
+    handler();
+    window.addEventListener("resize", handler);
+    return () => window.removeEventListener("resize", handler);
+  }, []);
+  return size;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useClickOutside,
+  useCopyToClipboard,
+  useDebounce,
+  useIntersectionObserver,
+  useLocalStorage,
+  useMediaQuery,
+  useToggle,
+  useWindowSize
+});

package/dist/index.mjs

@@ -0,0 +1,142 @@
+"use client";
+
+// src/hooks/useDebounce.ts
+import { useState, useEffect } from "react";
+function useDebounce(value, delay = 300) {
+  const [debouncedValue, setDebouncedValue] = useState(value);
+  useEffect(() => {
+    const timer = setTimeout(() => setDebouncedValue(value), delay);
+    return () => clearTimeout(timer);
+  }, [value, delay]);
+  return debouncedValue;
+}
+
+// src/hooks/useLocalStorage.ts
+import { useState as useState2, useCallback } from "react";
+function useLocalStorage(key, initialValue) {
+  const [storedValue, setStoredValue] = useState2(() => {
+    if (typeof window === "undefined") return initialValue;
+    try {
+      const item = window.localStorage.getItem(key);
+      return item ? JSON.parse(item) : initialValue;
+    } catch {
+      return initialValue;
+    }
+  });
+  const setValue = useCallback(
+    (value) => {
+      setStoredValue((prev) => {
+        const next = value instanceof Function ? value(prev) : value;
+        if (typeof window !== "undefined") {
+          window.localStorage.setItem(key, JSON.stringify(next));
+        }
+        return next;
+      });
+    },
+    [key]
+  );
+  const removeValue = useCallback(() => {
+    setStoredValue(initialValue);
+    if (typeof window !== "undefined") {
+      window.localStorage.removeItem(key);
+    }
+  }, [key, initialValue]);
+  return [storedValue, setValue, removeValue];
+}
+
+// src/hooks/useMediaQuery.ts
+import { useState as useState3, useEffect as useEffect2 } from "react";
+function useMediaQuery(query) {
+  const [matches, setMatches] = useState3(() => {
+    if (typeof window === "undefined") return false;
+    return window.matchMedia(query).matches;
+  });
+  useEffect2(() => {
+    if (typeof window === "undefined") return;
+    const mediaQuery = window.matchMedia(query);
+    const handler = (event) => setMatches(event.matches);
+    setMatches(mediaQuery.matches);
+    mediaQuery.addEventListener("change", handler);
+    return () => mediaQuery.removeEventListener("change", handler);
+  }, [query]);
+  return matches;
+}
+
+// src/hooks/useClickOutside.ts
+import { useEffect as useEffect3 } from "react";
+function useClickOutside(ref, handler) {
+  useEffect3(() => {
+    const listener = (event) => {
+      if (!ref.current || ref.current.contains(event.target)) return;
+      handler(event);
+    };
+    document.addEventListener("mousedown", listener);
+    document.addEventListener("touchstart", listener);
+    return () => {
+      document.removeEventListener("mousedown", listener);
+      document.removeEventListener("touchstart", listener);
+    };
+  }, [ref, handler]);
+}
+
+// src/hooks/useToggle.ts
+import { useState as useState4, useCallback as useCallback2 } from "react";
+function useToggle(initialValue = false) {
+  const [value, setValue] = useState4(initialValue);
+  const toggle = useCallback2(() => setValue((prev) => !prev), []);
+  const set = useCallback2((v) => setValue(v), []);
+  return [value, toggle, set];
+}
+
+// src/hooks/useCopyToClipboard.ts
+import { useState as useState5, useCallback as useCallback3 } from "react";
+function useCopyToClipboard() {
+  const [copied, setCopied] = useState5(false);
+  const copy = useCallback3(async (text) => {
+    if (typeof navigator === "undefined") return;
+    await navigator.clipboard.writeText(text);
+    setCopied(true);
+    setTimeout(() => setCopied(false), 2e3);
+  }, []);
+  return [copied, copy];
+}
+
+// src/hooks/useIntersectionObserver.ts
+import { useState as useState6, useEffect as useEffect4 } from "react";
+function useIntersectionObserver(ref, options = {}) {
+  const [isIntersecting, setIsIntersecting] = useState6(false);
+  const { threshold = 0, root = null, rootMargin = "0px" } = options;
+  useEffect4(() => {
+    if (!ref.current || typeof IntersectionObserver === "undefined") return;
+    const observer = new IntersectionObserver(
+      ([entry]) => setIsIntersecting(entry.isIntersecting),
+      { threshold, root, rootMargin }
+    );
+    observer.observe(ref.current);
+    return () => observer.disconnect();
+  }, [ref, threshold, root, rootMargin]);
+  return isIntersecting;
+}
+
+// src/hooks/useWindowSize.ts
+import { useState as useState7, useEffect as useEffect5 } from "react";
+function useWindowSize() {
+  const [size, setSize] = useState7({ width: 0, height: 0 });
+  useEffect5(() => {
+    const handler = () => setSize({ width: window.innerWidth, height: window.innerHeight });
+    handler();
+    window.addEventListener("resize", handler);
+    return () => window.removeEventListener("resize", handler);
+  }, []);
+  return size;
+}
+export {
+  useClickOutside,
+  useCopyToClipboard,
+  useDebounce,
+  useIntersectionObserver,
+  useLocalStorage,
+  useMediaQuery,
+  useToggle,
+  useWindowSize
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@allem-sdk/hooks",
+  "version": "0.1.0",
+  "description": "A collection of essential React hooks for modern applications",
+  "license": "MIT",
+  "author": "Ahmed Allem",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "devDependencies": {
+    "@testing-library/react": "^16.0.0",
+    "@types/react": "^19.0.0",
+    "jsdom": "^25.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.0",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kingofmit/allem-sdk.git",
+    "directory": "packages/hooks"
+  },
+  "keywords": [
+    "allem-sdk",
+    "react",
+    "hooks",
+    "useDebounce",
+    "useMediaQuery",
+    "useLocalStorage"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}