docs(global-shotcut): update docs in README and ts files (#1291)

pull/1293/head
Amr Bashir 1 year ago committed by GitHub
parent 723b9f7fa8
commit 1829c2806a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -63,12 +63,14 @@ fn main() {
app.handle().plugin( app.handle().plugin(
tauri_plugin_global_shortcut::Builder::new() tauri_plugin_global_shortcut::Builder::new()
.with_shortcuts(["ctrl+d", "alt+space"])? .with_shortcuts(["ctrl+d", "alt+space"])?
.with_handler(|app, shortcut| { .with_handler(|app, shortcut, event| {
if shortcut.matches(Modifiers::CONTROL, Code::KeyD) { if event.state == ShortcutState::Preseed {
let _ = app.emit("shortcut-event", "Ctrl+D triggered"); 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"); if shortcut.matches(Modifiers::ALT, Code::Space) {
let _ = app.emit("shortcut-event", "Alt+Space triggered");
}
} }
}) })
.build(), .build(),
@ -86,8 +88,10 @@ Afterwards all the plugin's APIs are available through the JavaScript bindings:
```javascript ```javascript
import { register } from "@tauri-apps/plugin-global-shortcut"; import { register } from "@tauri-apps/plugin-global-shortcut";
await register("CommandOrControl+Shift+C", () => { await register("CommandOrControl+Shift+C", (event) => {
console.log("Shortcut triggered"); if (event.state === "Pressed") {
console.log("Shortcut triggered");
}
}); });
``` ```

@ -23,8 +23,10 @@ export type ShortcutHandler = (event: ShortcutEvent) => void;
* @example * @example
* ```typescript * ```typescript
* import { register } from '@tauri-apps/plugin-global-shortcut'; * import { register } from '@tauri-apps/plugin-global-shortcut';
* await register('CommandOrControl+Shift+C', () => { * await register('CommandOrControl+Shift+C', (event) => {
* console.log('Shortcut triggered'); * if (event.state === "Pressed") {
* console.log('Shortcut triggered');
* }
* }); * });
* ``` * ```
* *
@ -51,8 +53,8 @@ async function register(
* @example * @example
* ```typescript * ```typescript
* import { registerAll } from '@tauri-apps/plugin-global-shortcut'; * import { registerAll } from '@tauri-apps/plugin-global-shortcut';
* await registerAll(['CommandOrControl+Shift+C', 'Ctrl+Alt+F12'], (shortcut) => { * await registerAll(['CommandOrControl+Shift+C', 'Ctrl+Alt+F12'], (event) => {
* console.log(`Shortcut ${shortcut} triggered`); * console.log(`Shortcut ${event.shortcut} ${event.state}`);
* }); * });
* ``` * ```
* *

Loading…
Cancel
Save