0.0.7 • Published 7 months ago

@eviensoft/react-copy-to-clipboard-hook v0.0.7

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

@eviensoft/react-copy-to-clipboard-hook

A simple and lightweight React Hook to copy text to the clipboard, with built-in success and error state tracking.
Perfect for modern React and Next.js applications.


✨ Features

  • šŸ“‹ Copy any text to the user's clipboard
  • āœ… Success and error handling
  • 🪶 Lightweight and dependency-free
  • šŸ›”ļø TypeScript support out of the box
  • šŸš€ Ready for production use

šŸ“¦ Installation

npm install @eviensoft/react-copy-to-clipboard-hook
# or
yarn add @eviensoft/react-copy-to-clipboard-hook
# or
pnpm add @eviensoft/react-copy-to-clipboard-hook

šŸš€ Usage

import { useCopyToClipboard } from '@eviensoft/react-copy-to-clipboard-hook';

export default function CopyExample() {
  const { copy, status } = useCopyToClipboard();

  const handleCopy = () => {
    copy('Hello world from Eviensoft!');
  };

  return (
    <div>
      <button onClick={handleCopy}>Copy Text</button>
      {status.success && <p>āœ… Copied successfully!</p>}
      {status.error && <p>āŒ Error: {status.error}</p>}
    </div>
  );
}

šŸ“š API

const { copy, status } = useCopyToClipboard();

PropertyTypeDescription
copy(text: string) => Promise<void>Function to copy the given text to clipboard.
status{ success: boolean; error: string \| null }Copy operation status.

šŸ›  Example with Auto-Clear Success Message

import { useCopyToClipboard } from '@eviensoft/react-copy-to-clipboard-hook';
import { useEffect } from 'react';

export default function AutoClearExample() {
  const { copy, status } = useCopyToClipboard();

  useEffect(() => {
    if (status.success) {
      const timer = setTimeout(() => {
        // Optionally reset success after 3 seconds
      }, 3000);
      return () => clearTimeout(timer);
    }
  }, [status.success]);

  return (
    <div>
      <button onClick={() => copy('Copied with Auto Clear!')}>Copy</button>
      {status.success && <p>āœ… Copied!</p>}
    </div>
  );
}

You can extend this hook easily with auto-reset, toast notifications, or more advanced error handling as needed!


šŸ“„ License

This project is licensed under the MIT License.


šŸ¢ About Eviensoft

At Eviensoft, we build lightweight, production-grade tools for modern web developers.
Feel free to check out more packages and tools soon!


šŸ”„ Quick Summary Table (for your npm page)

SectionInfo
Name@eviensoft/react-copy-to-clipboard-hook
TypeReact Hook
LanguageTypeScript
SizeVery lightweight
UsageCopy text to clipboard easily
MaintainerEviensoft
0.0.7

7 months ago

0.0.6

7 months ago

0.0.5

7 months ago

0.0.4

7 months ago

0.0.3

7 months ago

0.0.2

7 months ago

0.0.1

7 months ago