1 line
5 KiB
JavaScript
1 line
5 KiB
JavaScript
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('<p><a href="./../../../">Profectus</a> / <a href="./../">features/hotkey</a> / Hotkey</p><h1 id="interface-hotkey" tabindex="-1">Interface: Hotkey <a class="header-anchor" href="#interface-hotkey" aria-label="Permalink to "Interface: Hotkey""></a></h1><p>An object that represents a hotkey shortcut that performs an action upon a key sequence being pressed.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to "Properties""></a></h2><h3 id="description" tabindex="-1">description <a class="header-anchor" href="#description" aria-label="Permalink to "description""></a></h3><blockquote><p><strong>description</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>string</code>></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 "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L37" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:37</a></p><hr><h3 id="enabled" tabindex="-1">enabled <a class="header-anchor" href="#enabled" aria-label="Permalink to "enabled""></a></h3><blockquote><p><strong>enabled</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a><<code>boolean</code>></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 "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L33" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:33</a></p><hr><h3 id="key" tabindex="-1">key <a class="header-anchor" href="#key" aria-label="Permalink to "key""></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 "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L35" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:35</a></p><hr><h3 id="onpress" tabindex="-1">onPress() <a class="header-anchor" href="#onpress" aria-label="Permalink to "onPress()""></a></h3><blockquote><p><strong>onPress</strong>: (<code>e</code>?) => <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 "Parameters""></a></h4><h5 id="e" tabindex="-1">e? <a class="header-anchor" href="#e" aria-label="Permalink to "e?""></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 "Returns""></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 "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L39" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:39</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to "type""></a></h3><blockquote><p><strong>type</strong>: <em>typeof</em> <a href="./../variables/HotkeyType"><code>HotkeyType</code></a></p></blockquote><p>A symbol that helps identify features of the same type.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to "Defined in""></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/features/hotkey.tsx#L41" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:41</a></p>',38)]))}const u=t(n,[["render",s]]);export{p as __pageData,u as default};
|