profectus-docs/assets/api_modules_features_hotkey.md.5cb42e07.js

import{_ as e,c as t,o as a,a as o}from"./app.8e8712eb.js";const u='{"title":"Module: features/hotkey","description":"","frontmatter":{},"headers":[{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type aliases","slug":"type-aliases"},{"level":3,"title":"GenericHotkey","slug":"generichotkey"},{"level":3,"title":"Hotkey","slug":"hotkey"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"HotkeyType","slug":"hotkeytype"},{"level":3,"title":"hotkeys","slug":"hotkeys"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createHotkey","slug":"createhotkey"}],"relativePath":"api/modules/features/hotkey.md"}',r={},d=o('<h1 id="module-features-hotkey" tabindex="-1">Module: features/hotkey <a class="header-anchor" href="#module-features-hotkey" aria-hidden="true">#</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</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-hidden="true">#</a></h2><h3 id="generichotkey" tabindex="-1">GenericHotkey <a class="header-anchor" href="#generichotkey" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericHotkey</strong>: <a href="./feature.html#replace"><code>Replace</code></a>&lt;<a href="./hotkey.html#hotkey"><code>Hotkey</code></a>&lt;<a href="../../interfaces/features/hotkey.HotkeyOptions"><code>HotkeyOptions</code></a>&gt;, { <code>enabled</code>: <a href="./../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>boolean</code>&gt; }&gt;</p><h4 id="defined-in" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/features/hotkey.tsx#L38" target="_blank" rel="noopener noreferrer">profectus/src/features/hotkey.tsx:38</a></p><hr><h3 id="hotkey" tabindex="-1">Hotkey <a class="header-anchor" href="#hotkey" aria-hidden="true">#</a></h3><p>\u01AC <strong>Hotkey</strong>&lt;<code>T</code>&gt;: <a href="./feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../interfaces/features/hotkey.BaseHotkey"><code>BaseHotkey</code></a>, { <code>description</code>: <a href="./../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;description&quot;</code>]&gt; ; <code>enabled</code>: <a href="./../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;enabled&quot;</code>], <code>true</code>&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</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-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/features/hotkey.tsx#L30" target="_blank" rel="noopener noreferrer">profectus/src/features/hotkey.tsx:30</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="hotkeytype" tabindex="-1">HotkeyType <a class="header-anchor" href="#hotkeytype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>HotkeyType</strong>: typeof <a href="./hotkey.html#hotkeytype"><code>HotkeyType</code></a></p><h4 id="defined-in-2" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-2" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/features/hotkey.tsx#L17" target="_blank" rel="noopener noreferrer">profectus/src/features/hotkey.tsx:17</a></p><hr><h3 id="hotkeys" tabindex="-1">hotkeys <a class="header-anchor" href="#hotkeys" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>hotkeys</strong>: <code>Record</code>&lt;<code>string</code>, <a href="./hotkey.html#generichotkey"><code>GenericHotkey</code></a> | <code>undefined</code>&gt;</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/features/hotkey.tsx#L16" target="_blank" rel="noopener noreferrer">profectus/src/features/hotkey.tsx:16</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createhotkey" tabindex="-1">createHotkey <a class="header-anchor" href="#createhotkey" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createHotkey</strong>&lt;<code>T</code>&gt;(<code>optionsFunc</code>): <a href="./hotkey.html#hotkey"><code>Hotkey</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</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="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</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>optionsFunc</code></td><td style="text-align:left;">() =&gt; <code>T</code> &amp; <code>ThisType</code>&lt;<a href="./hotkey.html#hotkey"><code>Hotkey</code></a>&lt;<code>T</code>&gt;&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./hotkey.html#hotkey"><code>Hotkey</code></a>&lt;<code>T</code>&gt;</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/305946e/src/features/hotkey.tsx#L45" target="_blank" rel="noopener noreferrer">profectus/src/features/hotkey.tsx:45</a></p>',36),h=[d];function s(c,n,i,l,f,y){return a(),t("div",null,h)}var k=e(r,[["render",s]]);export{u as __pageData,k as default};