type ShortcutHandler = (shortcut: string) => void; /** * Register a global shortcut. * @example * ```typescript * import { register } from '@tauri-apps/api/globalShortcut'; * 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 */ declare function register(shortcut: string, handler: ShortcutHandler): Promise; /** * Register a collection of global shortcuts. * @example * ```typescript * import { registerAll } from '@tauri-apps/api/globalShortcut'; * 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 */ declare function registerAll(shortcuts: string[], handler: ShortcutHandler): Promise; /** * Determines whether the given shortcut is registered by this application or not. * @example * ```typescript * import { isRegistered } from '@tauri-apps/api/globalShortcut'; * const isRegistered = await isRegistered('CommandOrControl+P'); * ``` * * @param shortcut Array of shortcut definitions, modifiers and key separated by "+" e.g. CmdOrControl+Q * * @since 1.0.0 */ declare function isRegistered(shortcut: string): Promise; /** * Unregister a global shortcut. * @example * ```typescript * import { unregister } from '@tauri-apps/api/globalShortcut'; * await unregister('CmdOrControl+Space'); * ``` * * @param shortcut shortcut definition, modifiers and key separated by "+" e.g. CmdOrControl+Q * * @since 1.0.0 */ declare function unregister(shortcut: string): Promise; /** * Unregisters all shortcuts registered by the application. * @example * ```typescript * import { unregisterAll } from '@tauri-apps/api/globalShortcut'; * await unregisterAll(); * ``` * * @since 1.0.0 */ declare function unregisterAll(): Promise; declare const globalShortcut_register: typeof register; declare const globalShortcut_registerAll: typeof registerAll; declare const globalShortcut_isRegistered: typeof isRegistered; declare const globalShortcut_unregister: typeof unregister; declare const globalShortcut_unregisterAll: typeof unregisterAll; type globalShortcut_ShortcutHandler = ShortcutHandler; declare namespace globalShortcut { export { globalShortcut_register as register, globalShortcut_registerAll as registerAll, globalShortcut_isRegistered as isRegistered, globalShortcut_unregister as unregister, globalShortcut_unregisterAll as unregisterAll, globalShortcut_ShortcutHandler as ShortcutHandler, }; } export { ShortcutHandler as S, registerAll as a, unregisterAll as b, globalShortcut as g, isRegistered as i, register as r, unregister as u };