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

Profectus / features/hotkey / HotkeyOptions

Interface: HotkeyOptions ​

An object that configures a Hotkey.

Properties ​

description ​

description: MaybeRefOrGetter<string>

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

Defined in ​

profectus/src/features/hotkey.tsx:25

enabled? ​

optional enabled: MaybeRefOrGetter<boolean>

Whether or not this hotkey is currently enabled.

Defined in ​

profectus/src/features/hotkey.tsx:21

key ​

key: string

The key tied to this hotkey

Defined in ​

profectus/src/features/hotkey.tsx:23

onPress() ​

onPress: (e?) => void

What to do upon pressing the key.

Parameters ​

e? ​

MouseEvent | TouchEvent

Returns ​

void

Defined in ​

profectus/src/features/hotkey.tsx:27

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