profectus-docs/assets/api_modules_features_feature.md.65109bb8.js

import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const b=JSON.parse('{"title":"Module: features/feature","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/feature.md","lastUpdated":null}'),o={name:"api/modules/features/feature.md"},n=r('<h1 id="module-features-feature" tabindex="-1">Module: features/feature <a class="header-anchor" href="#module-features-feature" aria-label="Permalink to &quot;Module: features/feature&quot;">​</a></h1><h2 id="enumerations" tabindex="-1">Enumerations <a class="header-anchor" href="#enumerations" aria-label="Permalink to &quot;Enumerations&quot;">​</a></h2><h3 id="visibility" tabindex="-1">Visibility <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;Visibility&quot;">​</a></h3><p>• <strong>Visibility</strong>: <code>Object</code></p><p>Enum for what the visibility of a feature or component should be</p><table><thead><tr><th style="text-align:left;">Name</th><th style="text-align:left;">Type</th><th style="text-align:left;">Description</th></tr></thead><tbody><tr><td style="text-align:left;"><code>Hidden</code></td><td style="text-align:left;"><code>1</code></td><td style="text-align:left;">The feature or component should not appear but still take up space</td></tr><tr><td style="text-align:left;"><code>None</code></td><td style="text-align:left;"><code>2</code></td><td style="text-align:left;">The feature or component should not appear not take up space</td></tr><tr><td style="text-align:left;"><code>Visible</code></td><td style="text-align:left;"><code>0</code></td><td style="text-align:left;">The feature or component should be visible</td></tr></tbody></table><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/c386ace/src/features/feature.ts#L59" target="_blank" rel="noreferrer">profectus/src/features/feature.ts:59</a></p><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-label="Permalink to &quot;Type Aliases&quot;">​</a></h2><h3 id="coercablecomponent" tabindex="-1">CoercableComponent <a class="header-anchor" href="#coercablecomponent" aria-label="Permalink to &quot;CoercableComponent&quot;">​</a></h3><p>Ƭ <strong>CoercableComponent</strong>: <code>string</code> | <code>DefineComponent</code> | <a href="./feature#jsxfunction"><code>JSXFunction</code></a></p><p>Any value that can be coerced into (or is) a vue component</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/c386ace/src/features/feature.ts#L25" target="_blank" rel="noreferrer">profectus/src/features/feature.ts:25</a></p><hr><h3 id="genericcomponent" tabindex="-1">GenericComponent <a class="header-anchor" href="#genericcomponent" aria-label="Permalink to &quot;GenericComponent&quot;">​</a></h3><p>Ƭ <strong>GenericComponent</strong>: <code>DefineComponent</code>&lt;<code>any</code>, <code>any</code>, <code>any</code>&gt;</p><p>A type that refers to any vue component</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/c386ace/src/features/feature.ts#L35" target="_blank" rel="noreferrer">profectus/src/features/feature.ts:35</a></p><hr><h3 id="jsxfunction" tabindex="-1">JSXFunction <a class="header-anchor" href="#jsxfunction" aria-label="Permalink to &quot;JSXFunction&quot;">​</a></h3><p>Ƭ <strong>JSXFunction</strong>: () =&gt; <code>JSX.Element</code> &amp; { <code>[DoNotCache]</code>: <code>true</code> }</p><p>A type referring to a function that returns JSX and is marked that it shouldn&#39;t be wrapped in a ComputedRef</p><p><strong><code>See</code></strong></p><p><a href="./