Profectus / features/bars/bar / Bar
Interface: Bar ​
An object that represents a feature that displays some sort of progress or completion or resource with a cap.
Extends ​
Properties ​
[VueFeature] ​
[VueFeature]:
true
Used to identify Vue Features
Inherited from ​
Defined in ​
baseStyle? ​
optionalbaseStyle:MaybeRef<CSSProperties>
CSS to apply to the bar's base.
Defined in ​
profectus/src/features/bars/bar.tsx:47
borderStyle? ​
optionalborderStyle:MaybeRef<CSSProperties>
CSS to apply to the bar's border.
Defined in ​
profectus/src/features/bars/bar.tsx:45
classes? ​
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
components ​
components:
MaybeGetter<Renderable>[]
The components to render inside the vue feature
Inherited from ​
Defined in ​
direction ​
The direction in which the bar progresses.
Defined in ​
profectus/src/features/bars/bar.tsx:43
display? ​
optionaldisplay:MaybeGetter<Renderable>
The display to use for this bar.
Defined in ​
profectus/src/features/bars/bar.tsx:55
fillStyle? ​
optionalfillStyle:MaybeRef<CSSProperties>
CSS to apply to the bar's fill.
Defined in ​
profectus/src/features/bars/bar.tsx:51
height ​
height:
MaybeRef<number>
The height of the bar.
Defined in ​
profectus/src/features/bars/bar.tsx:41
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 ​
progress ​
progress:
MaybeRef<DecimalSource>
The progress value of the bar, from 0 to 1.
Defined in ​
profectus/src/features/bars/bar.tsx:53
style? ​
optionalstyle:MaybeRef<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
textStyle? ​
optionaltextStyle:MaybeRef<CSSProperties>
CSS to apply to the bar's text.
Defined in ​
profectus/src/features/bars/bar.tsx:49
type ​
type: typeof
BarType
A symbol that helps identify features of the same type.
Defined in ​
profectus/src/features/bars/bar.tsx:57
visibility? ​
optionalvisibility:MaybeRef<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
width ​
width:
MaybeRef<number>
The width of the bar.
Defined in ​
profectus/src/features/bars/bar.tsx:39
wrappers ​
wrappers:
Wrapper[]
The components to render wrapped around the vue feature