import{_ as r,c as t,a0 as a,o}from"./chunks/framework.P9qPzDnn.js";const p=JSON.parse('{"title":"Interface: BarOptions","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/features/bars/bar/interfaces/BarOptions.md","filePath":"api/features/bars/bar/interfaces/BarOptions.md","lastUpdated":null}'),i={name:"api/features/bars/bar/interfaces/BarOptions.md"};function s(n,e,l,c,h,d){return o(),t("div",null,e[0]||(e[0]=[a('

Profectus / features/bars/bar / BarOptions

Interface: BarOptions

An object that configures a Bar.

Extends

Properties

baseStyle?

optional baseStyle: MaybeRefOrGetter<CSSProperties>

CSS to apply to the bar's base.

Defined in

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


borderStyle?

optional borderStyle: MaybeRefOrGetter<CSSProperties>

CSS to apply to the bar's border.

Defined in

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


classes?

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

Dictionary of CSS classes to apply to this feature.

Inherited from

VueFeatureOptions.classes

Defined in

profectus/src/util/vue.tsx:24


direction

direction: MaybeRefOrGetter<Direction>

The direction in which the bar progresses.

Defined in

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


display?

optional display: MaybeGetter<Renderable>

The display to use for this bar.

Defined in

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


fillStyle?

optional fillStyle: 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?

optional style: MaybeRefOrGetter<CSSProperties>

CSS to apply to this feature.

Inherited from

VueFeatureOptions.style

Defined in

profectus/src/util/vue.tsx:26


textStyle?

optional textStyle: MaybeRefOrGetter<CSSProperties>

CSS to apply to the bar's text.

Defined in

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


visibility?

optional visibility: MaybeRefOrGetter<boolean | Visibility>

Whether this feature should be visible.

Inherited from

VueFeatureOptions.visibility

Defined in

profectus/src/util/vue.tsx:22


width

width: MaybeRefOrGetter<number>

The width of the bar.

Defined in

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

',83)]))}const u=r(i,[["render",s]]);export{p as __pageData,u as default};