@usefy/use-toggle 0.0.2

package/dist/index.d.mts

@@ -0,0 +1,49 @@
+/**
+ * useToggle return type
+ */
+interface UseToggleReturn {
+    /**
+     * Current toggle state
+     */
+    value: boolean;
+    /**
+     * Toggle the current state
+     */
+    toggle: () => void;
+    /**
+     * Set state to true
+     */
+    setTrue: () => void;
+    /**
+     * Set state to false
+     */
+    setFalse: () => void;
+    /**
+     * Set state to a specific value
+     */
+    setValue: (value: boolean) => void;
+}
+/**
+ * A hook for managing boolean state with helpful utilities
+ *
+ * @param initialValue - Initial boolean value (default: false)
+ * @returns Object containing the current value and control functions
+ *
+ * @example
+ * ```tsx
+ * function Modal() {
+ *   const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);
+ *
+ *   return (
+ *     <>
+ *       <button onClick={setTrue}>Open</button>
+ *       <button onClick={toggle}>Toggle</button>
+ *       {isOpen && <div>Modal Content</div>}
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function useToggle(initialValue?: boolean): UseToggleReturn;
+
+export { type UseToggleReturn, useToggle };

package/dist/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * useToggle return type
+ */
+interface UseToggleReturn {
+    /**
+     * Current toggle state
+     */
+    value: boolean;
+    /**
+     * Toggle the current state
+     */
+    toggle: () => void;
+    /**
+     * Set state to true
+     */
+    setTrue: () => void;
+    /**
+     * Set state to false
+     */
+    setFalse: () => void;
+    /**
+     * Set state to a specific value
+     */
+    setValue: (value: boolean) => void;
+}
+/**
+ * A hook for managing boolean state with helpful utilities
+ *
+ * @param initialValue - Initial boolean value (default: false)
+ * @returns Object containing the current value and control functions
+ *
+ * @example
+ * ```tsx
+ * function Modal() {
+ *   const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);
+ *
+ *   return (
+ *     <>
+ *       <button onClick={setTrue}>Open</button>
+ *       <button onClick={toggle}>Toggle</button>
+ *       {isOpen && <div>Modal Content</div>}
+ *     </>
+ *   );
+ * }
+ * ```
+ */
+declare function useToggle(initialValue?: boolean): UseToggleReturn;
+
+export { type UseToggleReturn, useToggle };

package/dist/index.js

@@ -0,0 +1,55 @@
+"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, {
+  useToggle: () => useToggle
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/useToggle.ts
+var import_react = require("react");
+function useToggle(initialValue = false) {
+  const [value, setValue] = (0, import_react.useState)(initialValue);
+  const toggle = (0, import_react.useCallback)(() => {
+    setValue((prev) => !prev);
+  }, []);
+  const setTrue = (0, import_react.useCallback)(() => {
+    setValue(true);
+  }, []);
+  const setFalse = (0, import_react.useCallback)(() => {
+    setValue(false);
+  }, []);
+  const setValueCallback = (0, import_react.useCallback)((newValue) => {
+    setValue(newValue);
+  }, []);
+  return {
+    value,
+    toggle,
+    setTrue,
+    setFalse,
+    setValue: setValueCallback
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useToggle
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/useToggle.ts"],"sourcesContent":["export { useToggle, type UseToggleReturn } from \"./useToggle\";\r\n","import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n  /**\r\n   * Current toggle state\r\n   */\r\n  value: boolean;\r\n  /**\r\n   * Toggle the current state\r\n   */\r\n  toggle: () => void;\r\n  /**\r\n   * Set state to true\r\n   */\r\n  setTrue: () => void;\r\n  /**\r\n   * Set state to false\r\n   */\r\n  setFalse: () => void;\r\n  /**\r\n   * Set state to a specific value\r\n   */\r\n  setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n *   const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n *   return (\r\n *     <>\r\n *       <button onClick={setTrue}>Open</button>\r\n *       <button onClick={toggle}>Toggle</button>\r\n *       {isOpen && <div>Modal Content</div>}\r\n *     </>\r\n *   );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n  const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n  const toggle = useCallback(() => {\r\n    setValue((prev) => !prev);\r\n  }, []);\r\n\r\n  const setTrue = useCallback(() => {\r\n    setValue(true);\r\n  }, []);\r\n\r\n  const setFalse = useCallback(() => {\r\n    setValue(false);\r\n  }, []);\r\n\r\n  const setValueCallback = useCallback((newValue: boolean) => {\r\n    setValue(newValue);\r\n  }, []);\r\n\r\n  return {\r\n    value,\r\n    toggle,\r\n    setTrue,\r\n    setFalse,\r\n    setValue: setValueCallback,\r\n  };\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAsC;AAiD/B,SAAS,UAAU,eAAwB,OAAwB;AACxE,QAAM,CAAC,OAAO,QAAQ,QAAI,uBAAkB,YAAY;AAExD,QAAM,aAAS,0BAAY,MAAM;AAC/B,aAAS,CAAC,SAAS,CAAC,IAAI;AAAA,EAC1B,GAAG,CAAC,CAAC;AAEL,QAAM,cAAU,0BAAY,MAAM;AAChC,aAAS,IAAI;AAAA,EACf,GAAG,CAAC,CAAC;AAEL,QAAM,eAAW,0BAAY,MAAM;AACjC,aAAS,KAAK;AAAA,EAChB,GAAG,CAAC,CAAC;AAEL,QAAM,uBAAmB,0BAAY,CAAC,aAAsB;AAC1D,aAAS,QAAQ;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACZ;AACF;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,28 @@
+// src/useToggle.ts
+import { useCallback, useState } from "react";
+function useToggle(initialValue = false) {
+  const [value, setValue] = useState(initialValue);
+  const toggle = useCallback(() => {
+    setValue((prev) => !prev);
+  }, []);
+  const setTrue = useCallback(() => {
+    setValue(true);
+  }, []);
+  const setFalse = useCallback(() => {
+    setValue(false);
+  }, []);
+  const setValueCallback = useCallback((newValue) => {
+    setValue(newValue);
+  }, []);
+  return {
+    value,
+    toggle,
+    setTrue,
+    setFalse,
+    setValue: setValueCallback
+  };
+}
+export {
+  useToggle
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useToggle.ts"],"sourcesContent":["import { useCallback, useState } from \"react\";\r\n\r\n/**\r\n * useToggle return type\r\n */\r\nexport interface UseToggleReturn {\r\n  /**\r\n   * Current toggle state\r\n   */\r\n  value: boolean;\r\n  /**\r\n   * Toggle the current state\r\n   */\r\n  toggle: () => void;\r\n  /**\r\n   * Set state to true\r\n   */\r\n  setTrue: () => void;\r\n  /**\r\n   * Set state to false\r\n   */\r\n  setFalse: () => void;\r\n  /**\r\n   * Set state to a specific value\r\n   */\r\n  setValue: (value: boolean) => void;\r\n}\r\n\r\n/**\r\n * A hook for managing boolean state with helpful utilities\r\n *\r\n * @param initialValue - Initial boolean value (default: false)\r\n * @returns Object containing the current value and control functions\r\n *\r\n * @example\r\n * ```tsx\r\n * function Modal() {\r\n *   const { value: isOpen, toggle, setTrue, setFalse } = useToggle(false);\r\n *\r\n *   return (\r\n *     <>\r\n *       <button onClick={setTrue}>Open</button>\r\n *       <button onClick={toggle}>Toggle</button>\r\n *       {isOpen && <div>Modal Content</div>}\r\n *     </>\r\n *   );\r\n * }\r\n * ```\r\n */\r\nexport function useToggle(initialValue: boolean = false): UseToggleReturn {\r\n  const [value, setValue] = useState<boolean>(initialValue);\r\n\r\n  const toggle = useCallback(() => {\r\n    setValue((prev) => !prev);\r\n  }, []);\r\n\r\n  const setTrue = useCallback(() => {\r\n    setValue(true);\r\n  }, []);\r\n\r\n  const setFalse = useCallback(() => {\r\n    setValue(false);\r\n  }, []);\r\n\r\n  const setValueCallback = useCallback((newValue: boolean) => {\r\n    setValue(newValue);\r\n  }, []);\r\n\r\n  return {\r\n    value,\r\n    toggle,\r\n    setTrue,\r\n    setFalse,\r\n    setValue: setValueCallback,\r\n  };\r\n}\r\n"],"mappings":";AAAA,SAAS,aAAa,gBAAgB;AAiD/B,SAAS,UAAU,eAAwB,OAAwB;AACxE,QAAM,CAAC,OAAO,QAAQ,IAAI,SAAkB,YAAY;AAExD,QAAM,SAAS,YAAY,MAAM;AAC/B,aAAS,CAAC,SAAS,CAAC,IAAI;AAAA,EAC1B,GAAG,CAAC,CAAC;AAEL,QAAM,UAAU,YAAY,MAAM;AAChC,aAAS,IAAI;AAAA,EACf,GAAG,CAAC,CAAC;AAEL,QAAM,WAAW,YAAY,MAAM;AACjC,aAAS,KAAK;AAAA,EAChB,GAAG,CAAC,CAAC;AAEL,QAAM,mBAAmB,YAAY,CAAC,aAAsB;AAC1D,aAAS,QAAQ;AAAA,EACnB,GAAG,CAAC,CAAC;AAEL,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,UAAU;AAAA,EACZ;AACF;","names":[]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@usefy/use-toggle",
+  "version": "0.0.2",
+  "description": "A React hook for boolean state management",
+  "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,
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.1",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/react": "^19.0.0",
+    "jsdom": "^27.3.0",
+    "react": "^19.0.0",
+    "rimraf": "^6.0.1",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.16"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/geon0529/usefy.git",
+    "directory": "packages/use-toggle"
+  },
+  "license": "MIT",
+  "keywords": [
+    "react",
+    "hooks",
+    "toggle",
+    "boolean",
+    "state"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist"
+  }
+}