Skip to content

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