profectus-docs/assets/api_interfaces_features_infoboxes_infobox.BaseInfobox.md.e89fa27e.js

import{_ as e,c as o,o as t,N as a}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Interface: BaseInfobox","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/infoboxes/infobox.BaseInfobox.md","lastUpdated":null}'),r={name:"api/interfaces/features/infoboxes/infobox.BaseInfobox.md"},n=a('<h1 id="interface-baseinfobox" tabindex="-1">Interface: BaseInfobox <a class="header-anchor" href="#interface-baseinfobox" aria-label="Permalink to &quot;Interface: BaseInfobox&quot;">​</a></h1><p><a href="./../../../modules/features/infoboxes/infobox">features/infoboxes/infobox</a>.BaseInfobox</p><p>The properties that are added onto a processed <a href="./infobox.InfoboxOptions">InfoboxOptions</a> to create an <a href="./../../../modules/features/infoboxes/infobox#infobox">Infobox</a>.</p><h2 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-label="Permalink to &quot;Properties&quot;">​</a></h2><h3 id="component" tabindex="-1">[Component] <a class="header-anchor" href="#component" aria-label="Permalink to &quot;[Component]&quot;">​</a></h3><p>• <strong>[Component]</strong>: <a href="./../../../modules/features/feature#genericcomponent"><code>GenericComponent</code></a></p><p>The Vue component used to render this feature.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/infoboxes/infobox.ts#L58" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:58</a></p><hr><h3 id="gatherprops" tabindex="-1">[GatherProps] <a class="header-anchor" href="#gatherprops" aria-label="Permalink to &quot;[GatherProps]&quot;">​</a></h3><p>• <strong>[GatherProps]</strong>: () =&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;</p><h4 id="type-declaration" tabindex="-1">Type declaration <a class="header-anchor" href="#type-declaration" aria-label="Permalink to &quot;Type declaration&quot;">​</a></h4><p>▸ (): <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;</p><p>A function to gather the props the vue component requires for this feature.</p><h5 id="returns" tabindex="-1">Returns <a class="header-anchor" href="#returns" aria-label="Permalink to &quot;Returns&quot;">​</a></h5><p><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;</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/infoboxes/infobox.ts#L60" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:60</a></p><hr><h3 id="collapsed" tabindex="-1">collapsed <a class="header-anchor" href="#collapsed" aria-label="Permalink to &quot;collapsed&quot;">​</a></h3><p>• <strong>collapsed</strong>: <a href="./../../../modules/game/persistence#persistent"><code>Persistent</code></a>&lt;<code>boolean</code>&gt;</p><p>Whether or not this infobox is collapsed.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/infoboxes/infobox.ts#L54" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:54</a></p><hr><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-label="Permalink to &quot;id&quot;">​</a></h3><p>• <strong>id</strong>: <code>string</code></p><p>An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/infoboxes/infobox.ts#L52" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:52</a></p><hr><h3 id="type" tabindex="-1">type <a class="header-anchor" href="#type" aria-label="Permalink to &quot;type&quot;">​</a></h3><p>• <strong>type</strong>: typeof <a href="./../../../modules/features/infoboxes/infobox#infoboxtype"><code>InfoboxType</code></a></p><p>A symbol that helps identify features of the same type.</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://github.com/profectus-engine/Profectus/blob/70cda5f/src/features/infoboxes/infobox.ts#L56" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:56</a></p>',37),s=[n];function i(f,d,c,p,h,l){return t(),o("div",null,s)}const x=e(r,[["render",i]]);export{u as __pageData,x as default};