profectus-docs/assets/api_features_tabs_tabFamily_interfaces_TabButtonOptions.md.CLHbMUhM.js

1 line
7.3 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 t,c as a,a0 as r,o}from"./chunks/framework.P9qPzDnn.js";const f=JSON.parse('{"title":"Interface: TabButtonOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/tabs/tabFamily/interfaces/TabButtonOptions.md","filePath":"api/features/tabs/tabFamily/interfaces/TabButtonOptions.md","lastUpdated":null}'),i={name:"api/features/tabs/tabFamily/interfaces/TabButtonOptions.md"};function s(n,e,l,c,d,h){return o(),a("div",null,e[0]||(e[0]=[r('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/tabs/tabFamily</a> / TabButtonOptions</p><h1 id="interface-tabbuttonoptions" tabindex="-1">Interface: TabButtonOptions <a class="header-anchor" href="#interface-tabbuttonoptions" aria-label="Permalink to &quot;Interface: TabButtonOptions&quot;"></a></h1><p>An object that configures a <a href="./TabButton">TabButton</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to &quot;Extends&quot;"></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</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="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#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to &quot;Inherited from&quot;"></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></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#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;"></a></h3><blockquote><p><strong>display</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a>&lt;<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>&gt;</p></blockquote><p>The label on this button.</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/features/tabs/tabFamily.tsx#L25" target="_blank" rel="noreferrer">profectus/src/features/tabs/tabFamily.tsx:25</a></p><hr><h3 id="glowcolor" tabindex="-1">glowColor? <a class="header-anchor" href="#glowcolor" aria-label="Permalink to &quot;glowColor?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>glowColor</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>string</code>&gt;</p></blockquote><p>The color of the glow effect to display when this button is active.</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/features/tabs/tabFamily.tsx#L27" target="_blank" rel="noreferrer">profectus/src/features/tabs/tabFamily.tsx:27</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#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-label="Permalink to &quot;Inherited from&quot;"></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#style"><code>style</code></a></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#L26" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:26</a></p><hr><h3 id="tab" tabindex="-1">tab <a class="header-anchor" href="#tab" aria-label="Permalink to &quot;tab&quot;"></a></h3><blockquote><p><strong>tab</strong>: <a href="./../../../../util/computed/type-aliases/MaybeGetter"><code>MaybeGetter</code></a>&lt;<a href="./../../../../util/vue/type-aliases/Renderable"><code>Renderable</code></a>&gt; | <a href="./../../tab/interfaces/Tab"><code>Tab</code></a></p></blockquote><p>The tab to display when this button is clicked.</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/features/tabs/tabFamily.tsx#L23" target="_blank" rel="noreferrer">profectus/src/features/tabs/tabFamily.tsx:23</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#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;boolean | Visibility&gt;</p></blockquote><p>Whether this feature should be visible.</p><h4 id="inherited-from-2" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-2" aria-label="Permalink to &quot;Inherited from&quot;"></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#visibility"><code>visibility</code></a></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#L22" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:22</a></p>',47)]))}const p=t(i,[["render",s]]);export{f as __pageData,p as default};