mirror of
https://github.com/tauri-apps/plugins-workspace.git
synced 2026-05-25 13:17:47 +02:00
Amr Bashir
62dafda652
* feat(global-shortcut): add `GlobalShortcutExt::register_with_handler` ref: https://github.com/tauri-apps/plugins-workspace/issues/965 * clippy * refactor apis to take closure by default * change file * Update .changes/global-shortcut-refactor.md Co-authored-by: Simon Hyll <hyllsimon@gmail.com> * Update global-shortcut-refactor.md * use option instead * clippy * update readme * on_shortcut and with_shortcut * map handler * simplify events * lint --------- Co-authored-by: Simon Hyll <hyllsimon@gmail.com> Co-authored-by: Lucas Nogueira <lucas@tauri.studio>
119 lines
3.9 KiB
Markdown
119 lines
3.9 KiB
Markdown
|
|
|
|
Register global shortcuts.
|
|
|
|
- Supported platforms: Windows, Linux and macOS.
|
|
|
|
## Install
|
|
|
|
_This plugin requires a Rust version of at least **1.75**_
|
|
|
|
There are three general methods of installation that we can recommend.
|
|
|
|
1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
|
|
2. Pull sources directly from Github using git tags / revision hashes (most secure)
|
|
3. 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`
|
|
|
|
```toml
|
|
# you can add the dependencies on the `[dependencies]` section if you do not target mobile
|
|
[target."cfg(not(any(target_os = \"android\", target_os = \"ios\")))".dependencies]
|
|
tauri-plugin-global-shortcut = "2.0.0-beta"
|
|
# alternatively with Git:
|
|
tauri-plugin-global-shortcut = { 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.
|
|
|
|
```sh
|
|
pnpm add @tauri-apps/plugin-global-shortcut
|
|
# or
|
|
npm add @tauri-apps/plugin-global-shortcut
|
|
# or
|
|
yarn add @tauri-apps/plugin-global-shortcut
|
|
|
|
# alternatively with Git:
|
|
pnpm add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2
|
|
# or
|
|
npm add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2
|
|
# or
|
|
yarn add https://github.com/tauri-apps/tauri-plugin-global-shortcut#v2
|
|
```
|
|
|
|
## Usage
|
|
|
|
First you need to register the core plugin with Tauri:
|
|
|
|
`src-tauri/src/main.rs`
|
|
|
|
```rust
|
|
fn main() {
|
|
tauri::Builder::default()
|
|
.setup(|app| {
|
|
#[cfg(desktop)]
|
|
{
|
|
use tauri::Manager;
|
|
use tauri_plugin_global_shortcut::{Code, Modifiers};
|
|
|
|
app.handle().plugin(
|
|
tauri_plugin_global_shortcut::Builder::new()
|
|
.with_shortcuts(["ctrl+d", "alt+space"])?
|
|
.with_handler(|app, shortcut| {
|
|
if shortcut.matches(Modifiers::CONTROL, Code::KeyD) {
|
|
let _ = app.emit("shortcut-event", "Ctrl+D triggered");
|
|
}
|
|
if shortcut.matches(Modifiers::ALT, Code::Space) {
|
|
let _ = app.emit("shortcut-event", "Alt+Space triggered");
|
|
}
|
|
})
|
|
.build(),
|
|
)?;
|
|
}
|
|
|
|
Ok(())
|
|
})
|
|
.run(tauri::generate_context!())
|
|
.expect("error while running tauri application");
|
|
}
|
|
```
|
|
|
|
Afterwards all the plugin's APIs are available through the JavaScript bindings:
|
|
|
|
```javascript
|
|
import { register } from "@tauri-apps/plugin-global-shortcut";
|
|
await register("CommandOrControl+Shift+C", () => {
|
|
console.log("Shortcut triggered");
|
|
});
|
|
```
|
|
|
|
## Contributing
|
|
|
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
|
|
|
## Partners
|
|
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="middle">
|
|
<a href="https://crabnebula.dev" target="_blank">
|
|
<img src="https://github.com/tauri-apps/plugins-workspace/raw/v2/.github/sponsors/crabnebula.svg" alt="CrabNebula" width="283">
|
|
</a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
For the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).
|
|
|
|
## License
|
|
|
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
|
|
|
MIT or MIT/Apache 2.0 where applicable.
|