跳至主要内容

全局快捷键

注册全局快捷键。

当 tauri.conf.json 中的 build.withGlobalTauri 设置为 true 时，也可以使用 window.__TAURI__.globalShortcut 访问此软件包。

必须将 API 添加到 tauri.conf.json 中的 tauri.allowlist.globalShortcut

{
  "tauri": {
    "allowlist": {
      "globalShortcut": {
        "all": true // enable all global shortcut APIs
      }
    }
  }
}

建议仅允许列出你使用的 API，以优化包大小和安全性。

类型别名​

ShortcutHandler​

ShortcutHandler: (shortcut: string) => void

类型声明

(快捷键: 字符串): void

参数

名称类型
快捷键字符串

返回: void

定义在: globalShortcut.ts:29

函数​

isRegistered​

isRegistered(快捷键: 字符串): Promise<布尔值>

确定此应用程序是否已注册给定的快捷键。

示例

import { isRegistered } from '@tauri-apps/api/globalShortcut';
const isRegistered = await isRegistered('CommandOrControl+P');

自: 1.0.0

参数

名称类型描述
快捷键字符串快捷键定义、修饰符和键，用“+”分隔，例如 CmdOrControl+Q

返回: Promise<布尔值>

register​

register(快捷键: 字符串, 处理程序: ShortcutHandler): Promise<void>

注册全局快捷键。

示例

import { register } from '@tauri-apps/api/globalShortcut';
await register('CommandOrControl+Shift+C', () => {
  console.log('Shortcut triggered');
});

自: 1.0.0

参数

名称类型描述
快捷键字符串快捷键定义、修饰符和键，用“+”分隔，例如 CmdOrControl+Q
处理程序ShortcutHandler快捷键处理程序回调 - 以触发的快捷键作为参数

返回: Promise<void>

registerAll​

registerAll(快捷键: 字符串[], 处理程序: ShortcutHandler): Promise<void>

注册一组全局快捷键。

示例

import { registerAll } from '@tauri-apps/api/globalShortcut';
await registerAll(['CommandOrControl+Shift+C', 'Ctrl+Alt+F12'], (shortcut) => {
  console.log(`Shortcut ${shortcut} triggered`);
});

自: 1.0.0

参数

名称类型描述
快捷键字符串[]快捷键定义、修饰符和键，用“+”分隔，例如 CmdOrControl+Q
处理程序ShortcutHandler快捷键处理程序回调 - 以触发的快捷键作为参数

返回: Promise<void>

unregister​

unregister(快捷键: 字符串): Promise<void>

注销全局快捷键。

示例

import { unregister } from '@tauri-apps/api/globalShortcut';
await unregister('CmdOrControl+Space');

自: 1.0.0

参数

名称类型描述
快捷键字符串快捷键定义、修饰符和键，用“+”分隔，例如 CmdOrControl+Q

返回: Promise<void>

unregisterAll​

unregisterAll(): Promise<void>

取消注册应用程序注册的所有快捷方式。

示例

import { unregisterAll } from '@tauri-apps/api/globalShortcut';
await unregisterAll();

自: 1.0.0

返回: Promise<void>