跳至主要內容

全域快速鍵

註冊全域快速鍵。

當 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

類型宣告

(shortcut: string): void

參數

名稱類型
shortcutstring

傳回: void

定義於: globalShortcut.ts:29

函式​

isRegistered​

isRegistered(shortcut: string): Promise<boolean>

判斷此應用程式是否已註冊指定的捷徑。

範例

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

自: 1.0.0

參數

名稱類型說明
shortcutstring捷徑定義、修飾鍵和按鍵的陣列，以「+」分隔，例如 CmdOrControl+Q

傳回: Promise<boolean>

register​

register(shortcut: string, handler: ShortcutHandler): Promise<void>

註冊一個全域捷徑。

範例

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

自: 1.0.0

參數

名稱類型說明
shortcutstring捷徑定義，修改鍵和按鍵以「+」分隔，例如 CmdOrControl+Q
處理常式捷徑處理常式捷徑處理常式回呼 - 以觸發的捷徑作為引數

傳回：Promise<void>

registerAll​

registerAll(shortcuts: string[], handler: 捷徑處理常式): 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

參數

名稱類型說明
捷徑string[]捷徑定義、修飾鍵和按鍵的陣列，以「+」分隔，例如 CmdOrControl+Q
處理常式捷徑處理常式捷徑處理常式回呼 - 以觸發的捷徑作為引數

傳回：Promise<void>

unregister​

unregister(shortcut: string): Promise<void>

取消註冊全域捷徑。

範例

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

自: 1.0.0

參數

名稱類型說明
shortcutstring捷徑定義，修改鍵和按鍵以「+」分隔，例如 CmdOrControl+Q

傳回：Promise<void>

unregisterAll​

unregisterAll(): Promise<void>

取消註冊應用程式註冊的所有捷徑。

範例

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

自: 1.0.0

傳回：Promise<void>