Profectus / features/bars/bar / BarOptions
Interface: BarOptions ​
An object that configures a Bar.
Extends ​
Properties ​
baseStyle? ​
optionalbaseStyle:MaybeRefOrGetter<CSSProperties>
CSS to apply to the bar's base.
Defined in ​
profectus/src/features/bars/bar.tsx:25
borderStyle? ​
optionalborderStyle:MaybeRefOrGetter<CSSProperties>
CSS to apply to the bar's border.
Defined in ​
profectus/src/features/bars/bar.tsx:23
classes? ​
optionalclasses:MaybeRefOrGetter<Record<string,boolean>>
Dictionary of CSS classes to apply to this feature.
Inherited from ​
Defined in ​
direction ​
direction:
MaybeRefOrGetter<Direction>
The direction in which the bar progresses.
Defined in ​
profectus/src/features/bars/bar.tsx:21
display? ​
optionaldisplay:MaybeGetter<Renderable>
The display to use for this bar.
Defined in ​
profectus/src/features/bars/bar.tsx:33
fillStyle? ​
optionalfillStyle:MaybeRefOrGetter<CSSProperties>
CSS to apply to the bar's fill.
Defined in ​
profectus/src/features/bars/bar.tsx:29
height ​
height:
MaybeRefOrGetter<number>
The height of the bar.
Defined in ​
profectus/src/features/bars/bar.tsx:19
progress ​
progress:
MaybeRefOrGetter<DecimalSource>
The progress value of the bar, from 0 to 1.
Defined in ​
profectus/src/features/bars/bar.tsx:31
style? ​
optionalstyle:MaybeRefOrGetter<CSSProperties>
CSS to apply to this feature.
Inherited from ​
Defined in ​
textStyle? ​
optionaltextStyle:MaybeRefOrGetter<CSSProperties>
CSS to apply to the bar's text.
Defined in ​
profectus/src/features/bars/bar.tsx:27
visibility? ​
optionalvisibility:MaybeRefOrGetter<boolean | Visibility>
Whether this feature should be visible.
Inherited from ​
Defined in ​
width ​
width:
MaybeRefOrGetter<number>
The width of the bar.