import{_ as t,c as a,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: Hotkey","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/hotkey/interfaces/Hotkey.md","filePath":"api/features/hotkey/interfaces/Hotkey.md","lastUpdated":null}'),n={name:"api/features/hotkey/interfaces/Hotkey.md"};function s(i,e,c,h,d,l){return o(),a("div",null,e[0]||(e[0]=[r('

Profectus / features/hotkey / Hotkey

Interface: Hotkey ​

An object that represents a hotkey shortcut that performs an action upon a key sequence being pressed.

Properties ​

description ​

description: MaybeRef<string>

The description of this hotkey, to display in the settings.

Defined in ​

profectus/src/features/hotkey.tsx:37

enabled ​

enabled: MaybeRef<boolean>

Whether or not this hotkey is currently enabled.

Defined in ​

profectus/src/features/hotkey.tsx:33

key ​

key: string

The key tied to this hotkey

Defined in ​

profectus/src/features/hotkey.tsx:35

onPress() ​

onPress: (e?) => void

What to do upon pressing the key.

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Defined in ​

profectus/src/features/hotkey.tsx:39

type ​

type: typeof HotkeyType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/hotkey.tsx:41

',38)]))}const u=t(n,[["render",s]]);export{p as __pageData,u as default};