clipboard-copy

What is clipboard-copy?

The clipboard-copy npm package provides a simple and efficient way to copy text to the clipboard in web applications. It is designed to be lightweight and easy to use, making it a popular choice for developers who need to implement clipboard functionality.

What are clipboard-copy's main functionalities?

Copy Text to Clipboard

This feature allows you to copy a given string to the clipboard. The code sample demonstrates how to use the clipboard-copy package to copy the text 'Hello, World!' to the clipboard.

const copy = require('clipboard-copy');
copy('Hello, World!');

Other packages similar to clipboard-copy

clipboard-js

The clipboard-js package provides similar functionality to clipboard-copy, allowing you to copy text to the clipboard. It offers a more comprehensive API with additional features such as reading from the clipboard and handling clipboard events.

copy-to-clipboard

The copy-to-clipboard package is another alternative that provides a simple way to copy text to the clipboard. It is lightweight and easy to use, similar to clipboard-copy, but it also includes support for older browsers.

clipboard-polyfill

The clipboard-polyfill package offers a polyfill for the modern Clipboard API, providing a more robust solution for copying text to the clipboard. It supports both writing to and reading from the clipboard, making it a more versatile option compared to clipboard-copy.

README

clipboard-copy

Lightweight copy to clipboard for the web

The goal of this package is to offer simple copy-to-clipboard functionality in modern web browsers using the fewest bytes. To do so, this package only supports modern browsers. No fallback using Adobe Flash, no hacks. Just 30 lines of code.

Unlike other implementations, text copied with clipboard-copy is clean and unstyled. Copied text will not inherit HTML/CSS styling like the page's background color.

Supported browsers: Chrome, Firefox, Edge, Safari.

Works in the browser with browserify!

install

npm install clipboard-copy

usage

const copy = require('clipboard-copy')

button.addEventListener('click', function () {
  copy('This is some cool text')
})

API

successPromise = copy(text)

Copy the given text to the user's clipboard. Returns successPromise, a promise that resolves if the copy was successful and rejects if the copy failed.

Note: in most browsers, copying to the clipboard is only allowed if copy() is triggered in direct response to a user gesture like a 'click' or a 'keypress'.

comparison to alternatives

• clipboard-copy (this package): 524 B gzipped
• clipboard-js: 1.7 kB gzipped
• clipboard: 3.2 kB gzipped

testing

Testing this module is currently a manual process. Open test.html in your web browser and follow the short instructions. The web page will always load the latest version of the module, no bundling is necessary.

license

MIT. Copyright (c) Feross Aboukhadijeh.