Profectus / features/infoboxes/infobox / Infobox
Interface: Infobox ​
An object that represents a feature that displays information in a collapsible way.
Extends ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
bodyStyle? ​
optional
bodyStyle:MaybeRef
<CSSProperties
>
CSS to apply to the body of the infobox.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:35
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
collapsed ​
collapsed:
Persistent
<boolean
>
Whether or not this infobox is collapsed.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:41
color? ​
optional
color:MaybeRef
<string
>
The background color of the Infobox.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:31
components ​
components:
MaybeGetter
<Renderable
>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
display ​
display:
MaybeGetter
<Renderable
>
The main text that appears in the display.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:39
id ​
id:
string
An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.
Inherited from ​
Defined in ​
style? ​
optional
style:MaybeRef
<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:37
titleStyle? ​
optional
titleStyle:MaybeRef
<CSSProperties
>
CSS to apply to the title of the infobox.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:33
type ​
type: typeof
InfoboxType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/infoboxes/infobox.tsx:43
visibility? ​
optional
visibility:MaybeRef
<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
wrappers ​
wrappers:
Wrapper
[]
The components to render wrapped around the vue feature