feat(global-shortcut): add plugin (#324)
Co-authored-by: Amr Bashir <amr.bashir2015@gmail.com>pull/306/head^2
Lucas Fernandes Nogueira
2 years ago
committed by
GitHub
parent
8cd7d3501b
commit
4b66ba03a5
@ -0,0 +1,14 @@
|
|||||||
|
[package]
|
||||||
|
name = "tauri-plugin-global-shortcut"
|
||||||
|
version = "0.1.0"
|
||||||
|
edition.workspace = true
|
||||||
|
authors.workspace = true
|
||||||
|
license.workspace = true
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde.workspace = true
|
||||||
|
serde_json.workspace = true
|
||||||
|
tauri.workspace = true
|
||||||
|
log.workspace = true
|
||||||
|
thiserror.workspace = true
|
||||||
|
global-hotkey = "0.1"
|
||||||
@ -0,0 +1,20 @@
|
|||||||
|
SPDXVersion: SPDX-2.1
|
||||||
|
DataLicense: CC0-1.0
|
||||||
|
PackageName: tauri
|
||||||
|
DataFormat: SPDXRef-1
|
||||||
|
PackageSupplier: Organization: The Tauri Programme in the Commons Conservancy
|
||||||
|
PackageHomePage: https://tauri.app
|
||||||
|
PackageLicenseDeclared: Apache-2.0
|
||||||
|
PackageLicenseDeclared: MIT
|
||||||
|
PackageCopyrightText: 2019-2022, The Tauri Programme in the Commons Conservancy
|
||||||
|
PackageSummary: <text>Tauri is a rust project that enables developers to make secure
|
||||||
|
and small desktop applications using a web frontend.
|
||||||
|
</text>
|
||||||
|
PackageComment: <text>The package includes the following libraries; see
|
||||||
|
Relationship information.
|
||||||
|
</text>
|
||||||
|
Created: 2019-05-20T09:00:00Z
|
||||||
|
PackageDownloadLocation: git://github.com/tauri-apps/tauri
|
||||||
|
PackageDownloadLocation: git+https://github.com/tauri-apps/tauri.git
|
||||||
|
PackageDownloadLocation: git+ssh://github.com/tauri-apps/tauri.git
|
||||||
|
Creator: Person: Daniel Thompson-Yvetot
|
||||||
@ -0,0 +1,177 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2017 - Present Tauri Apps Contributors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@ -0,0 +1,65 @@
|
|||||||
|
|
||||||
|
|
||||||
|
<!-- description -->
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
_This plugin requires a Rust version of at least **1.64**_
|
||||||
|
|
||||||
|
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
|
||||||
|
[dependencies]
|
||||||
|
<!-- plugin here --> = { git = "https://github.com/tauri-apps/plugins-workspace", branch = "dev" }
|
||||||
|
```
|
||||||
|
|
||||||
|
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 <!-- plugin here -->
|
||||||
|
# or
|
||||||
|
npm add <!-- plugin here -->
|
||||||
|
# or
|
||||||
|
yarn add <!-- plugin here -->
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
First you need to register the core plugin with Tauri:
|
||||||
|
|
||||||
|
`src-tauri/src/main.rs`
|
||||||
|
|
||||||
|
```rust
|
||||||
|
fn main() {
|
||||||
|
tauri::Builder::default()
|
||||||
|
.plugin(<!-- plugin here -->)
|
||||||
|
.run(tauri::generate_context!())
|
||||||
|
.expect("error while running tauri application");
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Code: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.
|
||||||
|
|
||||||
|
MIT or MIT/Apache 2.0 where applicable.
|
||||||
@ -0,0 +1,131 @@
|
|||||||
|
// Copyright 2019-2023 Tauri Programme within The Commons Conservancy
|
||||||
|
// SPDX-License-Identifier: Apache-2.0
|
||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register global shortcuts.
|
||||||
|
*
|
||||||
|
* The APIs must be added to [`tauri.allowlist.globalShortcut`](https://tauri.app/v1/api/config/#allowlistconfig.globalshortcut) in `tauri.conf.json`:
|
||||||
|
* ```json
|
||||||
|
* {
|
||||||
|
* "tauri": {
|
||||||
|
* "allowlist": {
|
||||||
|
* "globalShortcut": {
|
||||||
|
* "all": true // enable all global shortcut APIs
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* It is recommended to allowlist only the APIs you use for optimal bundle size and security.
|
||||||
|
* @module
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { invoke, transformCallback } from '@tauri-apps/api/tauri'
|
||||||
|
|
||||||
|
export type ShortcutHandler = (shortcut: string) => void
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register a global shortcut.
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { register } from 'tauri-plugin-global-shortcut-api';
|
||||||
|
* await register('CommandOrControl+Shift+C', () => {
|
||||||
|
* console.log('Shortcut triggered');
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @param shortcut Shortcut definition, modifiers and key separated by "+" e.g. CmdOrControl+Q
|
||||||
|
* @param handler Shortcut handler callback - takes the triggered shortcut as argument
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
async function register(
|
||||||
|
shortcut: string,
|
||||||
|
handler: ShortcutHandler
|
||||||
|
): Promise<void> {
|
||||||
|
return await invoke('plugin:globalShortcut|register', {
|
||||||
|
shortcut,
|
||||||
|
handler: transformCallback(handler)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register a collection of global shortcuts.
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { registerAll } from 'tauri-plugin-global-shortcut-api';
|
||||||
|
* await registerAll(['CommandOrControl+Shift+C', 'Ctrl+Alt+F12'], (shortcut) => {
|
||||||
|
* console.log(`Shortcut ${shortcut} triggered`);
|
||||||
|
* });
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @param shortcuts Array of shortcut definitions, modifiers and key separated by "+" e.g. CmdOrControl+Q
|
||||||
|
* @param handler Shortcut handler callback - takes the triggered shortcut as argument
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
async function registerAll(
|
||||||
|
shortcuts: string[],
|
||||||
|
handler: ShortcutHandler
|
||||||
|
): Promise<void> {
|
||||||
|
return await invoke('plugin:globalShortcut|register_all', {
|
||||||
|
shortcuts,
|
||||||
|
handler: transformCallback(handler)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Determines whether the given shortcut is registered by this application or not.
|
||||||
|
*
|
||||||
|
* If the shortcut is registered by another application, it will still return `false`.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { isRegistered } from 'tauri-plugin-global-shortcut-api';
|
||||||
|
* const isRegistered = await isRegistered('CommandOrControl+P');
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @param shortcut shortcut definition, modifiers and key separated by "+" e.g. CmdOrControl+Q
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
async function isRegistered(shortcut: string): Promise<boolean> {
|
||||||
|
return await invoke('plugin:globalShortcut|is_registered', {
|
||||||
|
shortcut
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unregister a global shortcut.
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { unregister } from 'tauri-plugin-global-shortcut-api';
|
||||||
|
* await unregister('CmdOrControl+Space');
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @param shortcut shortcut definition, modifiers and key separated by "+" e.g. CmdOrControl+Q
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
async function unregister(shortcut: string): Promise<void> {
|
||||||
|
return await invoke('plugin:globalShortcut|unregister', {
|
||||||
|
shortcut
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unregisters all shortcuts registered by the application.
|
||||||
|
* @example
|
||||||
|
* ```typescript
|
||||||
|
* import { unregisterAll } from 'tauri-plugin-global-shortcut-api';
|
||||||
|
* await unregisterAll();
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
async function unregisterAll(): Promise<void> {
|
||||||
|
return await invoke('plugin:globalShortcut|unregister_all')
|
||||||
|
}
|
||||||
|
|
||||||
|
export { register, registerAll, isRegistered, unregister, unregisterAll }
|
||||||
@ -0,0 +1,32 @@
|
|||||||
|
{
|
||||||
|
"name": "tauri-plugin-global-shortcut-api",
|
||||||
|
"version": "0.0.0",
|
||||||
|
"license": "MIT or APACHE-2.0",
|
||||||
|
"authors": [
|
||||||
|
"Tauri Programme within The Commons Conservancy"
|
||||||
|
],
|
||||||
|
"type": "module",
|
||||||
|
"browser": "dist-js/index.min.js",
|
||||||
|
"module": "dist-js/index.mjs",
|
||||||
|
"types": "dist-js/index.d.ts",
|
||||||
|
"exports": {
|
||||||
|
"import": "./dist-js/index.mjs",
|
||||||
|
"types": "./dist-js/index.d.ts",
|
||||||
|
"browser": "./dist-js/index.min.js"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"build": "rollup -c"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"dist-js",
|
||||||
|
"!dist-js/**/*.map",
|
||||||
|
"README.md",
|
||||||
|
"LICENSE"
|
||||||
|
],
|
||||||
|
"devDependencies": {
|
||||||
|
"tslib": "^2.4.1"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@tauri-apps/api": "^1.2.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,11 @@
|
|||||||
|
import { readFileSync } from "fs";
|
||||||
|
|
||||||
|
import { createConfig } from "../../shared/rollup.config.mjs";
|
||||||
|
|
||||||
|
export default createConfig({
|
||||||
|
input: "guest-js/index.ts",
|
||||||
|
pkg: JSON.parse(
|
||||||
|
readFileSync(new URL("./package.json", import.meta.url), "utf8")
|
||||||
|
),
|
||||||
|
external: [/^@tauri-apps\/api/],
|
||||||
|
});
|
||||||
@ -0,0 +1,22 @@
|
|||||||
|
use serde::{Serialize, Serializer};
|
||||||
|
|
||||||
|
#[derive(Debug, thiserror::Error)]
|
||||||
|
pub enum Error {
|
||||||
|
#[error("{0}")]
|
||||||
|
GlobalHotkey(String),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Serialize for Error {
|
||||||
|
fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
|
||||||
|
where
|
||||||
|
S: Serializer,
|
||||||
|
{
|
||||||
|
serializer.serialize_str(self.to_string().as_ref())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<global_hotkey::Error> for Error {
|
||||||
|
fn from(value: global_hotkey::Error) -> Self {
|
||||||
|
Self::GlobalHotkey(value.to_string())
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,321 @@
|
|||||||
|
use std::{
|
||||||
|
collections::HashMap,
|
||||||
|
str::FromStr,
|
||||||
|
sync::{Arc, Mutex},
|
||||||
|
};
|
||||||
|
|
||||||
|
pub use global_hotkey::hotkey::{Code, HotKey as Shortcut, Modifiers};
|
||||||
|
use global_hotkey::{GlobalHotKeyEvent, GlobalHotKeyManager};
|
||||||
|
use tauri::{
|
||||||
|
api::ipc::CallbackFn,
|
||||||
|
plugin::{Builder as PluginBuilder, TauriPlugin},
|
||||||
|
AppHandle, Manager, Runtime, State, Window,
|
||||||
|
};
|
||||||
|
|
||||||
|
mod error;
|
||||||
|
|
||||||
|
pub use error::Error;
|
||||||
|
type Result<T> = std::result::Result<T, Error>;
|
||||||
|
type HotKeyId = u32;
|
||||||
|
type HandlerFn = Box<dyn Fn(&Shortcut) + Send + Sync + 'static>;
|
||||||
|
|
||||||
|
enum ShortcutSource<R: Runtime> {
|
||||||
|
Ipc {
|
||||||
|
window: Window<R>,
|
||||||
|
handler: CallbackFn,
|
||||||
|
},
|
||||||
|
Rust,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<R: Runtime> Clone for ShortcutSource<R> {
|
||||||
|
fn clone(&self) -> Self {
|
||||||
|
match self {
|
||||||
|
Self::Ipc { window, handler } => Self::Ipc {
|
||||||
|
window: window.clone(),
|
||||||
|
handler: *handler,
|
||||||
|
},
|
||||||
|
Self::Rust => Self::Rust,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct ShortcutWrapper(Shortcut);
|
||||||
|
|
||||||
|
impl From<Shortcut> for ShortcutWrapper {
|
||||||
|
fn from(value: Shortcut) -> Self {
|
||||||
|
Self(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<&str> for ShortcutWrapper {
|
||||||
|
type Error = global_hotkey::Error;
|
||||||
|
fn try_from(value: &str) -> std::result::Result<Self, Self::Error> {
|
||||||
|
Shortcut::from_str(value).map(ShortcutWrapper)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
struct RegisteredShortcut<R: Runtime> {
|
||||||
|
source: ShortcutSource<R>,
|
||||||
|
shortcut: (Shortcut, Option<String>),
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct GlobalShortcut<R: Runtime> {
|
||||||
|
#[allow(dead_code)]
|
||||||
|
app: AppHandle<R>,
|
||||||
|
manager: std::result::Result<GlobalHotKeyManager, global_hotkey::Error>,
|
||||||
|
shortcuts: Arc<Mutex<HashMap<HotKeyId, RegisteredShortcut<R>>>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<R: Runtime> GlobalShortcut<R> {
|
||||||
|
fn register_internal(
|
||||||
|
&self,
|
||||||
|
shortcut: (Shortcut, Option<String>),
|
||||||
|
source: ShortcutSource<R>,
|
||||||
|
) -> Result<()> {
|
||||||
|
let id = shortcut.0.id();
|
||||||
|
acquire_manager(&self.manager)?.register(shortcut.0)?;
|
||||||
|
self.shortcuts
|
||||||
|
.lock()
|
||||||
|
.unwrap()
|
||||||
|
.insert(id, RegisteredShortcut { source, shortcut });
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn register_all_internal<S: IntoIterator<Item = (Shortcut, Option<String>)>>(
|
||||||
|
&self,
|
||||||
|
shortcuts: S,
|
||||||
|
source: ShortcutSource<R>,
|
||||||
|
) -> Result<()> {
|
||||||
|
let hotkeys = shortcuts
|
||||||
|
.into_iter()
|
||||||
|
.collect::<Vec<(Shortcut, Option<String>)>>();
|
||||||
|
|
||||||
|
let manager = acquire_manager(&self.manager)?;
|
||||||
|
let mut shortcuts = self.shortcuts.lock().unwrap();
|
||||||
|
for hotkey in hotkeys {
|
||||||
|
manager.register(hotkey.0)?;
|
||||||
|
|
||||||
|
shortcuts.insert(
|
||||||
|
hotkey.0.id(),
|
||||||
|
RegisteredShortcut {
|
||||||
|
source: source.clone(),
|
||||||
|
shortcut: hotkey,
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn register<S: TryInto<ShortcutWrapper>>(&self, shortcut: S) -> Result<()>
|
||||||
|
where
|
||||||
|
S::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
self.register_internal((try_into_shortcut(shortcut)?, None), ShortcutSource::Rust)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn register_all<T: TryInto<ShortcutWrapper>, S: IntoIterator<Item = T>>(
|
||||||
|
&self,
|
||||||
|
shortcuts: S,
|
||||||
|
) -> Result<()>
|
||||||
|
where
|
||||||
|
T::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
let mut s = Vec::new();
|
||||||
|
for shortcut in shortcuts {
|
||||||
|
s.push((try_into_shortcut(shortcut)?, None));
|
||||||
|
}
|
||||||
|
self.register_all_internal(s, ShortcutSource::Rust)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn unregister<S: TryInto<ShortcutWrapper>>(&self, shortcut: S) -> Result<()>
|
||||||
|
where
|
||||||
|
S::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
acquire_manager(&self.manager)?
|
||||||
|
.unregister(try_into_shortcut(shortcut)?)
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn unregister_all<T: TryInto<ShortcutWrapper>, S: IntoIterator<Item = T>>(
|
||||||
|
&self,
|
||||||
|
shortcuts: S,
|
||||||
|
) -> Result<()>
|
||||||
|
where
|
||||||
|
T::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
let mut s = Vec::new();
|
||||||
|
for shortcut in shortcuts {
|
||||||
|
s.push(try_into_shortcut(shortcut)?);
|
||||||
|
}
|
||||||
|
acquire_manager(&self.manager)?
|
||||||
|
.unregister_all(&s)
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Determines whether the given shortcut is registered by this application or not.
|
||||||
|
///
|
||||||
|
/// If the shortcut is registered by another application, it will still return `false`.
|
||||||
|
pub fn is_registered<S: TryInto<ShortcutWrapper>>(&self, shortcut: S) -> bool
|
||||||
|
where
|
||||||
|
S::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
if let Ok(shortcut) = try_into_shortcut(shortcut) {
|
||||||
|
self.shortcuts.lock().unwrap().contains_key(&shortcut.id())
|
||||||
|
} else {
|
||||||
|
false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub trait GlobalShortcutExt<R: Runtime> {
|
||||||
|
fn global_shortcut(&self) -> &GlobalShortcut<R>;
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<R: Runtime, T: Manager<R>> GlobalShortcutExt<R> for T {
|
||||||
|
fn global_shortcut(&self) -> &GlobalShortcut<R> {
|
||||||
|
self.state::<GlobalShortcut<R>>().inner()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn acquire_manager(
|
||||||
|
manager: &std::result::Result<GlobalHotKeyManager, global_hotkey::Error>,
|
||||||
|
) -> Result<&GlobalHotKeyManager> {
|
||||||
|
manager
|
||||||
|
.as_ref()
|
||||||
|
.map_err(|e| Error::GlobalHotkey(e.to_string()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn parse_shortcut<S: AsRef<str>>(shortcut: S) -> Result<Shortcut> {
|
||||||
|
shortcut.as_ref().parse().map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn try_into_shortcut<S: TryInto<ShortcutWrapper>>(shortcut: S) -> Result<Shortcut>
|
||||||
|
where
|
||||||
|
S::Error: std::error::Error,
|
||||||
|
{
|
||||||
|
shortcut
|
||||||
|
.try_into()
|
||||||
|
.map(|s| s.0)
|
||||||
|
.map_err(|e| Error::GlobalHotkey(e.to_string()))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn register<R: Runtime>(
|
||||||
|
window: Window<R>,
|
||||||
|
global_shortcut: State<'_, GlobalShortcut<R>>,
|
||||||
|
shortcut: String,
|
||||||
|
handler: CallbackFn,
|
||||||
|
) -> Result<()> {
|
||||||
|
global_shortcut.register_internal(
|
||||||
|
(parse_shortcut(&shortcut)?, Some(shortcut)),
|
||||||
|
ShortcutSource::Ipc { window, handler },
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn register_all<R: Runtime>(
|
||||||
|
window: Window<R>,
|
||||||
|
global_shortcut: State<'_, GlobalShortcut<R>>,
|
||||||
|
shortcuts: Vec<String>,
|
||||||
|
handler: CallbackFn,
|
||||||
|
) -> Result<()> {
|
||||||
|
let mut hotkeys = Vec::new();
|
||||||
|
for shortcut in shortcuts {
|
||||||
|
hotkeys.push((parse_shortcut(&shortcut)?, Some(shortcut)));
|
||||||
|
}
|
||||||
|
global_shortcut.register_all_internal(hotkeys, ShortcutSource::Ipc { window, handler })
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn unregister<R: Runtime>(
|
||||||
|
_app: AppHandle<R>,
|
||||||
|
global_shortcut: State<'_, GlobalShortcut<R>>,
|
||||||
|
shortcut: String,
|
||||||
|
) -> Result<()> {
|
||||||
|
global_shortcut.unregister(parse_shortcut(shortcut)?)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn unregister_all<R: Runtime>(
|
||||||
|
_app: AppHandle<R>,
|
||||||
|
global_shortcut: State<'_, GlobalShortcut<R>>,
|
||||||
|
shortcuts: Vec<String>,
|
||||||
|
) -> Result<()> {
|
||||||
|
let mut hotkeys = Vec::new();
|
||||||
|
for shortcut in shortcuts {
|
||||||
|
hotkeys.push(parse_shortcut(&shortcut)?);
|
||||||
|
}
|
||||||
|
global_shortcut.unregister_all(hotkeys)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn is_registered<R: Runtime>(
|
||||||
|
_app: AppHandle<R>,
|
||||||
|
global_shortcut: State<'_, GlobalShortcut<R>>,
|
||||||
|
shortcut: String,
|
||||||
|
) -> Result<bool> {
|
||||||
|
Ok(global_shortcut.is_registered(parse_shortcut(shortcut)?))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Default)]
|
||||||
|
pub struct Builder {
|
||||||
|
handler: Option<HandlerFn>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Builder {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Self::default()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_handler<F: Fn(&Shortcut) + Send + Sync + 'static>(handler: F) -> Self {
|
||||||
|
Self {
|
||||||
|
handler: Some(Box::new(handler)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn build<R: Runtime>(self) -> TauriPlugin<R> {
|
||||||
|
let handler = self.handler;
|
||||||
|
PluginBuilder::new("globalShortcut")
|
||||||
|
.invoke_handler(tauri::generate_handler![
|
||||||
|
register,
|
||||||
|
register_all,
|
||||||
|
unregister,
|
||||||
|
unregister_all,
|
||||||
|
is_registered
|
||||||
|
])
|
||||||
|
.setup(move |app, _api| {
|
||||||
|
let shortcuts =
|
||||||
|
Arc::new(Mutex::new(HashMap::<HotKeyId, RegisteredShortcut<R>>::new()));
|
||||||
|
let shortcuts_ = shortcuts.clone();
|
||||||
|
|
||||||
|
GlobalHotKeyEvent::set_event_handler(Some(move |e: GlobalHotKeyEvent| {
|
||||||
|
if let Some(shortcut) = shortcuts_.lock().unwrap().get(&e.id) {
|
||||||
|
match &shortcut.source {
|
||||||
|
ShortcutSource::Ipc { window, handler } => {
|
||||||
|
let callback_string = tauri::api::ipc::format_callback(
|
||||||
|
*handler,
|
||||||
|
&shortcut.shortcut.1,
|
||||||
|
)
|
||||||
|
.expect("unable to serialize shortcut string to json");
|
||||||
|
let _ = window.eval(callback_string.as_str());
|
||||||
|
}
|
||||||
|
ShortcutSource::Rust => {
|
||||||
|
if let Some(handler) = &handler {
|
||||||
|
handler(&shortcut.shortcut.0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
app.manage(GlobalShortcut {
|
||||||
|
app: app.clone(),
|
||||||
|
manager: GlobalHotKeyManager::new(),
|
||||||
|
shortcuts,
|
||||||
|
});
|
||||||
|
Ok(())
|
||||||
|
})
|
||||||
|
.build()
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"extends": "../../tsconfig.base.json",
|
||||||
|
"include": ["guest-js/*.ts"]
|
||||||
|
}
|
||||||
Loading…
Reference in new issue