profectus-docs/assets/api_modules_features_tabs_tabFamily.md.79dcc0db.js

1 line
11 KiB
JavaScript

import{_ as e,c as t,o as a,a as i}from"./app.ab34650d.js";const p=JSON.parse('{"title":"Module: features/tabs/tabFamily","description":"","frontmatter":{"editLink":false},"headers":[{"level":2,"title":"Components","slug":"components"},{"level":2,"title":"Interfaces","slug":"interfaces"},{"level":2,"title":"Type Aliases","slug":"type-aliases"},{"level":3,"title":"GenericTabButton","slug":"generictabbutton"},{"level":3,"title":"GenericTabFamily","slug":"generictabfamily"},{"level":3,"title":"TabButton","slug":"tabbutton"},{"level":3,"title":"TabFamily","slug":"tabfamily"},{"level":2,"title":"Variables","slug":"variables"},{"level":3,"title":"TabButtonType","slug":"tabbuttontype"},{"level":3,"title":"TabFamilyType","slug":"tabfamilytype"},{"level":2,"title":"Functions","slug":"functions"},{"level":3,"title":"createTabFamily","slug":"createtabfamily"}],"relativePath":"api/modules/features/tabs/tabFamily.md","lastUpdated":null}'),r={name:"api/modules/features/tabs/tabFamily.md"},o=i('<h1 id="module-features-tabs-tabfamily" tabindex="-1">Module: features/tabs/tabFamily <a class="header-anchor" href="#module-features-tabs-tabfamily" aria-hidden="true">#</a></h1><h2 id="components" tabindex="-1">Components <a class="header-anchor" href="#components" aria-hidden="true">#</a></h2><ul><li><a href="./TabButtonComponent.html">TabButton</a></li><li><a href="./TabComponent.html">Tab</a></li><li><a href="./TabFamilyComponent.html">TabFamily</a></li></ul><h2 id="interfaces" tabindex="-1">Interfaces <a class="header-anchor" href="#interfaces" aria-hidden="true">#</a></h2><ul><li><a href="../../../interfaces/features/tabs/tabFamily.BaseTabButton">BaseTabButton</a></li><li><a href="../../../interfaces/features/tabs/tabFamily.BaseTabFamily">BaseTabFamily</a></li><li><a href="../../../interfaces/features/tabs/tabFamily.TabButtonOptions">TabButtonOptions</a></li><li><a href="../../../interfaces/features/tabs/tabFamily.TabFamilyOptions">TabFamilyOptions</a></li></ul><h2 id="type-aliases" tabindex="-1">Type Aliases <a class="header-anchor" href="#type-aliases" aria-hidden="true">#</a></h2><h3 id="generictabbutton" tabindex="-1">GenericTabButton <a class="header-anchor" href="#generictabbutton" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericTabButton</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./tabFamily.html#tabbutton"><code>TabButton</code></a>&lt;<a href="../../../interfaces/features/tabs/tabFamily.TabButtonOptions"><code>TabButtonOptions</code></a>&gt;, { <code>visibility</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&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/013092f/src/features/tabs/tabFamily.ts#L48" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:48</a></p><hr><h3 id="generictabfamily" tabindex="-1">GenericTabFamily <a class="header-anchor" href="#generictabfamily" aria-hidden="true">#</a></h3><p>\u01AC <strong>GenericTabFamily</strong>: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<a href="./tabFamily.html#tabfamily"><code>TabFamily</code></a>&lt;<a href="../../../interfaces/features/tabs/tabFamily.TabFamilyOptions"><code>TabFamilyOptions</code></a>&gt;, { <code>visibility</code>: <a href="./../../util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<a href="../../../enums/features/feature.Visibility"><code>Visibility</code></a>&gt; }&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/013092f/src/features/tabs/tabFamily.ts#L81" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:81</a></p><hr><h3 id="tabbutton" tabindex="-1">TabButton <a class="header-anchor" href="#tabbutton" aria-hidden="true">#</a></h3><p>\u01AC <strong>TabButton</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/tabs/tabFamily.BaseTabButton"><code>BaseTabButton</code></a>, { <code>classes</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;classes&quot;</code>]&gt; ; <code>display</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;display&quot;</code>]&gt; ; <code>glowColor</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;glowColor&quot;</code>]&gt; ; <code>style</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;style&quot;</code>]&gt; ; <code>tab</code>: <a href="./../../util/computed.html#getcomputabletype"><code>GetComputableType</code></a>&lt;<code>T</code>[<code>&quot;tab&quot;</code>]&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters" aria-hidden="true">#</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-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/tabs/tabFamily.TabButtonOptions"><code>TabButtonOptions</code></a></td></tr></tbody></table><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/013092f/src/features/tabs/tabFamily.ts#L36" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:36</a></p><hr><h3 id="tabfamily" tabindex="-1">TabFamily <a class="header-anchor" href="#tabfamily" aria-hidden="true">#</a></h3><p>\u01AC <strong>TabFamily</strong>&lt;<code>T</code>&gt;: <a href="./../feature.html#replace"><code>Replace</code></a>&lt;<code>T</code> &amp; <a href="../../../interfaces/features/tabs/tabFamily.BaseTabFamily"><code>BaseTabFamily</code></a>, { <code>tabs</code>: <code>Record</code>&lt;<code>string</code>, <a href="./tabFamily.html#generictabbutton"><code>GenericTabButton</code></a>&gt; ; <code>visibility</code>: <a href="./../../util/computed.html#getcomputabletypewithdefault"><code>GetComputableTypeWithDefault</code></a>&lt;<code>T</code>[<code>&quot;visibility&quot;</code>], <a href="./../../../enums/features/feature.Visibility.html#visible"><code>Visible</code></a>&gt; }&gt;</p><h4 id="type-parameters-1" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-1" aria-hidden="true">#</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-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/tabs/tabFamily.TabFamilyOptions"><code>TabFamilyOptions</code></a></td></tr></tbody></table><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/013092f/src/features/tabs/tabFamily.ts#L73" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:73</a></p><h2 id="variables" tabindex="-1">Variables <a class="header-anchor" href="#variables" aria-hidden="true">#</a></h2><h3 id="tabbuttontype" tabindex="-1">TabButtonType <a class="header-anchor" href="#tabbuttontype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>TabButtonType</strong>: typeof <a href="./tabFamily.html#tabbuttontype"><code>TabButtonType</code></a></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/013092f/src/features/tabs/tabFamily.ts#L19" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:19</a></p><hr><h3 id="tabfamilytype" tabindex="-1">TabFamilyType <a class="header-anchor" href="#tabfamilytype" aria-hidden="true">#</a></h3><p>\u2022 <code>Const</code> <strong>TabFamilyType</strong>: typeof <a href="./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/013092f/src/features/tabs/tabFamily.ts#L20" target="_blank" rel="noopener noreferrer">profectus/src/features/tabs/tabFamily.ts:20</a></p><h2 id="functions" tabindex="-1">Functions <a class="header-anchor" href="#functions" aria-hidden="true">#</a></h2><h3 id="createtabfamily" tabindex="-1">createTabFamily <a class="header-anchor" href="#createtabfamily" aria-hidden="true">#</a></h3><p>\u25B8 <strong>createTabFamily</strong>&lt;<code>T</code>&gt;(<code>tabs</code>, <code>optionsFunc?</code>): <a href="./tabFamily.html#tabfamily"><code>TabFamily</code></a>&lt;<code>T</code>&gt;</p><h4 id="type-parameters-2" tabindex="-1">Type parameters <a class="header-anchor" href="#type-parameters-2" aria-hidden="true">#</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-align:left;"><code>T</code></td><td style="text-align:left;">extends <a href="../../../interfaces/features/tabs/tabFamily.TabFamilyOptions"><code>TabFamilyOptions</code></a></td></tr></tbody></table><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</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-align:left;"><code>tabs</code></td><td style="text-align:left;"><code>Record</code>&lt;<code>string</code>, () =&gt; <a href="../../../interfaces/features/tabs/tabFamily.TabButtonOptions"><code>TabButtonOptions</code></a>&gt;</td></tr><tr><td style="text-align:left;"><code>optionsFunc?</code></td><td style="text-align:left;"><a href="./../feature.html#optionsfunc"><code>OptionsFunc</code></a>&lt;<code>T</code>, <a href="../../../interfaces/features/tabs/tabFamily.BaseTabFamily"><code>BaseTabFamily</code></a>, <a href="./tabFamily.html#generictabfamily"><code>GenericTabFamily</code></a>&gt;</td></tr></tbody></table><h4 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-hidden="true">#</a></h4><p><a href="./tabFamily.html#tabfamily"><code>TabFamily</code></a>&lt;<code>T</code>&gt;</p>',48),l=[o];function d(s,c,n,b,h,f){return a(),t("div",null,l)}var m=e(r,[["render",d]]);export{p as __pageData,m as default};