Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/clipboardy
Access the system clipboard (copy/paste)
https://github.com/sindresorhus/clipboardy
Last synced: 1 day ago
JSON representation
Access the system clipboard (copy/paste)
- Host: GitHub
- URL: https://github.com/sindresorhus/clipboardy
- Owner: sindresorhus
- License: mit
- Created: 2016-12-04T13:14:35.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T08:10:40.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:00:10.642Z (about 1 month ago)
- Language: JavaScript
- Size: 548 KB
- Stars: 1,780
- Watchers: 15
- Forks: 81
- Open Issues: 17
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-cross-platform-nodejs - clipboardy - cli](https://github.com/sindresorhus/clipboard-cli) - Cross-platform copy/paste. (Libraries / Shell)
- awesome-nodejs - clipboardy - Access the system clipboard (copy/paste). (Packages / Miscellaneous)
- awesome-cli - clipboardy - Access the system clipboard (copy/paste). (Helpful)
- awesome-f2e-libs - **clipboardy** - 复制文本到粘贴板。 (命令行 / redux 扩展)
- awesome - sindresorhus/clipboardy - Access the system clipboard (copy/paste) (JavaScript)
- awesome-nodejs - clipboardy - Cross-platform copy/paste.  (Repository / Shell)
- awesome-nodejs-cn - clipboardy - 访问系统的剪贴板 (复制和粘贴) (包 / 其他)
- awesome-nodejs - clipboardy - Access the system clipboard (copy/paste). (Packages / Miscellaneous)
- awesome-node - clipboardy - Access the system clipboard (copy/paste). (Packages / Miscellaneous)
- awesome-nodejs - clipboardy - 访问系统剪切板（copy/paste） (Uncategorized / Uncategorized)
- awesome-star-libs - sindresorhus / clipboardy
- awesome-nodejs-cn - clipboardy - **star:1789** 访问系统剪贴板(复制/粘贴) (包 / 杂项)
- awesome-fe - **clipboardy** - 复制文本到粘贴板。 (命令行 / macros)
- awesome - clipboardy - Access the system clipboard (copy/paste). (Npm)
- awesome-nodejs - clipboardy - Access the system clipboard (copy/paste) - ★ 514 (Miscellaneous)
- awesome-nodejs-new - clipboardy - Access the system clipboard (copy/paste). (Packages / Miscellaneous)
- awesome-web-cn - clipboardy - 一个跨平台的让你访问系统剪切板 (copy/paste) 的库 (Uncategorized / Uncategorized)
README
# clipboardy
> Access the system clipboard (copy/paste)
Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with [Termux](https://termux.com/), and [modern browsers](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#Browser_compatibility).
## Install
```sh
npm install clipboardy
```
## Usage
```js
import clipboard from 'clipboardy';
clipboard.writeSync('🦄');
clipboard.readSync();
//=> '🦄'
```
## API
In the browser, it requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts).
### 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](fallbacks/linux/xsel) is just a bundled version of [`xsel`](https://linux.die.net/man/1/xsel). The source for the [Windows binary](fallbacks/windows/clipboard_x86_64.exe) can be found [here](https://github.com/sindresorhus/win-clipboard).
## Related
- [clipboard-cli](https://github.com/sindresorhus/clipboard-cli) - CLI for this module
- [copy-text-to-clipboard](https://github.com/sindresorhus/copy-text-to-clipboard) - Copy text to the clipboard in the browser