profectus-docs/assets/api_features_infoboxes_infobox_interfaces_InfoboxOptions.md.BLnlf-mq.lean.js

2 lines
9 KiB
JavaScript
Raw Normal View History

import{_ as t,c as r,a0 as a,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: InfoboxOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/infoboxes/infobox/interfaces/InfoboxOptions.md","filePath":"api/features/infoboxes/infobox/interfaces/InfoboxOptions.md","lastUpdated":null}'),i={name:"api/features/infoboxes/infobox/interfaces/InfoboxOptions.md"};function n(s,e,l,c,f,d){return o(),r("div",null,e[0]||(e[0]=[a('<p><a href="./../../../../">Profectus</a> / <a href="./../">features/infoboxes/infobox</a> / InfoboxOptions</p><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>An object that configures an <a href="./Infobox">Infobox</a>.</p><h2 id="extends" tabindex="-1">Extends <a class="header-anchor" href="#extends" aria-label="Permalink to &quot;Extends&quot;"></a></h2><ul><li><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a></li></ul><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><blockquote><p><code>optional</code> <strong>bodyStyle</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<a href="https://vuejs.org/api/utility-types.html#cssproperties" target="_blank" rel="noreferrer"><code>CSSProperties</code></a>&gt;</p></blockquote><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://code.incremental.social/profectus/Profectus/src/branch/main/src/features/infoboxes/infobox.tsx#L21" target="_blank" rel="noreferrer">profectus/src/features/infoboxes/infobox.tsx:21</a></p><hr><h3 id="classes" tabindex="-1">classes? <a class="header-anchor" href="#classes" aria-label="Permalink to &quot;classes?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>classes</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</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></blockquote><p>Dictionary of CSS classes to apply to this feature.</p><h4 id="inherited-from" tabindex="-1">Inherited from <a class="header-anchor" href="#inherited-from" aria-label="Permalink to &quot;Inherited from&quot;"></a></h4><p><a href="./../../../../util/vue/interfaces/VueFeatureOptions"><code>VueFeatureOptions</code></a>.<a href="./../../../../util/vue/interfaces/VueFeatureOptions#classes"><code>classes</code></a></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://code.incremental.social/profectus/Profectus/src/branch/main/src/util/vue.tsx#L24" target="_blank" rel="noreferrer">profectus/src/util/vue.tsx:24</a></p><hr><h3 id="color" tabindex="-1">color? <a class="header-anchor" href="#color" aria-label="Permalink to &quot;color?&quot;"></a></h3><blockquote><p><code>optional</code> <strong>color</strong>: <a href="https://vuejs.org/api/utility-types.html#maybereforgetter" target="_blank" rel="noreferrer"><code>MaybeRefOrGetter</code></a>&lt;<code>string</code>&gt;</p></blockquote><p>The background color of the Infobox. Defaults to the layer color.</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><