@usefy/use-copy-to-clipboard 0.0.7

package/dist/index.d.mts

@@ -0,0 +1,77 @@
+/**
+ * Options for useCopyToClipboard hook
+ */
+interface UseCopyToClipboardOptions {
+    /**
+     * Time in milliseconds before the copied state resets to null.
+     * Set to 0 to disable auto-reset.
+     * @default 2000
+     */
+    timeout?: number;
+    /**
+     * Callback function called when copy succeeds
+     * @param text - The text that was copied
+     */
+    onSuccess?: (text: string) => void;
+    /**
+     * Callback function called when copy fails
+     * @param error - The error that occurred
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Type for the copy function
+ */
+type CopyFn = (text: string) => Promise<boolean>;
+/**
+ * Return type for useCopyToClipboard hook
+ * Tuple format: [copiedText, copy]
+ */
+type UseCopyToClipboardReturn = [
+    copiedText: string | null,
+    copy: CopyFn
+];
+/**
+ * Copies text to clipboard using the Clipboard API with fallback support.
+ * Returns the copied text (or null if not copied) and a copy function.
+ *
+ * @param options - Configuration options for the hook
+ * @returns Tuple of [copiedText, copy]
+ *
+ * @example
+ * ```tsx
+ * function CopyButton() {
+ *   const [copiedText, copy] = useCopyToClipboard();
+ *
+ *   return (
+ *     <button onClick={() => copy("Hello World")}>
+ *       {copiedText ? "Copied!" : "Copy"}
+ *     </button>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With custom timeout
+ * const [copiedText, copy] = useCopyToClipboard({ timeout: 3000 });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With callbacks
+ * const [copiedText, copy] = useCopyToClipboard({
+ *   onSuccess: (text) => console.log(`Copied: ${text}`),
+ *   onError: (error) => console.error(`Failed to copy: ${error.message}`),
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Disable auto-reset
+ * const [copiedText, copy] = useCopyToClipboard({ timeout: 0 });
+ * ```
+ */
+declare function useCopyToClipboard(options?: UseCopyToClipboardOptions): UseCopyToClipboardReturn;
+
+export { type CopyFn, type UseCopyToClipboardOptions, type UseCopyToClipboardReturn, useCopyToClipboard };

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+/**
+ * Options for useCopyToClipboard hook
+ */
+interface UseCopyToClipboardOptions {
+    /**
+     * Time in milliseconds before the copied state resets to null.
+     * Set to 0 to disable auto-reset.
+     * @default 2000
+     */
+    timeout?: number;
+    /**
+     * Callback function called when copy succeeds
+     * @param text - The text that was copied
+     */
+    onSuccess?: (text: string) => void;
+    /**
+     * Callback function called when copy fails
+     * @param error - The error that occurred
+     */
+    onError?: (error: Error) => void;
+}
+/**
+ * Type for the copy function
+ */
+type CopyFn = (text: string) => Promise<boolean>;
+/**
+ * Return type for useCopyToClipboard hook
+ * Tuple format: [copiedText, copy]
+ */
+type UseCopyToClipboardReturn = [
+    copiedText: string | null,
+    copy: CopyFn
+];
+/**
+ * Copies text to clipboard using the Clipboard API with fallback support.
+ * Returns the copied text (or null if not copied) and a copy function.
+ *
+ * @param options - Configuration options for the hook
+ * @returns Tuple of [copiedText, copy]
+ *
+ * @example
+ * ```tsx
+ * function CopyButton() {
+ *   const [copiedText, copy] = useCopyToClipboard();
+ *
+ *   return (
+ *     <button onClick={() => copy("Hello World")}>
+ *       {copiedText ? "Copied!" : "Copy"}
+ *     </button>
+ *   );
+ * }
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With custom timeout
+ * const [copiedText, copy] = useCopyToClipboard({ timeout: 3000 });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With callbacks
+ * const [copiedText, copy] = useCopyToClipboard({
+ *   onSuccess: (text) => console.log(`Copied: ${text}`),
+ *   onError: (error) => console.error(`Failed to copy: ${error.message}`),
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // Disable auto-reset
+ * const [copiedText, copy] = useCopyToClipboard({ timeout: 0 });
+ * ```
+ */
+declare function useCopyToClipboard(options?: UseCopyToClipboardOptions): UseCopyToClipboardReturn;
+
+export { type CopyFn, type UseCopyToClipboardOptions, type UseCopyToClipboardReturn, useCopyToClipboard };

package/dist/index.js

@@ -0,0 +1,126 @@
+"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, {
+  useCopyToClipboard: () => useCopyToClipboard
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/useCopyToClipboard.ts
+var import_react = require("react");
+function fallbackCopyToClipboard(text) {
+  if (typeof document === "undefined") {
+    return false;
+  }
+  const textarea = document.createElement("textarea");
+  textarea.value = text;
+  textarea.style.cssText = "position:fixed;left:-9999px;top:-9999px;opacity:0;pointer-events:none";
+  textarea.setAttribute("readonly", "");
+  textarea.setAttribute("aria-hidden", "true");
+  document.body.appendChild(textarea);
+  textarea.focus();
+  textarea.select();
+  textarea.setSelectionRange(0, text.length);
+  let success = false;
+  try {
+    success = document.execCommand("copy");
+  } catch {
+    success = false;
+  }
+  document.body.removeChild(textarea);
+  return success;
+}
+function useCopyToClipboard(options = {}) {
+  const { timeout = 2e3, onSuccess, onError } = options;
+  const [copiedText, setCopiedText] = (0, import_react.useState)(null);
+  const timeoutRef = (0, import_react.useRef)(
+    void 0
+  );
+  const onSuccessRef = (0, import_react.useRef)(onSuccess);
+  const onErrorRef = (0, import_react.useRef)(onError);
+  const timeoutValueRef = (0, import_react.useRef)(timeout);
+  onSuccessRef.current = onSuccess;
+  onErrorRef.current = onError;
+  timeoutValueRef.current = timeout;
+  (0, import_react.useEffect)(() => {
+    return () => {
+      if (timeoutRef.current !== void 0) {
+        clearTimeout(timeoutRef.current);
+      }
+    };
+  }, []);
+  const copy = (0, import_react.useCallback)(async (text) => {
+    if (timeoutRef.current !== void 0) {
+      clearTimeout(timeoutRef.current);
+      timeoutRef.current = void 0;
+    }
+    if (typeof window === "undefined") {
+      const error = new Error("Clipboard is not available in this environment");
+      onErrorRef.current?.(error);
+      return false;
+    }
+    try {
+      if (navigator.clipboard && typeof navigator.clipboard.writeText === "function") {
+        await navigator.clipboard.writeText(text);
+      } else {
+        const success = fallbackCopyToClipboard(text);
+        if (!success) {
+          throw new Error("Failed to copy text using fallback method");
+        }
+      }
+      setCopiedText(text);
+      onSuccessRef.current?.(text);
+      if (timeoutValueRef.current > 0) {
+        timeoutRef.current = setTimeout(() => {
+          setCopiedText(null);
+          timeoutRef.current = void 0;
+        }, timeoutValueRef.current);
+      }
+      return true;
+    } catch (err) {
+      try {
+        const success = fallbackCopyToClipboard(text);
+        if (success) {
+          setCopiedText(text);
+          onSuccessRef.current?.(text);
+          if (timeoutValueRef.current > 0) {
+            timeoutRef.current = setTimeout(() => {
+              setCopiedText(null);
+              timeoutRef.current = void 0;
+            }, timeoutValueRef.current);
+          }
+          return true;
+        }
+      } catch {
+      }
+      const error = err instanceof Error ? err : new Error("Failed to copy text to clipboard");
+      setCopiedText(null);
+      onErrorRef.current?.(error);
+      return false;
+    }
+  }, []);
+  return [copiedText, copy];
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  useCopyToClipboard
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/useCopyToClipboard.ts"],"sourcesContent":["export {\r\n  useCopyToClipboard,\r\n  type UseCopyToClipboardOptions,\r\n  type UseCopyToClipboardReturn,\r\n  type CopyFn,\r\n} from \"./useCopyToClipboard\";\r\n","import { useCallback, useEffect, useRef, useState } from \"react\";\r\n\r\n/**\r\n * Options for useCopyToClipboard hook\r\n */\r\nexport interface UseCopyToClipboardOptions {\r\n  /**\r\n   * Time in milliseconds before the copied state resets to null.\r\n   * Set to 0 to disable auto-reset.\r\n   * @default 2000\r\n   */\r\n  timeout?: number;\r\n  /**\r\n   * Callback function called when copy succeeds\r\n   * @param text - The text that was copied\r\n   */\r\n  onSuccess?: (text: string) => void;\r\n  /**\r\n   * Callback function called when copy fails\r\n   * @param error - The error that occurred\r\n   */\r\n  onError?: (error: Error) => void;\r\n}\r\n\r\n/**\r\n * Type for the copy function\r\n */\r\nexport type CopyFn = (text: string) => Promise<boolean>;\r\n\r\n/**\r\n * Return type for useCopyToClipboard hook\r\n * Tuple format: [copiedText, copy]\r\n */\r\nexport type UseCopyToClipboardReturn = [\r\n  copiedText: string | null,\r\n  copy: CopyFn\r\n];\r\n\r\n/**\r\n * Fallback copy function for browsers that don't support the Clipboard API\r\n * @param text - Text to copy to clipboard\r\n * @returns Whether the copy was successful\r\n */\r\nfunction fallbackCopyToClipboard(text: string): boolean {\r\n  // Check if we're in a browser environment\r\n  if (typeof document === \"undefined\") {\r\n    return false;\r\n  }\r\n\r\n  const textarea = document.createElement(\"textarea\");\r\n  textarea.value = text;\r\n\r\n  // Make the textarea invisible but still functional\r\n  textarea.style.cssText =\r\n    \"position:fixed;left:-9999px;top:-9999px;opacity:0;pointer-events:none\";\r\n  textarea.setAttribute(\"readonly\", \"\");\r\n  textarea.setAttribute(\"aria-hidden\", \"true\");\r\n\r\n  document.body.appendChild(textarea);\r\n\r\n  // Select the text\r\n  textarea.focus();\r\n  textarea.select();\r\n\r\n  // For mobile devices\r\n  textarea.setSelectionRange(0, text.length);\r\n\r\n  let success = false;\r\n  try {\r\n    success = document.execCommand(\"copy\");\r\n  } catch {\r\n    success = false;\r\n  }\r\n\r\n  document.body.removeChild(textarea);\r\n  return success;\r\n}\r\n\r\n/**\r\n * Copies text to clipboard using the Clipboard API with fallback support.\r\n * Returns the copied text (or null if not copied) and a copy function.\r\n *\r\n * @param options - Configuration options for the hook\r\n * @returns Tuple of [copiedText, copy]\r\n *\r\n * @example\r\n * ```tsx\r\n * function CopyButton() {\r\n *   const [copiedText, copy] = useCopyToClipboard();\r\n *\r\n *   return (\r\n *     <button onClick={() => copy(\"Hello World\")}>\r\n *       {copiedText ? \"Copied!\" : \"Copy\"}\r\n *     </button>\r\n *   );\r\n * }\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With custom timeout\r\n * const [copiedText, copy] = useCopyToClipboard({ timeout: 3000 });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With callbacks\r\n * const [copiedText, copy] = useCopyToClipboard({\r\n *   onSuccess: (text) => console.log(`Copied: ${text}`),\r\n *   onError: (error) => console.error(`Failed to copy: ${error.message}`),\r\n * });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // Disable auto-reset\r\n * const [copiedText, copy] = useCopyToClipboard({ timeout: 0 });\r\n * ```\r\n */\r\nexport function useCopyToClipboard(\r\n  options: UseCopyToClipboardOptions = {}\r\n): UseCopyToClipboardReturn {\r\n  const { timeout = 2000, onSuccess, onError } = options;\r\n\r\n  const [copiedText, setCopiedText] = useState<string | null>(null);\r\n  const timeoutRef = useRef<ReturnType<typeof setTimeout> | undefined>(\r\n    undefined\r\n  );\r\n\r\n  // Store callbacks in refs to avoid dependency issues\r\n  const onSuccessRef = useRef(onSuccess);\r\n  const onErrorRef = useRef(onError);\r\n  const timeoutValueRef = useRef(timeout);\r\n\r\n  // Update refs when options change\r\n  onSuccessRef.current = onSuccess;\r\n  onErrorRef.current = onError;\r\n  timeoutValueRef.current = timeout;\r\n\r\n  // Cleanup timeout on unmount\r\n  useEffect(() => {\r\n    return () => {\r\n      if (timeoutRef.current !== undefined) {\r\n        clearTimeout(timeoutRef.current);\r\n      }\r\n    };\r\n  }, []);\r\n\r\n  const copy: CopyFn = useCallback(async (text: string): Promise<boolean> => {\r\n    // Clear any existing timeout\r\n    if (timeoutRef.current !== undefined) {\r\n      clearTimeout(timeoutRef.current);\r\n      timeoutRef.current = undefined;\r\n    }\r\n\r\n    // Check for SSR\r\n    if (typeof window === \"undefined\") {\r\n      const error = new Error(\"Clipboard is not available in this environment\");\r\n      onErrorRef.current?.(error);\r\n      return false;\r\n    }\r\n\r\n    try {\r\n      // Try the modern Clipboard API first\r\n      if (navigator.clipboard && typeof navigator.clipboard.writeText === \"function\") {\r\n        await navigator.clipboard.writeText(text);\r\n      } else {\r\n        // Fall back to execCommand\r\n        const success = fallbackCopyToClipboard(text);\r\n        if (!success) {\r\n          throw new Error(\"Failed to copy text using fallback method\");\r\n        }\r\n      }\r\n\r\n      // Success\r\n      setCopiedText(text);\r\n      onSuccessRef.current?.(text);\r\n\r\n      // Set timeout for auto-reset if enabled\r\n      if (timeoutValueRef.current > 0) {\r\n        timeoutRef.current = setTimeout(() => {\r\n          setCopiedText(null);\r\n          timeoutRef.current = undefined;\r\n        }, timeoutValueRef.current);\r\n      }\r\n\r\n      return true;\r\n    } catch (err) {\r\n      // Try fallback if Clipboard API failed\r\n      try {\r\n        const success = fallbackCopyToClipboard(text);\r\n        if (success) {\r\n          setCopiedText(text);\r\n          onSuccessRef.current?.(text);\r\n\r\n          if (timeoutValueRef.current > 0) {\r\n            timeoutRef.current = setTimeout(() => {\r\n              setCopiedText(null);\r\n              timeoutRef.current = undefined;\r\n            }, timeoutValueRef.current);\r\n          }\r\n\r\n          return true;\r\n        }\r\n      } catch {\r\n        // Fallback also failed\r\n      }\r\n\r\n      // Both methods failed\r\n      const error =\r\n        err instanceof Error ? err : new Error(\"Failed to copy text to clipboard\");\r\n      setCopiedText(null);\r\n      onErrorRef.current?.(error);\r\n      return false;\r\n    }\r\n  }, []);\r\n\r\n  return [copiedText, copy];\r\n}\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAyD;AA2CzD,SAAS,wBAAwB,MAAuB;AAEtD,MAAI,OAAO,aAAa,aAAa;AACnC,WAAO;AAAA,EACT;AAEA,QAAM,WAAW,SAAS,cAAc,UAAU;AAClD,WAAS,QAAQ;AAGjB,WAAS,MAAM,UACb;AACF,WAAS,aAAa,YAAY,EAAE;AACpC,WAAS,aAAa,eAAe,MAAM;AAE3C,WAAS,KAAK,YAAY,QAAQ;AAGlC,WAAS,MAAM;AACf,WAAS,OAAO;AAGhB,WAAS,kBAAkB,GAAG,KAAK,MAAM;AAEzC,MAAI,UAAU;AACd,MAAI;AACF,cAAU,SAAS,YAAY,MAAM;AAAA,EACvC,QAAQ;AACN,cAAU;AAAA,EACZ;AAEA,WAAS,KAAK,YAAY,QAAQ;AAClC,SAAO;AACT;AA2CO,SAAS,mBACd,UAAqC,CAAC,GACZ;AAC1B,QAAM,EAAE,UAAU,KAAM,WAAW,QAAQ,IAAI;AAE/C,QAAM,CAAC,YAAY,aAAa,QAAI,uBAAwB,IAAI;AAChE,QAAM,iBAAa;AAAA,IACjB;AAAA,EACF;AAGA,QAAM,mBAAe,qBAAO,SAAS;AACrC,QAAM,iBAAa,qBAAO,OAAO;AACjC,QAAM,sBAAkB,qBAAO,OAAO;AAGtC,eAAa,UAAU;AACvB,aAAW,UAAU;AACrB,kBAAgB,UAAU;AAG1B,8BAAU,MAAM;AACd,WAAO,MAAM;AACX,UAAI,WAAW,YAAY,QAAW;AACpC,qBAAa,WAAW,OAAO;AAAA,MACjC;AAAA,IACF;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,WAAe,0BAAY,OAAO,SAAmC;AAEzE,QAAI,WAAW,YAAY,QAAW;AACpC,mBAAa,WAAW,OAAO;AAC/B,iBAAW,UAAU;AAAA,IACvB;AAGA,QAAI,OAAO,WAAW,aAAa;AACjC,YAAM,QAAQ,IAAI,MAAM,gDAAgD;AACxE,iBAAW,UAAU,KAAK;AAC1B,aAAO;AAAA,IACT;AAEA,QAAI;AAEF,UAAI,UAAU,aAAa,OAAO,UAAU,UAAU,cAAc,YAAY;AAC9E,cAAM,UAAU,UAAU,UAAU,IAAI;AAAA,MAC1C,OAAO;AAEL,cAAM,UAAU,wBAAwB,IAAI;AAC5C,YAAI,CAAC,SAAS;AACZ,gBAAM,IAAI,MAAM,2CAA2C;AAAA,QAC7D;AAAA,MACF;AAGA,oBAAc,IAAI;AAClB,mBAAa,UAAU,IAAI;AAG3B,UAAI,gBAAgB,UAAU,GAAG;AAC/B,mBAAW,UAAU,WAAW,MAAM;AACpC,wBAAc,IAAI;AAClB,qBAAW,UAAU;AAAA,QACvB,GAAG,gBAAgB,OAAO;AAAA,MAC5B;AAEA,aAAO;AAAA,IACT,SAAS,KAAK;AAEZ,UAAI;AACF,cAAM,UAAU,wBAAwB,IAAI;AAC5C,YAAI,SAAS;AACX,wBAAc,IAAI;AAClB,uBAAa,UAAU,IAAI;AAE3B,cAAI,gBAAgB,UAAU,GAAG;AAC/B,uBAAW,UAAU,WAAW,MAAM;AACpC,4BAAc,IAAI;AAClB,yBAAW,UAAU;AAAA,YACvB,GAAG,gBAAgB,OAAO;AAAA,UAC5B;AAEA,iBAAO;AAAA,QACT;AAAA,MACF,QAAQ;AAAA,MAER;AAGA,YAAM,QACJ,eAAe,QAAQ,MAAM,IAAI,MAAM,kCAAkC;AAC3E,oBAAc,IAAI;AAClB,iBAAW,UAAU,KAAK;AAC1B,aAAO;AAAA,IACT;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,CAAC,YAAY,IAAI;AAC1B;","names":[]}

package/dist/index.mjs

@@ -0,0 +1,99 @@
+// src/useCopyToClipboard.ts
+import { useCallback, useEffect, useRef, useState } from "react";
+function fallbackCopyToClipboard(text) {
+  if (typeof document === "undefined") {
+    return false;
+  }
+  const textarea = document.createElement("textarea");
+  textarea.value = text;
+  textarea.style.cssText = "position:fixed;left:-9999px;top:-9999px;opacity:0;pointer-events:none";
+  textarea.setAttribute("readonly", "");
+  textarea.setAttribute("aria-hidden", "true");
+  document.body.appendChild(textarea);
+  textarea.focus();
+  textarea.select();
+  textarea.setSelectionRange(0, text.length);
+  let success = false;
+  try {
+    success = document.execCommand("copy");
+  } catch {
+    success = false;
+  }
+  document.body.removeChild(textarea);
+  return success;
+}
+function useCopyToClipboard(options = {}) {
+  const { timeout = 2e3, onSuccess, onError } = options;
+  const [copiedText, setCopiedText] = useState(null);
+  const timeoutRef = useRef(
+    void 0
+  );
+  const onSuccessRef = useRef(onSuccess);
+  const onErrorRef = useRef(onError);
+  const timeoutValueRef = useRef(timeout);
+  onSuccessRef.current = onSuccess;
+  onErrorRef.current = onError;
+  timeoutValueRef.current = timeout;
+  useEffect(() => {
+    return () => {
+      if (timeoutRef.current !== void 0) {
+        clearTimeout(timeoutRef.current);
+      }
+    };
+  }, []);
+  const copy = useCallback(async (text) => {
+    if (timeoutRef.current !== void 0) {
+      clearTimeout(timeoutRef.current);
+      timeoutRef.current = void 0;
+    }
+    if (typeof window === "undefined") {
+      const error = new Error("Clipboard is not available in this environment");
+      onErrorRef.current?.(error);
+      return false;
+    }
+    try {
+      if (navigator.clipboard && typeof navigator.clipboard.writeText === "function") {
+        await navigator.clipboard.writeText(text);
+      } else {
+        const success = fallbackCopyToClipboard(text);
+        if (!success) {
+          throw new Error("Failed to copy text using fallback method");
+        }
+      }
+      setCopiedText(text);
+      onSuccessRef.current?.(text);
+      if (timeoutValueRef.current > 0) {
+        timeoutRef.current = setTimeout(() => {
+          setCopiedText(null);
+          timeoutRef.current = void 0;
+        }, timeoutValueRef.current);
+      }
+      return true;
+    } catch (err) {
+      try {
+        const success = fallbackCopyToClipboard(text);
+        if (success) {
+          setCopiedText(text);
+          onSuccessRef.current?.(text);
+          if (timeoutValueRef.current > 0) {
+            timeoutRef.current = setTimeout(() => {
+              setCopiedText(null);
+              timeoutRef.current = void 0;
+            }, timeoutValueRef.current);
+          }
+          return true;
+        }
+      } catch {
+      }
+      const error = err instanceof Error ? err : new Error("Failed to copy text to clipboard");
+      setCopiedText(null);
+      onErrorRef.current?.(error);
+      return false;
+    }
+  }, []);
+  return [copiedText, copy];
+}
+export {
+  useCopyToClipboard
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/useCopyToClipboard.ts"],"sourcesContent":["import { useCallback, useEffect, useRef, useState } from \"react\";\r\n\r\n/**\r\n * Options for useCopyToClipboard hook\r\n */\r\nexport interface UseCopyToClipboardOptions {\r\n  /**\r\n   * Time in milliseconds before the copied state resets to null.\r\n   * Set to 0 to disable auto-reset.\r\n   * @default 2000\r\n   */\r\n  timeout?: number;\r\n  /**\r\n   * Callback function called when copy succeeds\r\n   * @param text - The text that was copied\r\n   */\r\n  onSuccess?: (text: string) => void;\r\n  /**\r\n   * Callback function called when copy fails\r\n   * @param error - The error that occurred\r\n   */\r\n  onError?: (error: Error) => void;\r\n}\r\n\r\n/**\r\n * Type for the copy function\r\n */\r\nexport type CopyFn = (text: string) => Promise<boolean>;\r\n\r\n/**\r\n * Return type for useCopyToClipboard hook\r\n * Tuple format: [copiedText, copy]\r\n */\r\nexport type UseCopyToClipboardReturn = [\r\n  copiedText: string | null,\r\n  copy: CopyFn\r\n];\r\n\r\n/**\r\n * Fallback copy function for browsers that don't support the Clipboard API\r\n * @param text - Text to copy to clipboard\r\n * @returns Whether the copy was successful\r\n */\r\nfunction fallbackCopyToClipboard(text: string): boolean {\r\n  // Check if we're in a browser environment\r\n  if (typeof document === \"undefined\") {\r\n    return false;\r\n  }\r\n\r\n  const textarea = document.createElement(\"textarea\");\r\n  textarea.value = text;\r\n\r\n  // Make the textarea invisible but still functional\r\n  textarea.style.cssText =\r\n    \"position:fixed;left:-9999px;top:-9999px;opacity:0;pointer-events:none\";\r\n  textarea.setAttribute(\"readonly\", \"\");\r\n  textarea.setAttribute(\"aria-hidden\", \"true\");\r\n\r\n  document.body.appendChild(textarea);\r\n\r\n  // Select the text\r\n  textarea.focus();\r\n  textarea.select();\r\n\r\n  // For mobile devices\r\n  textarea.setSelectionRange(0, text.length);\r\n\r\n  let success = false;\r\n  try {\r\n    success = document.execCommand(\"copy\");\r\n  } catch {\r\n    success = false;\r\n  }\r\n\r\n  document.body.removeChild(textarea);\r\n  return success;\r\n}\r\n\r\n/**\r\n * Copies text to clipboard using the Clipboard API with fallback support.\r\n * Returns the copied text (or null if not copied) and a copy function.\r\n *\r\n * @param options - Configuration options for the hook\r\n * @returns Tuple of [copiedText, copy]\r\n *\r\n * @example\r\n * ```tsx\r\n * function CopyButton() {\r\n *   const [copiedText, copy] = useCopyToClipboard();\r\n *\r\n *   return (\r\n *     <button onClick={() => copy(\"Hello World\")}>\r\n *       {copiedText ? \"Copied!\" : \"Copy\"}\r\n *     </button>\r\n *   );\r\n * }\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With custom timeout\r\n * const [copiedText, copy] = useCopyToClipboard({ timeout: 3000 });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // With callbacks\r\n * const [copiedText, copy] = useCopyToClipboard({\r\n *   onSuccess: (text) => console.log(`Copied: ${text}`),\r\n *   onError: (error) => console.error(`Failed to copy: ${error.message}`),\r\n * });\r\n * ```\r\n *\r\n * @example\r\n * ```tsx\r\n * // Disable auto-reset\r\n * const [copiedText, copy] = useCopyToClipboard({ timeout: 0 });\r\n * ```\r\n */\r\nexport function useCopyToClipboard(\r\n  options: UseCopyToClipboardOptions = {}\r\n): UseCopyToClipboardReturn {\r\n  const { timeout = 2000, onSuccess, onError } = options;\r\n\r\n  const [copiedText, setCopiedText] = useState<string | null>(null);\r\n  const timeoutRef = useRef<ReturnType<typeof setTimeout> | undefined>(\r\n    undefined\r\n  );\r\n\r\n  // Store callbacks in refs to avoid dependency issues\r\n  const onSuccessRef = useRef(onSuccess);\r\n  const onErrorRef = useRef(onError);\r\n  const timeoutValueRef = useRef(timeout);\r\n\r\n  // Update refs when options change\r\n  onSuccessRef.current = onSuccess;\r\n  onErrorRef.current = onError;\r\n  timeoutValueRef.current = timeout;\r\n\r\n  // Cleanup timeout on unmount\r\n  useEffect(() => {\r\n    return () => {\r\n      if (timeoutRef.current !== undefined) {\r\n        clearTimeout(timeoutRef.current);\r\n      }\r\n    };\r\n  }, []);\r\n\r\n  const copy: CopyFn = useCallback(async (text: string): Promise<boolean> => {\r\n    // Clear any existing timeout\r\n    if (timeoutRef.current !== undefined) {\r\n      clearTimeout(timeoutRef.current);\r\n      timeoutRef.current = undefined;\r\n    }\r\n\r\n    // Check for SSR\r\n    if (typeof window === \"undefined\") {\r\n      const error = new Error(\"Clipboard is not available in this environment\");\r\n      onErrorRef.current?.(error);\r\n      return false;\r\n    }\r\n\r\n    try {\r\n      // Try the modern Clipboard API first\r\n      if (navigator.clipboard && typeof navigator.clipboard.writeText === \"function\") {\r\n        await navigator.clipboard.writeText(text);\r\n      } else {\r\n        // Fall back to execCommand\r\n        const success = fallbackCopyToClipboard(text);\r\n        if (!success) {\r\n          throw new Error(\"Failed to copy text using fallback method\");\r\n        }\r\n      }\r\n\r\n      // Success\r\n      setCopiedText(text);\r\n      onSuccessRef.current?.(text);\r\n\r\n      // Set timeout for auto-reset if enabled\r\n      if (timeoutValueRef.current > 0) {\r\n        timeoutRef.current = setTimeout(() => {\r\n          setCopiedText(null);\r\n          timeoutRef.current = undefined;\r\n        }, timeoutValueRef.current);\r\n      }\r\n\r\n      return true;\r\n    } catch (err) {\r\n      // Try fallback if Clipboard API failed\r\n      try {\r\n        const success = fallbackCopyToClipboard(text);\r\n        if (success) {\r\n          setCopiedText(text);\r\n          onSuccessRef.current?.(text);\r\n\r\n          if (timeoutValueRef.current > 0) {\r\n            timeoutRef.current = setTimeout(() => {\r\n              setCopiedText(null);\r\n              timeoutRef.current = undefined;\r\n            }, timeoutValueRef.current);\r\n          }\r\n\r\n          return true;\r\n        }\r\n      } catch {\r\n        // Fallback also failed\r\n      }\r\n\r\n      // Both methods failed\r\n      const error =\r\n        err instanceof Error ? err : new Error(\"Failed to copy text to clipboard\");\r\n      setCopiedText(null);\r\n      onErrorRef.current?.(error);\r\n      return false;\r\n    }\r\n  }, []);\r\n\r\n  return [copiedText, copy];\r\n}\r\n"],"mappings":";AAAA,SAAS,aAAa,WAAW,QAAQ,gBAAgB;AA2CzD,SAAS,wBAAwB,MAAuB;AAEtD,MAAI,OAAO,aAAa,aAAa;AACnC,WAAO;AAAA,EACT;AAEA,QAAM,WAAW,SAAS,cAAc,UAAU;AAClD,WAAS,QAAQ;AAGjB,WAAS,MAAM,UACb;AACF,WAAS,aAAa,YAAY,EAAE;AACpC,WAAS,aAAa,eAAe,MAAM;AAE3C,WAAS,KAAK,YAAY,QAAQ;AAGlC,WAAS,MAAM;AACf,WAAS,OAAO;AAGhB,WAAS,kBAAkB,GAAG,KAAK,MAAM;AAEzC,MAAI,UAAU;AACd,MAAI;AACF,cAAU,SAAS,YAAY,MAAM;AAAA,EACvC,QAAQ;AACN,cAAU;AAAA,EACZ;AAEA,WAAS,KAAK,YAAY,QAAQ;AAClC,SAAO;AACT;AA2CO,SAAS,mBACd,UAAqC,CAAC,GACZ;AAC1B,QAAM,EAAE,UAAU,KAAM,WAAW,QAAQ,IAAI;AAE/C,QAAM,CAAC,YAAY,aAAa,IAAI,SAAwB,IAAI;AAChE,QAAM,aAAa;AAAA,IACjB;AAAA,EACF;AAGA,QAAM,eAAe,OAAO,SAAS;AACrC,QAAM,aAAa,OAAO,OAAO;AACjC,QAAM,kBAAkB,OAAO,OAAO;AAGtC,eAAa,UAAU;AACvB,aAAW,UAAU;AACrB,kBAAgB,UAAU;AAG1B,YAAU,MAAM;AACd,WAAO,MAAM;AACX,UAAI,WAAW,YAAY,QAAW;AACpC,qBAAa,WAAW,OAAO;AAAA,MACjC;AAAA,IACF;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,QAAM,OAAe,YAAY,OAAO,SAAmC;AAEzE,QAAI,WAAW,YAAY,QAAW;AACpC,mBAAa,WAAW,OAAO;AAC/B,iBAAW,UAAU;AAAA,IACvB;AAGA,QAAI,OAAO,WAAW,aAAa;AACjC,YAAM,QAAQ,IAAI,MAAM,gDAAgD;AACxE,iBAAW,UAAU,KAAK;AAC1B,aAAO;AAAA,IACT;AAEA,QAAI;AAEF,UAAI,UAAU,aAAa,OAAO,UAAU,UAAU,cAAc,YAAY;AAC9E,cAAM,UAAU,UAAU,UAAU,IAAI;AAAA,MAC1C,OAAO;AAEL,cAAM,UAAU,wBAAwB,IAAI;AAC5C,YAAI,CAAC,SAAS;AACZ,gBAAM,IAAI,MAAM,2CAA2C;AAAA,QAC7D;AAAA,MACF;AAGA,oBAAc,IAAI;AAClB,mBAAa,UAAU,IAAI;AAG3B,UAAI,gBAAgB,UAAU,GAAG;AAC/B,mBAAW,UAAU,WAAW,MAAM;AACpC,wBAAc,IAAI;AAClB,qBAAW,UAAU;AAAA,QACvB,GAAG,gBAAgB,OAAO;AAAA,MAC5B;AAEA,aAAO;AAAA,IACT,SAAS,KAAK;AAEZ,UAAI;AACF,cAAM,UAAU,wBAAwB,IAAI;AAC5C,YAAI,SAAS;AACX,wBAAc,IAAI;AAClB,uBAAa,UAAU,IAAI;AAE3B,cAAI,gBAAgB,UAAU,GAAG;AAC/B,uBAAW,UAAU,WAAW,MAAM;AACpC,4BAAc,IAAI;AAClB,yBAAW,UAAU;AAAA,YACvB,GAAG,gBAAgB,OAAO;AAAA,UAC5B;AAEA,iBAAO;AAAA,QACT;AAAA,MACF,QAAQ;AAAA,MAER;AAGA,YAAM,QACJ,eAAe,QAAQ,MAAM,IAAI,MAAM,kCAAkC;AAC3E,oBAAc,IAAI;AAClB,iBAAW,UAAU,KAAK;AAC1B,aAAO;AAAA,IACT;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,CAAC,YAAY,IAAI;AAC1B;","names":[]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@usefy/use-copy-to-clipboard",
+  "version": "0.0.7",
+  "description": "A React hook for copying text to clipboard with fallback support",
+  "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-copy-to-clipboard"
+  },
+  "license": "MIT",
+  "keywords": [
+    "react",
+    "hooks",
+    "clipboard",
+    "copy",
+    "copy-to-clipboard"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist"
+  }
+}