Skip to content

Profectus / features/infoboxes/infobox / InfoboxOptions

Interface: InfoboxOptions ​

An object that configures an Infobox.

Extends ​

Properties ​

bodyStyle? ​

optional bodyStyle: MaybeRefOrGetter<CSSProperties>

CSS to apply to the body of the infobox.

Defined in ​

profectus/src/features/infoboxes/infobox.tsx:32


classes? ​

optional classes: MaybeRefOrGetter<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeatureOptions.classes

Defined in ​

profectus/src/util/vue.tsx:24


color? ​

optional color: MaybeRefOrGetter<string>

The background color of the Infobox. Defaults to the layer color.

Defined in ​

profectus/src/features/infoboxes/infobox.tsx:28


display ​

display: MaybeGetter<Renderable>

The main text that appears in the display.

Defined in ​

profectus/src/features/infoboxes/infobox.tsx:36


style? ​

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeatureOptions.style

Defined in ​

profectus/src/util/vue.tsx:26


title ​

title: MaybeGetter<Renderable>

A header to appear at the top of the display.

Defined in ​

profectus/src/features/infoboxes/infobox.tsx:34


titleStyle? ​

optional titleStyle: MaybeRefOrGetter<CSSProperties>

CSS to apply to the title of the infobox.

Defined in ​

profectus/src/features/infoboxes/infobox.tsx:30


visibility? ​

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeatureOptions.visibility

Defined in ​

profectus/src/util/vue.tsx:22