profectus-docs/assets/api_modules_features_feature.md.7a5eca69.js

2 lines
21 KiB
JavaScript
Raw Normal View History

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><ul><li><a href="../../enums/features/feature.Visibility">Visibility</a></li></ul><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" 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/70cda5f/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-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/70cda5f/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="./feature#jsx">jsx</a></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/70cda5f/src/features/feature.ts#L21" target="_blank" rel="noreferrer">profectus/src/features/feature.ts:21</a></p><hr><h3 id="optionsfunc" tabindex="-1">OptionsFunc <a class="header-anchor" href="#optionsfunc" aria-label="Permalink to &quot;OptionsFunc&quot;"></a></h3><p>Ƭ <strong>OptionsFunc</strong>&lt;<code>T</code>, <code>R</code>, <code>S</code>&gt;: () =&gt; <code>T</code> &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype" target="_blank" rel="noreferrer"><code>Partial</code></a>&lt;<code>R</code>&gt; &amp; <a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#thistypetype" target="_blank" rel="noreferrer"><code>ThisType</code></a>&lt;<code>T</code> &amp; <code>S</code>&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-label="Permalink to &quot;Type parameters&quot;"></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-al