clipboardy
v4.0.0
Published
Access the system clipboard (copy/paste)
Downloads
17,017,601
Maintainers
Readme
clipboardy
Access the system clipboard (copy/paste)
Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with Termux, and modern browsers.
Install
npm install clipboardy
Usage
import clipboard from 'clipboardy';
clipboard.writeSync('🦄');
clipboard.readSync();
//=> '🦄'
API
In the browser, it requires a secure context.
clipboard
.write(text)
Write (copy) to the clipboard asynchronously.
Returns a Promise
.
text
Type: string
The text to write to the clipboard.
.read()
Read (paste) from the clipboard asynchronously.
Returns a Promise
.
.writeSync(text)
Write (copy) to the clipboard synchronously.
Doesn't work in browsers.
text
Type: string
The text to write to the clipboard.
.readSync()
Read (paste) from the clipboard synchronously.
Doesn't work in browsers.
FAQ
Where can I find the source of the bundled binaries?
The Linux binary is just a bundled version of xsel
. The source for the Windows binary can be found here.
Related
- clipboard-cli - CLI for this module
- copy-text-to-clipboard - Copy text to the clipboard in the browser