Profectus
On this page

Interface: BarOptions ​

features/bars/bar.BarOptions

An object that configures a Bar.

Properties ​

baseStyle ​

• Optional baseStyle: Computable<StyleValue>

CSS to apply to the bar's base.

Defined in ​

profectus/src/features/bars/bar.ts:44

borderStyle ​

• Optional borderStyle: Computable<StyleValue>

CSS to apply to the bar's border.

Defined in ​

profectus/src/features/bars/bar.ts:42

classes ​

• Optional classes: Computable<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Defined in ​

profectus/src/features/bars/bar.ts:40

direction ​

• direction: Computable<Direction>

The direction in which the bar progresses.

Defined in ​

profectus/src/features/bars/bar.ts:36

display ​

• Optional display: Computable<CoercableComponent>

The display to use for this bar.

Defined in ​

profectus/src/features/bars/bar.ts:52

fillStyle ​

• Optional fillStyle: Computable<StyleValue>

CSS to apply to the bar's fill.

Defined in ​

profectus/src/features/bars/bar.ts:48

height ​

• height: Computable<number>

The height of the bar.

Defined in ​

profectus/src/features/bars/bar.ts:34

mark ​

• Optional mark: Computable<string | boolean>

Shows a marker on the corner of the feature.

Defined in ​

profectus/src/features/bars/bar.ts:54

progress ​

• progress: Computable<DecimalSource>

The progress value of the bar, from 0 to 1.

Defined in ​

profectus/src/features/bars/bar.ts:50

style ​

• Optional style: Computable<StyleValue>

CSS to apply to this feature.

Defined in ​

profectus/src/features/bars/bar.ts:38

textStyle ​

• Optional textStyle: Computable<StyleValue>

CSS to apply to the bar's text.

Defined in ​

profectus/src/features/bars/bar.ts:46

visibility ​

• Optional visibility: Computable<boolean | Visibility>

Whether this bar should be visible.

Defined in ​

profectus/src/features/bars/bar.ts:30

width ​

• width: Computable<number>

The width of the bar.

Defined in ​

profectus/src/features/bars/bar.ts:32