Profectus

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 ​

VueFeature.[VueFeature]

Defined in ​

profectus/src/util/vue.tsx:43

baseStyle? ​

optional baseStyle: MaybeRef<CSSProperties>

CSS to apply to the bar's base.

Defined in ​

profectus/src/features/bars/bar.tsx:73

borderStyle? ​

optional borderStyle: MaybeRef<CSSProperties>

CSS to apply to the bar's border.

Defined in ​

profectus/src/features/bars/bar.tsx:71

classes? ​

optional classes: MaybeRef<Record<string, boolean>>

Dictionary of CSS classes to apply to this feature.

Inherited from ​

VueFeature.classes

Defined in ​

profectus/src/util/vue.tsx:35

components ​

components: MaybeGetter<Renderable>[]

The components to render inside the vue feature

Inherited from ​

VueFeature.components

Defined in ​

profectus/src/util/vue.tsx:39

direction ​

direction: MaybeRef<Direction>

The direction in which the bar progresses.

Defined in ​

profectus/src/features/bars/bar.tsx:69

display? ​

optional display: MaybeGetter<Renderable>

The display to use for this bar.

Defined in ​

profectus/src/features/bars/bar.tsx:81

fillStyle? ​

optional fillStyle: MaybeRef<CSSProperties>

CSS to apply to the bar's fill.

Defined in ​

profectus/src/features/bars/bar.tsx:77

height ​

height: MaybeRef<number>

The height of the bar.

Defined in ​

profectus/src/features/bars/bar.tsx:67

id ​

id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Inherited from ​

VueFeature.id

Defined in ​

profectus/src/util/vue.tsx:31

progress ​

progress: MaybeRef<DecimalSource>

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

Defined in ​

profectus/src/features/bars/bar.tsx:79

style? ​

optional style: MaybeRef<CSSProperties>

CSS to apply to this feature.

Inherited from ​

VueFeature.style

Defined in ​

profectus/src/util/vue.tsx:37

textStyle? ​

optional textStyle: MaybeRef<CSSProperties>

CSS to apply to the bar's text.

Defined in ​

profectus/src/features/bars/bar.tsx:75

type ​

type: typeof BarType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/bars/bar.tsx:83

visibility? ​

optional visibility: MaybeRef<boolean | Visibility>

Whether this feature should be visible.

Inherited from ​

VueFeature.visibility

Defined in ​

profectus/src/util/vue.tsx:33

width ​

width: MaybeRef<number>

The width of the bar.

Defined in ​

profectus/src/features/bars/bar.tsx:65

wrappers ​

wrappers: Wrapper[]

The components to render wrapped around the vue feature

Inherited from ​

VueFeature.wrappers

Defined in ​

profectus/src/util/vue.tsx:41