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:21
classes? ​
optional
classes:MaybeRefOrGetter
<Record
<string
,boolean
>>
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
color? ​
optional
color:MaybeRefOrGetter
<string
>
The background color of the Infobox. Defaults to the layer color.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:17
display ​
display:
MaybeGetter
<Renderable
>
The main text that appears in the display.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:25
style? ​
optional
style:MaybeRefOrGetter
<CSSProperties
>
CSS to apply to this feature.
Inherited from ​
Defined in ​
title ​
title:
MaybeGetter
<Renderable
>
A header to appear at the top of the display.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:23
titleStyle? ​
optional
titleStyle:MaybeRefOrGetter
<CSSProperties
>
CSS to apply to the title of the infobox.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:19
visibility? ​
optional
visibility:MaybeRefOrGetter
<boolean | Visibility>
Whether this feature should be visible.