super-copy

A lightweight utility for interacting with the clipboard. This tool allows you to copy text or images to the clipboard, paste content from the clipboard, and read clipboard data. It supports modern Clipboard APIs and provides fallbacks for older browsers.

Features

• Copy text or images to the clipboard.
• Paste content from the clipboard.
• Read clipboard data, including text and images.
• Fallback support for browsers without modern Clipboard APIs.

Installation

Install the package via npm, yarn, or pnpm:

# npm
npm install super-copy

# yarn
yarn add super-copy

# pnpm
pnpm install super-copy

Usage

Importing the Module

import superCopy from "super-copy";

Copying Text

superCopy
    .copy("Hello, World!")
    .then(() => {
        console.log("Text copied successfully!");
    })
    .catch((err) => {
        console.error("Failed to copy text:", err);
    });

Copying Images

const imageBlob = new Blob(
    [
        /* image data */
    ],
    { type: "image/png" }
);
superCopy
    .copy(imageBlob, "image/png")
    .then(() => {
        console.log("Image copied successfully!");
    })
    .catch((err) => {
        console.error("Failed to copy image:", err);
    });

Pasting Content

superCopy
    .paste()
    .then((result) => {
        if (result instanceof Image) {
            document.body.appendChild(result); // Append the image to the DOM
        } else {
            console.log("Pasted text:", result);
        }
    })
    .catch((err) => {
        console.error("Failed to paste content:", err);
    });

Reading Clipboard Data

superCopy
    .read()
    .then((result) => {
        if (result instanceof Image) {
            document.body.appendChild(result); // Append the image to the DOM
        } else {
            console.log("Read text:", result);
        }
    })
    .catch((err) => {
        console.error("Failed to read clipboard data:", err);
    });

Browser Compatibility

This library uses the modern Clipboard API where available and falls back to older methods for unsupported browsers. Note that some features, such as reading images, require HTTPS or localhost and may not work in all browsers.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests on GitHub.

License

This project is licensed under the ISC License. See the LICENSE file for details.

Author

Developed by win.

Repository

GitHub: https://github.com/wincentor/super-copy

Keywords

• clipboard
• copy
• paste
• JavaScript