Keyboard

Spicetify provides its own method for global keyboard shortcuts. You can specify actions for your extension when the user presses a keyboard shortcut.

namespace Keyboard {
    const KEYS: Record<ValidKey, string>;
    function registerShortcut(keys: KeysDefine, callback: (event: KeyboardEvent) => void): void;
    function _deregisterShortcut(keys: KeysDefine): void;
    function changeShortcut(keys: KeysDefine, newKeys: KeysDefine): void;
};

Properties

`KEYS`

An object containing a list of valid keys, mapped to their valid names.

const { KEYS } = Spicetify.Keyboard;

Refer to this table for a list of valid keys.

Example

const { KEYS } = Spicetify.Keyboard;
console.log(KEYS["CAPS"]); // "Capslock"

Methods

`registerShortcut`

function registerShortcut(keys: KeysDefine, callback: (event: KeyboardEvent) => void): void;

Parameters

Parameter	Type	Description
keys	`KeysDefine`	Keyboard shortcut to register.
callback	`(event: KeyboardEvent) => void`	Callback function to run when the shortcut is triggered.

Example

// Equivalent to `Spicetify.Keyboard.registerShortcut({ key: "p", ctrl: true, shift: true }, (event) => { ... })`
Spicetify.Keyboard.registerShortcut("ctrl+shift+p", (event) => {
    // Do something with the event
    Spicetify.showNotification("Shortcut triggered!");
});

`_deregisterShortcut`

Deregister a global keyboard shortcut.

function _deregisterShortcut(keys: KeysDefine): void;

Parameters

Parameter	Type	Description
keys	`KeysDefine`	Keyboard shortcut to deregister.

Example

Spicetify.Keyboard._deregisterShortcut("ctrl+shift+p");

`changeShortcut`

Change a global keyboard shortcut to a new shortcut while keeping the callback.

function changeShortcut(keys: KeysDefine, newKeys: KeysDefine): void;

Parameters

Parameter	Type	Description
keys	`KeysDefine`	Keyboard shortcut to change.
newKeys	`KeysDefine`	New keyboard shortcut to change to.

Example

Spicetify.Keyboard.changeShortcut("ctrl+shift+p", "ctrl+shift+o");

Edit this page