Skip to content

sindresorhus/clipboardy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Oct 23, 2023
06110f3 Â· Oct 23, 2023

History

66 Commits
Oct 27, 2022
Nov 9, 2017
Oct 23, 2023
Nov 9, 2017
Jul 28, 2018
Nov 9, 2017
Nov 9, 2017
Oct 13, 2021
Oct 23, 2023
Oct 13, 2021
Oct 23, 2023
Oct 13, 2021
Oct 13, 2021
Oct 23, 2023
Aug 15, 2023
Oct 13, 2021

Repository files navigation

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