profectus-docs/assets/api_interfaces_features_infoboxes_infobox.InfoboxOptions.md.ad5967ef.js

2 lines
7.1 KiB
JavaScript
Raw Normal View History

import{_ as e,c as o,o as t,N as a}from"./chunks/framework.0799945b.js";const p=JSON.parse('{"title":"Interface: InfoboxOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/interfaces/features/infoboxes/infobox.InfoboxOptions.md","lastUpdated":null}'),r={name:"api/interfaces/features/infoboxes/infobox.InfoboxOptions.md"},i=a('<h1 id="interface-infoboxoptions" tabindex="-1">Interface: InfoboxOptions <a class="header-anchor" href="#interface-infoboxoptions" aria-label="Permalink to &quot;Interface: InfoboxOptions&quot;"></a></h1><p><a href="./../../../modules/features/infoboxes/infobox">features/infoboxes/infobox</a>.InfoboxOptions</p><p>An object that configures 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="bodystyle" tabindex="-1">bodyStyle <a class="header-anchor" href="#bodystyle" aria-label="Permalink to &quot;bodyStyle&quot;"></a></h3><p> <code>Optional</code> <strong>bodyStyle</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#stylevalue"><code>StyleValue</code></a>&gt;</p><p>CSS to apply to the body of the infobox.</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#L38" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:38</a></p><hr><h3 id="classes" tabindex="-1">classes <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes&quot;"></a></h3><p> <code>Optional</code> <strong>classes</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<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>boolean</code>&gt;&gt;</p><p>Dictionary of CSS classes to apply to this feature.</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#L40" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:40</a></p><hr><h3 id="color" tabindex="-1">color <a class="header-anchor" href="#color" aria-label="Permalink to &quot;color&quot;"></a></h3><p> <code>Optional</code> <strong>color</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<code>string</code>&gt;</p><p>The background color of the Infobox.</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#L32" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:32</a></p><hr><h3 id="display" tabindex="-1">display <a class="header-anchor" href="#display" aria-label="Permalink to &quot;display&quot;"></a></h3><p> <strong>display</strong>: <a href="./../../../modules/util/computed#computable"><code>Computable</code></a>&lt;<a href="./../../../modules/features/feature#coercablecomponent"><code>CoercableComponent</code></a>&gt;</p><p>The main text that appears in the display.</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#L44" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.ts:44</a></p><hr><h3 id="style" ta