TukanDev
dc6d3321e5
* Implement arboard HTML features (desktop only) and ability to trigger clipboard clear Signed-off-by: TukanDev <contact@tukandev.com> * Update readme of clipboard plugin Signed-off-by: TukanDev <contact@tukandev.com> * Update plugins/clipboard-manager/src/desktop.rs Propagate error for clear as requested Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> * Update plugins/clipboard-manager/guest-js/index.ts Change to camelCase as requested Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> * Update plugins/clipboard-manager/guest-js/index.ts use camelCase here too Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> * Update README.md Revert back as mentioned in HTML PR * Update index.ts After discussion readHtml() is decided to be removed. Will follow and remove corresponding rust side function too. * Strip all other existence of read_html out as determined in HTML support PR conversation Signed-off-by: TukanDev <contact@tukandev.com> * Apply requested changes v2 Signed-off-by: TukanDev <contact@tukandev.com> * pnpm run build and cargo fmt Signed-off-by: TukanDev <contact@tukandev.com> * Update plugins/clipboard-manager/src/mobile.rs fix ci calling Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com> * mobile read_html omg.... Signed-off-by: TukanDev <contact@tukandev.com> * Update plugins/clipboard-manager/src/mobile.rs * pnpm format.... Signed-off-by: TukanDev <contact@tukandev.com> * error on mobile as well * clear on mobile * change file --------- Signed-off-by: TukanDev <contact@tukandev.com>
2.9 KiB
Read and write to the system clipboard.
Install
This plugin requires a Rust version of at least 1.75
There are three general methods of installation that we can recommend.
- Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
- Pull sources directly from Github using git tags / revision hashes (most secure)
- Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your Cargo.toml file:
src-tauri/Cargo.toml
[dependencies]
tauri-plugin-clipboard-manager = "2.0.0-beta"
# alternatively with Git:
tauri-plugin-clipboard-manager = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "v2" }
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.
pnpm add @tauri-apps/plugin-clipboard-manager
# or
npm add @tauri-apps/plugin-clipboard-manager
# or
yarn add @tauri-apps/plugin-clipboard-manager
# alternatively with Git:
pnpm add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
# or
npm add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
# or
yarn add https://github.com/tauri-apps/tauri-plugin-clipboard-manager#v2
Usage
First you need to register the core plugin with Tauri:
src-tauri/src/main.rs
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_clipboard_manager::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import { writeText, readText, writeHtml, readHtml, clear } from "@tauri-apps/plugin-clipboard-manager";
await writeText("Tauri is awesome!");
assert(await readText(), "Tauri is awesome!");
Contributing
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
Partners
|
For the complete list of sponsors please visit our website and Open Collective.
License
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
MIT or MIT/Apache 2.0 where applicable.