profectus-docs/assets/api_util_vue_interfaces_VueFeature.md.B1bWerqF.lean.js

1 line
7.7 KiB
JavaScript
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as a,c as t,a0 as r,o as i}from"./chunks/framework.P9qPzDnn.js";const h=JSON.parse('{"title":"Interface: VueFeature","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/util/vue/interfaces/VueFeature.md","filePath":"api/util/vue/interfaces/VueFeature.md","lastUpdated":null}'),o={name:"api/util/vue/interfaces/VueFeature.md"};function s(n,e,l,c,d,u){return i(),t("div",null,e[0]||(e[0]=[r('<p><a href="./../../../">Profectus</a> / <a href="./../">util/vue</a> / VueFeature</p><h1 id="interface-vuefeature" tabindex="-1">Interface: VueFeature <a class="header-anchor" href="#interface-vuefeature" aria-label="Permalink to &quot;Interface: VueFeature&quot;"></a></h1><h2 id="extended-by" tabindex="-1">Extended by <a class="header-anchor" href="#extended-by" aria-label="Permalink to &quot;Extended by&quot;"></a></h2><ul><li><a href="./../../../features/achievements/achievement/interfaces/Achievement"><code>Achievement</code></a></li><li><a href="./../../../features/bars/bar/interfaces/Bar"><code>Bar</code></a></li><li><a href="./../../../features/challenges/challenge/interfaces/Challenge"><code>Challenge</code></a></li><li><a href="./../../../features/clickables/action/interfaces/Action"><code>Action</code></a></li><li><a href="./../../../features/clickables/clickable/interfaces/Clickable"><code>Clickable</code></a></li><li><a href="./../../../features/clickables/repeatable/interfaces/Repeatable"><code>Repeatable</code></a></li><li><a href="./../../../features/clickables/upgrade/interfaces/Upgrade"><code>Upgrade</code></a></li><li><a href="./../../../features/infoboxes/infobox/interfaces/Infobox"><code>Infobox</code></a></li><li><a href="./../../../features/links/links/interfaces/Links"><code>Links</code></a></li><li><a href="./../../../features/particles/particles/interfaces/Particles"><code>Particles</code></a></li><li><a href="./../../../features/tabs/tab/interfaces/Tab"><code>Tab</code></a></li><li><a href="./../../../features/tabs/tabFamily/interfaces/TabButton"><code>TabButton</code></a></li><li><a href="./../../../features/tabs/tabFamily/interfaces/TabFamily"><code>TabFamily</code></a></li><li><a href="./../../../features/trees/tree/interfaces/TreeNode"><code>TreeNode</code></a></li><li><a href="./../../../features/trees/tree/interfaces/Tree"><code>Tree</code></a></li><li><a href="./../../../wrappers/tooltips/tooltip/interfaces/Tooltip"><code>Tooltip</code></a></li></ul><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;"></a></h2><h3 id="vuefeature" tabindex="-1">[VueFeature] <a class="header-anchor" href="#vuefeature" aria-label="Permalink to &quot;\\[VueFeature\\]&quot;"></a></h3><blockquote><p><strong>[VueFeature]</strong>: <code>true</code></p></blockquote><p>Used to identify Vue Features</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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L43" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:43</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank" rel="noreferrer"><code>Record</code></a>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;</p></blockquote><p>Dictionary of CSS classes to apply to this feature.</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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L35" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:35</a></p><hr><h3 id="components" tabindex="-1">components <a class="header-anchor" href="#components" aria-label="Permalink to &quot;components&quot;"></a></h3><blockquote><p><strong>components</strong>: <a href="./../../computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a>&lt;<a href="./../type-aliases/Renderable"><code>Renderable</code></a>&gt;[]</p></blockquote><p>The components to render inside the vue feature</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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L39" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:39</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;"></a></h3><blockquote><p><strong>id</strong>: <code>string</code></p></blockquote><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</p><h4 id="defined-in-3" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-3" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L31" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:31</a></p><hr><h3 id="style" tabindex="-1">style? <a class="header-anchor" href="#style" aria-label="Permalink to &quot;style?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>style</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a>&lt;<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>&gt;</p></blockquote><p>CSS to apply to this feature.</p><h4 id="defined-in-4" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-4" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L37" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:37</a></p><hr><h3 id="visibility" tabindex="-1">visibility? <a class="header-anchor" href="#visibility" aria-label="Permalink to &quot;visibility?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>visibility</strong>: <a href="https://vuejs.org/api/utility-types.html#mayberef" target="_blank" rel="noreferrer"><code>MaybeRef</code></a>&lt;boolean | Visibility&gt;</p></blockquote><p>Whether this feature should be visible.</p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L33" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:33</a></p><hr><h3 id="wrappers" tabindex="-1">wrappers <a class="header-anchor" href="#wrappers" aria-label="Permalink to &quot;wrappers&quot;"></a></h3><blockquote><p><strong>wrappers</strong>: <a href="./../type-aliases/Wrapper"><code>Wrapper</code></a>[]</p></blockquote><p>The components to render wrapped around the vue feature</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-label="Permalink to &quot;Defined in&quot;"></a></h4><p><a href="https://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L41" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:41</a></p>',46)]))}const p=a(o,[["render",s]]);export{h as __pageData,p as default};