profectus-docs/assets/api_features_hotkey_interfaces_HotkeyOptions.md.mIIFTyqg.lean.js

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('<p><a href="./../../../">Profectus</a> / <a href="./../">features/hotkey</a> / HotkeyOptions</p><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>An object that configures a <a href="./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><blockquote><p><strong>description</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>string</code>&gt;</p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L25" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:25</a></p><hr><h3 id="enabled" tabindex="-1">enabled? <a class="header-anchor" href="#enabled" aria-label="Permalink to &quot;enabled?&quot;">​</a></h3><blockquote><p><code>optional</code> <strong>enabled</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>boolean</code>&gt;</p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L21" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:21</a></p><hr><h3 id="key" tabindex="-1">key <a class="header-anchor" href="#key" aria-label="Permalink to &quot;key&quot;">​</a></h3><blockquote><p><strong>key</strong>: <code>string</code></p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L23" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:23</a></p><hr><h3 id="onpress" tabindex="-1">onPress() <a class="header-anchor" href="#onpress" aria-label="Permalink to &quot;onPress()&quot;">​</a></h3><blockquote><p><strong>onPress</strong>: (<code>e</code>?) =&gt; <code>void</code></p></blockquote><p>What to do upon pressing the key.</p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-label="Permalink to &quot;Parameters&quot;">​</a></h4><h5 id="e" tabindex="-1">e? <a class="header-anchor" href="#e" aria-label="Permalink to &quot;e?&quot;">​</a></h5><p><a href="https://developer.mozilla.org/docs/Web/API/MouseEvent" target="_blank" rel="noreferrer"><code>MouseEvent</code></a> | <a href="https://developer.mozilla.org/docs/Web/API/TouchEvent" target="_blank" rel="noreferrer"><code>TouchEvent</code></a></p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h4><p><code>void</code></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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L27" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:27</a></p>',32)]))}const u=t(n,[["render",s]]);export{f as __pageData,u as default};