profectus-docs/assets/api_interfaces_features_infoboxes_infobox.BaseInfobox.md.22c67064.js

1 line
12 KiB
JavaScript

import{_ as e,c as o,o as d,a as t}from"./app.54d5a277.js";const b='{"title":"Interface: BaseInfobox","description":"","frontmatter":{},"headers":[{"level":2,"title":"Hierarchy","slug":"hierarchy"},{"level":2,"title":"Properties","slug":"properties"},{"level":3,"title":"[Component]","slug":"component"},{"level":3,"title":"[DefaultValue]","slug":"defaultvalue"},{"level":3,"title":"[PersistentState]","slug":"persistentstate"},{"level":3,"title":"collapsed","slug":"collapsed"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"type","slug":"type"},{"level":2,"title":"Methods","slug":"methods"},{"level":3,"title":"[GatherProps]","slug":"gatherprops"}],"relativePath":"api/interfaces/features/infoboxes/infobox.BaseInfobox.md"}',c={},r=t('<h1 id="interface-baseinfobox" tabindex="-1">Interface: BaseInfobox <a class="header-anchor" href="#interface-baseinfobox" aria-hidden="true">#</a></h1><p><a href="./../../../modules/features/infoboxes/infobox.html">features/infoboxes/infobox</a>.BaseInfobox</p><h2 id="hierarchy" tabindex="-1">Hierarchy <a class="header-anchor" href="#hierarchy" aria-hidden="true">#</a></h2><ul><li><p><a href="./../../../modules/game/persistence.html#persistent"><code>Persistent</code></a>&lt;<code>boolean</code>&gt;</p><p>\u21B3 <strong><code>BaseInfobox</code></strong></p></li></ul><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>bodyStyle</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&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>collapsed</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<code>Ref</code>&lt;<code>boolean</code>&gt;&gt; } ; <code>color</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code>&gt;&gt; ; <code>display</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="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;&gt; } ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&gt;&gt; ; <code>title</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="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;&gt; } ; <code>titleStyle</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&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>bodyComponent</code>: <code>ShallowRef</code>&lt;<code>&quot;&quot;</code> | <a href="./../../../modules/features/feature.html#jsxfunction"><code>JSXFunction</code></a> | <code>Component</code>&lt;<code>any</code>, <code>any</code>, <code>any</code>, <code>ComputedOptions</code>, <code>MethodOptions</code>&gt;&gt; ; <code>stacked</code>: <code>ComputedRef</code>&lt;<code>boolean</code>&gt; ; <code>titleComponent</code>: <code>ShallowRef</code>&lt;<code>&quot;&quot;</code> | <a href="./../../../modules/features/feature.html#jsxfunction"><code>JSXFunction</code></a> | <code>Component</code>&lt;<code>any</code>, <code>any</code>, <code>any</code>, <code>ComputedOptions</code>, <code>MethodOptions</code>&gt;&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>bodyStyle</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&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>collapsed</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>PropType</code>&lt;<code>Ref</code>&lt;<code>boolean</code>&gt;&gt; } ; <code>color</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>string</code>&gt;&gt; ; <code>display</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="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;&gt; } ; <code>id</code>: { <code>required</code>: <code>true</code> = true; <code>type</code>: <code>StringConstructor</code> = String } ; <code>style</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&gt;&gt; ; <code>title</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="./../../../modules/features/feature.html#coercablecomponent"><code>CoercableComponent</code></a>&gt;&gt; } ; <code>titleStyle</code>: <code>PropType</code>&lt;<a href="./../../../modules/util/computed.html#processedcomputable"><code>ProcessedComputable</code></a>&lt;<code>StyleValue</code>&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/305946e/src/features/infoboxes/infobox.ts#L40" target="_blank" rel="noopener noreferrer">profectus/src/features/infoboxes/infobox.ts:40</a></p><hr><h3 id="defaultvalue" tabindex="-1">[DefaultValue] <a class="header-anchor" href="#defaultvalue" aria-hidden="true">#</a></h3><p>\u2022 <strong>[DefaultValue]</strong>: <code>boolean</code></p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-hidden="true">#</a></h4><p>Persistent.__@DefaultValue@18652</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/305946e/src/game/persistence.ts#L25" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:25</a></p><hr><h3 id="persistentstate" tabindex="-1">[PersistentState] <a class="header-anchor" href="#persistentstate" aria-hidden="true">#</a></h3><p>\u2022 <strong>[PersistentState]</strong>: <code>Ref</code>&lt;<code>boolean</code>&gt;</p><h4 id="inherited-from-1" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from-1" aria-hidden="true">#</a></h4><p>Persistent.__@PersistentState@18650</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/305946e/src/game/persistence.ts#L24" target="_blank" rel="noopener noreferrer">profectus/src/game/persistence.ts:24</a></p><hr><h3 id="collapsed" tabindex="-1">collapsed <a class="header-anchor" href="#collapsed" aria-hidden="true">#</a></h3><p>\u2022 <strong>collapsed</strong>: <code>Ref</code>&lt;<code>boolean</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/305946e/src/features/infoboxes/infobox.ts#L38" target="_blank" rel="noopener noreferrer">profectus/src/features/infoboxes/infobox.ts:38</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-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/305946e/src/features/infoboxes/infobox.ts#L37" target="_blank" rel="noopener noreferrer">profectus/src/features/infoboxes/infobox.ts:37</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/infoboxes/infobox.html#infoboxtype"><code>InfoboxType</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/305946e/src/features/infoboxes/infobox.ts#L39" target="_blank" rel="noopener noreferrer">profectus/src/features/infoboxes/infobox.ts:39</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/305946e/src/features/infoboxes/infobox.ts#L41" target="_blank" rel="noopener noreferrer">profectus/src/features/infoboxes/infobox.ts:41</a></p>',45),a=[r];function s(n,i,l,p,u,h){return d(),o("div",null,a)}var m=e(c,[["render",s]]);export{b as __pageData,m as default};