59 lines
2.0 KiB
Markdown
59 lines
2.0 KiB
Markdown
# @mariozechner/clipboard
|
|
|
|
> **Fork of [@crosscopy/clipboard](https://github.com/CrossCopy/clipboard)**
|
|
>
|
|
> This fork updates to the latest `clipboard-rs` (0.3.1) and adds musl (Alpine Linux) support.
|
|
> All credit goes to the original authors.
|
|
|
|
|
|
[](https://github.com/badlogic/clipboard/actions/workflows/CI.yml)
|
|
|
|
**NPM Package**: https://www.npmjs.com/package/@mariozechner/clipboard
|
|
|
|
**GitHub**: https://github.com/badlogic/clipboard
|
|
|
|
> This is a clipboard API npm package that allows you to copy and paste data to and from the clipboard.
|
|
> There doesn't seem to be a good clipboard package for node.js (that supports data format beyond text), so I decided to make one.
|
|
> Data Format Supported
|
|
>
|
|
> - Text
|
|
> - Image
|
|
> - Rich Text Format
|
|
> - Files
|
|
> - HTML
|
|
|
|
## Acknowledgements
|
|
|
|
- [ChurchTao/clipboard-rs](https://github.com/ChurchTao/clipboard-rs) is written in rust, which is used to provide the native clipboard support for this package across Linux, Windows and MacOS. This package is basically a wrapper around this rust package.
|
|
- https://crates.io/crates/clipboard-rs
|
|
- [napi.rs](https://napi.rs/) was used to create the node.js addon for this package, so that API calls written in rust can be called from node.js.
|
|
|
|
## API
|
|
|
|
Detailed API function declarations can be found in the [index.d.ts](./index.d.ts).
|
|
|
|
Or you can refer to the source code in [src/lib.rs](./src/lib.rs).
|
|
|
|
## Sample
|
|
|
|
```javascript
|
|
import Clipboard from "@mariozechner/clipboard";
|
|
|
|
console.log(await Clipboard.getText());
|
|
|
|
console.log(await Clipboard.getHtml());
|
|
|
|
if (await Clipboard.hasImage()) {
|
|
console.log(await Clipboard.getImageBase64());
|
|
} else {
|
|
console.log("No Image");
|
|
}
|
|
```
|
|
|
|
## Publish
|
|
|
|
Everything is done with GitHub Action.
|
|
|
|
Run `npm version patch` to bump the version.
|
|
Then `git push --follow-tags` to push the changes and tags to GitHub. GitHub Action will automatically build and publish.
|