profectus-docs/assets/api_modules_features_tabs_tabFamily.md.ea7f06e8.js

import{_ as t,c as e,o as a,N as o}from"./chunks/framework.0799945b.js";const y=JSON.parse('{"title":"Module: features/tabs/tabFamily","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/tabs/tabFamily.md","lastUpdated":null}'),l={name:"api/modules/features/tabs/tabFamily.md"},r=o('<h1 id="module-features-tabs-tabfamily" tabindex="-1">Module: features/tabs/tabFamily <a class="header-anchor" href="#module-features-tabs-tabfamily" aria-label="Permalink to &quot;Module: features/tabs/tabFamily&quot;">​</a></h1><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-label="Permalink to &quot;Interfaces&quot;">​</a></h2><h3 id="basetabbutton" tabindex="-1">BaseTabButton <a class="header-anchor" href="#basetabbutton" aria-label="Permalink to &quot;BaseTabButton&quot;">​</a></h3><p>• <strong>BaseTabButton</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./tabFamily#tabbuttonoptions">TabButtonOptions</a> to create an <a href="./tabFamily#tabbutton">TabButton</a>.</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>[Component]</code></td><td style="text-align:left;"><a href="./../feature#genericcomponent"><code>GenericComponent</code></a></td><td style="text-align:left;">The Vue component used to render this feature.</td></tr><tr><td style="text-align:left;"><code>type</code></td><td style="text-align:left;">typeof <a href="./tabFamily#tabbuttontype"><code>TabButtonType</code></a></td><td style="text-align:left;">A symbol that helps identify features of the same type.</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/425e85a/src/features/tabs/tabFamily.ts#L58" target="_blank" rel="noreferrer">profectus/src/features/tabs/tabFamily.ts:58</a></p><hr><h3 id="basetabfamily" tabindex="-1">BaseTabFamily <a class="header-anchor" href="#basetabfamily" aria-label="Permalink to &quot;BaseTabFamily&quot;">​</a></h3><p>• <strong>BaseTabFamily</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./tabFamily#tabfamilyoptions">TabFamilyOptions</a> to create an <a href="./tabFamily#tabfamily">TabFamily</a>.</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>[Component]</code></td><td style="text-align:left;"><a href="./../feature#genericcomponent"><code>GenericComponent</code></a></td><td style="text-align:left;">The Vue component used to render this feature.</td></tr><tr><td style="text-align:left;"><code>[GatherProps]</code></td><td style="text-align:left;">() =&gt; <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>unknown</code>&gt;</td><td style="text-align:left;">A function to gather the props the vue component requires for this feature.</td></tr><tr><td style="text-align:left;"><code>activeTab</code></td><td style="text-align:left;"><code>Ref</code>&lt;<code>null</code> | <a href="./../feature#coercablecomponent"><code>CoercableComponent</code></a> | <a href="./tab#generictab"><code>GenericTab</code></a>&gt;</td><td style="text-align:left;">The currently active tab, if any.</td></tr><tr><td style="text-align:left;"><code>id</code></td><td style="text-align:left;"><code>string</code></td><td style="text-align:left;">An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</td></tr><tr><td style="text-align:left;"><code>selected</code></td><td style="text-align:left;"><a href="./../../game/persistence#pe