@tauri-apps/plugin-global-shortcut

Registra atajos globales.

Interfaces

ShortcutEvent

Propiedades

Propiedad	Tipo	Definido en
id	number	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L15
shortcut	string	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L14
state	"Released" | "Pressed"	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L16

Alias de tipos

ShortcutHandler()

type ShortcutHandler: (event) => void;

Parámetros

Parámetro	Tipo
event	ShortcutEvent

Devuelve

void

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L19

Funciones

isRegistered()

function isRegistered(shortcut): Promise<boolean>

Determina si el atajo dado está registrado por esta aplicación o no.

Si el atajo está registrado por otra aplicación, seguirá devolviendo false.

Parámetros

Parámetro	Tipo	Descripción
shortcut	string	definición del atajo, modificadores y tecla separados por “+”, p. ej., CmdOrControl+Q

Devuelve

Promise<boolean>

Ejemplo

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

Desde

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L117

---

register()

function register(shortcuts, handler): Promise<void>

Registra un atajo global o una lista de atajos.

Se llama al manejador cuando el usuario presiona cualquiera de los atajos registrados.

Si el atajo ya está ocupado por otra aplicación, el manejador no se activará. Asegúrate de que el atajo sea lo más único posible teniendo en cuenta la experiencia de usuario.

Parámetros

Parámetro	Tipo	Descripción
shortcuts	string | string[]	-
handler	ShortcutHandler	Callback del manejador de atajos - toma el atajo activado como argumento

Devuelve

Promise<void>

Ejemplo

import { register } from '@tauri-apps/plugin-global-shortcut';

// register a single hotkey
await register('CommandOrControl+Shift+C', (event) => {
  if (event.state === "Pressed") {
      console.log('Shortcut triggered');
  }
});

// or register multiple hotkeys at once
await register(['CommandOrControl+Shift+C', 'Alt+A'], (event) => {
  console.log(`Shortcut ${event.shortcut} triggered`);
});

Desde

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L51

---

unregister()

function unregister(shortcuts): Promise<void>

Anula el registro de un atajo global o de una lista de atajos.

Parámetros

Parámetro	Tipo
shortcuts	string | string[]

Devuelve

Promise<void>

Ejemplo

import { unregister } from '@tauri-apps/plugin-global-shortcut';

// unregister a single hotkey
await unregister('CmdOrControl+Space');

// or unregister multiple hotkeys at the same time
await unregister(['CmdOrControl+Space', 'Alt+A']);

Desde

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L82

---

unregisterAll()

function unregisterAll(): Promise<void>

Anula el registro de todos los atajos globales.

Devuelve

Promise<void>

Ejemplo

import { unregisterAll } from '@tauri-apps/plugin-global-shortcut';
await unregisterAll();

Desde

2.0.0

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/global-shortcut/guest-js/index.ts#L98