profectus-docs/assets/api_modules_features_infobox.md.2d5cad15.js

import{_ as e,c as t,o,N as a}from"./chunks/framework.0799945b.js";const u=JSON.parse('{"title":"Module: features/infoboxes/infobox","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/infobox.md","lastUpdated":null}'),l={name:"api/modules/features/infobox.md"},d=a('<h1 id="module-features-infoboxes-infobox" tabindex="-1">Module: features/infoboxes/infobox <a class="header-anchor" href="#module-features-infoboxes-infobox" aria-label="Permalink to &quot;Module: features/infoboxes/infobox&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="baseinfobox" tabindex="-1">BaseInfobox <a class="header-anchor" href="#baseinfobox" aria-label="Permalink to &quot;BaseInfobox&quot;">​</a></h3><p>• <strong>BaseInfobox</strong>: <code>Object</code></p><p>The properties that are added onto a processed <a href="./infobox#infoboxoptions">InfoboxOptions</a> to create an <a href="./infobox#infobox">Infobox</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>collapsed</code></td><td style="text-align:left;"><a href="./../game/persistence#persistent"><code>Persistent</code></a>&lt;<code>boolean</code>&gt;</td><td style="text-align:left;">Whether or not this infobox is collapsed.</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>type</code></td><td style="text-align:left;">typeof <a href="./infobox#infoboxtype"><code>InfoboxType</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/infoboxes/infobox.ts#L50" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:50</a></p><hr><h3 id="infoboxoptions" tabindex="-1">InfoboxOptions <a class="header-anchor" href="#infoboxoptions" aria-label="Permalink to &quot;InfoboxOptions&quot;">​</a></h3><p>• <strong>InfoboxOptions</strong>: <code>Object</code></p><p>An object that configures an <a href="./infobox#infobox">Infobox</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>bodyStyle?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&lt;<a href="./feature#stylevalue"><code>StyleValue</code></a>&gt;</td><td style="text-align:left;">CSS to apply to the body of the infobox.</td></tr><tr><td style="text-align:left;"><code>classes?</code></td><td style="text-align:left;"><a href="./../util/computed#computable"><code>Computable</code></a>&lt;<a href="https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type" target="_blank"