2 lines
7.4 KiB
JavaScript
2 lines
7.4 KiB
JavaScript
|
import{_ as e,c as t,o as a,N as o}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: features/hotkey","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/hotkey.md","lastUpdated":null}'),r={name:"api/modules/features/hotkey.md"},s=o('<h1 id="module-features-hotkey" tabindex="-1">Module: features/hotkey <a class="header-anchor" href="#module-features-hotkey" aria-label="Permalink to "Module: features/hotkey""></a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to "Interfaces""></a></h2><ul><li><a href="../../interfaces/features/hotkey.BaseHotkey">BaseHotkey</a></li><li><a href="../../interfaces/features/hotkey.HotkeyOptions">HotkeyOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to "Type Aliases""></a></h2><h3 id="generichotkey" tabindex="-1">GenericHotkey <a class="header-anchor" href="#generichotkey" aria-label="Permalink to "GenericHotkey""></a></h3><p>Ƭ <strong>GenericHotkey</strong>: <a href="./feature#replace"><code>Replace</code></a><<code>Hotkey</code><<a href="../../interfaces/features/hotkey.HotkeyOptions"><code>HotkeyOptions</code></a>>, { <code>enabled</code>: <a href="./../util/computed#processedcomputable"><code>ProcessedComputable</code></a><<code>boolean</code>> }></p><p>A type that matches any valid <a href="./hotkey#hotkey">Hotkey</a> object.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L55" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:55</a></p><hr><h3 id="hotkey" tabindex="-1">Hotkey <a class="header-anchor" href="#hotkey" aria-label="Permalink to "Hotkey""></a></h3><p>Ƭ <strong>Hotkey</strong><<code>T</code>>: <a href="./feature#replace"><code>Replace</code></a><<code>T</code> & <a href="../../interfaces/features/hotkey.BaseHotkey"><code>BaseHotkey</code></a>, { <code>description</code>: <a href="./../util/computed#getcomputabletype"><code>GetComputableType</code></a><<code>T</code>[<code>"description"</code>]> ; <code>enabled</code>: <a href="./../util/computed#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a><<code>T</code>[<code>"enabled"</code>], <code>true</code>> }></p><p>An object that represents a hotkey shortcut that performs an action upon a key sequence being pressed.</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to "Type parameters""></a></h4><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th></tr></thead><tbody><tr><td style="text-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../interfaces/features/hotkey.HotkeyOptions"><code>HotkeyOptions</code></a></td></tr></tbody></table><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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/hotkey.tsx#L46" target="_blank" rel="noreferrer">profectus/src/features/hotkey.tsx:46</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-label="Permalink to "Variables""></a></h2><h3 id="hotkeytype" tabindex="-1">HotkeyType <a class="header-anchor" href="#hotkeytype" aria-label="Permalink to "HotkeyType""></a></h3><p>• <code>Const</code> <strong>HotkeyType</strong>: typeof <a href="./hotkey#hotkeytype"><code>HotkeyType</code></a></p><p>A symbol used to identify <a href="./hotkey#hotkey">Hotkey</a> features.</p><h4 id="defined-in-2" tabin
|