profectus-docs/assets/api_interfaces_features_tabs_tabFamily.BaseTabFamily.md.ebc82f55.js

1 line
11 KiB
JavaScript

import{_ as e,c as o,o as t,a as d}from"./app.e5a3543f.js";const b='{"title":"Interface: BaseTabFamily","description":"","frontmatter":{},"headers":[{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"[Component]","slug":"component"},{"level":3,"title":"activeTab","slug":"activetab"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"selected","slug":"selected"},{"level":3,"title":"tabs","slug":"tabs"},{"level":3,"title":"type","slug":"type"},{"level":2,"title":"Methods","slug":"methods"},{"level":3,"title":"[GatherProps]","slug":"gatherprops"}],"relativePath":"api/interfaces/features/tabs/tabFamily.BaseTabFamily.md"}',c={},a=d('<h1 id="interface-basetabfamily" tabindex="-1">Interface: BaseTabFamily <a class="header-anchor" href="#interface-basetabfamily" aria-hidden="true">#</a></h1><p><a href="./../../../modules/features/tabs/tabFamily.html">features/tabs/tabFamily</a>.BaseTabFamily</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-hidden="true">#</a></h3><p>\u2022 <strong>[Component]</strong>: <code>DefineComponent</code>&lt;{ <code>activeTab</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>null</code> | <a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./../../../modules/features/tabs/tab.html#generictab"><code>GenericTab</code></a>&gt;&gt; } ; <code>classes</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>selected</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<code>Ref</code>&lt;<code>string</code>&gt;&gt; } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; ; <code>tabs</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <a href="./../../../modules/features/tabs/tabFamily.html#generictabbutton"><code>GenericTabButton</code></a>&gt;&gt;&gt; } ; <code>visibility</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;&gt; } }, { <code>Visibility</code>: typeof <a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a> ; <code>component</code>: <code>ShallowRef</code>&lt;<code>string</code> | <code>Component</code>&lt;<code>any</code>, <code>any</code>, <code>any</code>, <code>ComputedOptions</code>, <code>MethodOptions</code>&gt;&gt; ; <code>floating</code>: <code>ComputedRef</code>&lt;<code>boolean</code>&gt; ; <code>gatherButtonProps</code>: (<code>button</code>: <a href="./../../../modules/features/tabs/tabFamily.html#generictabbutton"><code>GenericTabButton</code></a>) =&gt; { <code>classes</code>: <code>undefined</code> | <code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt; | <code>Ref</code>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt; ; <code>display</code>: <a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | <code>Ref</code>&lt;<a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt; ; <code>glowColor</code>: <code>undefined</code> | <code>string</code> | <code>Ref</code>&lt;<code>string</code>&gt; ; <code>style</code>: <code>undefined</code> | <code>string</code> | <code>CSSProperties</code> | (<code>string</code> | <code>CSSProperties</code>)[] ; <code>visibility</code>: <a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; } ; <code>tabClasses</code>: <code>ComputedRef</code>&lt;<code>undefined</code> | <code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt; ; <code>tabStyle</code>: <code>ComputedRef</code>&lt;<code>undefined</code> | <code>string</code> | <code>CSSProperties</code> | (<code>string</code> | <code>CSSProperties</code>)[]&gt; ; <code>unref</code>: &lt;T&gt;(<code>ref</code>: <code>T</code> | <code>Ref</code>&lt;<code>T</code>&gt;) =&gt; <code>T</code> }, <code>unknown</code>, {}, {}, <code>ComponentOptionsMixin</code>, <code>ComponentOptionsMixin</code>, <code>Record</code>&lt;<code>string</code>, <code>any</code>&gt;, <code>string</code>, <code>PublicProps</code>, <code>Readonly</code>&lt;<code>ExtractPropTypes</code>&lt;{ <code>activeTab</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>null</code> | <a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./../../../modules/features/tabs/tab.html#generictab"><code>GenericTab</code></a>&gt;&gt; } ; <code>classes</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <code>boolean</code>&gt;&gt;&gt; ; <code>selected</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<code>Ref</code>&lt;<code>string</code>&gt;&gt; } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="./../../../modules/features/feature.html#stylevalue"><code>StyleValue</code></a>&gt;&gt; ; <code>tabs</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>Record</code>&lt;<code>string</code>, <a href="./../../../modules/features/tabs/tabFamily.html#generictabbutton"><code>GenericTabButton</code></a>&gt;&gt;&gt; } ; <code>visibility</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt;&gt; } }&gt;&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/2e3f1de/src/features/tabs/tabFamily.ts#L74" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:74</a></p><hr><h3 id="activetab" tabindex="-1">activeTab <a class="header-anchor" href="#activetab" aria-hidden="true">#</a></h3><p>\u2022 <strong>activeTab</strong>: <code>Ref</code>&lt;<code>null</code> | <a href="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./../../../modules/features/tabs/tab.html#generictab"><code>GenericTab</code></a>&gt;</p><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/2e3f1de/src/features/tabs/tabFamily.ts#L71" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:71</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-hidden="true">#</a></h3><p>\u2022 <strong>id</strong>: <code>string</code></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/2e3f1de/src/features/tabs/tabFamily.ts#L69" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:69</a></p><hr><h3 id="selected" tabindex="-1">selected <a class="header-anchor" href="#selected" aria-hidden="true">#</a></h3><p>\u2022 <strong>selected</strong>: <a href="./../../../modules/game/persistence.html#persistent"><code>Persistent</code></a>&lt;<code>string</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/2e3f1de/src/features/tabs/tabFamily.ts#L72" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:72</a></p><hr><h3 id="tabs" tabindex="-1">tabs <a class="header-anchor" href="#tabs" aria-hidden="true">#</a></h3><p>\u2022 <strong>tabs</strong>: <code>Record</code>&lt;<code>string</code>, <a href="./tabFamily.TabButtonOptions"><code>TabButtonOptions</code></a>&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/2e3f1de/src/features/tabs/tabFamily.ts#L70" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:70</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-hidden="true">#</a></h3><p>\u2022 <strong>type</strong>: typeof <a href="./../../../modules/features/tabs/tabFamily.html#tabfamilytype"><code>TabFamilyType</code></a></p><h4 id="defined-in-5" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-5" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/tabs/tabFamily.ts#L73" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:73</a></p><h2 id="methods" tabindex="-1">Methods <a class="header-anchor" href="#methods" aria-hidden="true">#</a></h2><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-hidden="true">#</a></h3><p>\u25B8 <strong>[GatherProps]</strong>(): <code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>&gt;</p><h4 id="defined-in-6" tabindex="-1">Defined in <a class="header-anchor" href="#defined-in-6" aria-hidden="true">#</a></h4><p><a href="https://github.com/profectus-engine/Profectus/blob/2e3f1de/src/features/tabs/tabFamily.ts#L75" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:75</a></p>',39),r=[a];function s(i,l,n,u,p,h){return t(),o("div",null,r)}var m=e(c,[["render",s]]);export{b as __pageData,m as default};