profectus-docs/assets/api_interfaces_features_hotkey.HotkeyOptions.md.c5110072.js

import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const k=JSON.parse('{"title":"Interface: HotkeyOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/hotkey.HotkeyOptions.md","lastUpdated":null}'),r={name:"api/interfaces/features/hotkey.HotkeyOptions.md"},n=o('<h1 id="interface-hotkeyoptions" tabindex="-1">Interface: HotkeyOptions <a class="header-anchor" href="#interface-hotkeyoptions" aria-label="Permalink to &quot;Interface: HotkeyOptions&quot;">​</a></h1><p><a href="./../../modules/features/hotkey">features/hotkey</a>.HotkeyOptions</p><p>An object that configures a <a href="./../../modules/features/hotkey#hotkey">Hotkey</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="description" tabindex="-1">description <a class="header-anchor" href="#description" aria-label="Permalink to &quot;description&quot;">​</a></h3><p>• <strong>description</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</p><p>The description of this hotkey, to display in the settings.</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L32" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:32</a></p><hr><h3 id="enabled" tabindex="-1">enabled <a class="header-anchor" href="#enabled" aria-label="Permalink to &quot;enabled&quot;">​</a></h3><p>• <code>Optional</code> <strong>enabled</strong>: <a href="./../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not this hotkey is currently enabled.</p><h4 id="defined-in-1" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-1" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L28" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:28</a></p><hr><h3 id="key" tabindex="-1">key <a class="header-anchor" href="#key" aria-label="Permalink to &quot;key&quot;">​</a></h3><p>• <strong>key</strong>: <code>string</code></p><p>The key tied to this hotkey</p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L30" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:30</a></p><hr><h3 id="onpress" tabindex="-1">onPress <a class="header-anchor" href="#onpress" aria-label="Permalink to &quot;onPress&quot;">​</a></h3><p>• <strong>onPress</strong>: <code>VoidFunction</code></p><p>What to do upon pressing the key.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;">​</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L34" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:34</a></p>',27),s=[n];function i(d,h,c,p,l,f){return a(),t("div",null,s)}const b=e(r,[["render",i]]);export{k as __pageData,b as default};