import{_ as e,c as t,o as a,N as r}from"./chunks/framework.0799945b.js";const f=JSON.parse('{"title":"Module: features/bars/bar","description":"","frontmatter":{"editLink":false},"headers":[],"relativePath":"api/modules/features/bars/bar.md","lastUpdated":null}'),o={name:"api/modules/features/bars/bar.md"},c=r('

Module: features/bars/bar ​

Components ​

Interfaces ​

Type Aliases ​

Bar ​

Ƭ Bar<T>: Replace<T & BaseBar, { baseStyle: GetComputableType<T["baseStyle"]> ; borderStyle: GetComputableType<T["borderStyle"]> ; classes: GetComputableType<T["classes"]> ; direction: GetComputableType<T["direction"]> ; display: GetComputableType<T["display"]> ; fillStyle: GetComputableType<T["fillStyle"]> ; height: GetComputableType<T["height"]> ; mark: GetComputableType<T["mark"]> ; progress: GetComputableType<T["progress"]> ; style: GetComputableType<T["style"]> ; textStyle: GetComputableType<T["textStyle"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> ; width: GetComputableType<T["width"]> }>

An object that represents a feature that displays some sort of progress or completion or resource with a cap.

Type parameters ​

NameType
Textends BarOptions

Defined in ​

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

GenericBar ​

Ƭ GenericBar: Replace<Bar<BarOptions>, { visibility: ProcessedComputable<Visibility | boolean> }>

A type that matches any valid Bar object.

Defined in ​

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

Variables ​

BarType ​

• Const BarType: typeof BarType

A symbol used to identify Bar features.

Defined in ​

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

Functions ​

createBar ​

▸ createBar<T>(optionsFunc): Bar<T>

Lazily creates a bar with the given options.

Type parameters ​

NameType
Textends BarOptions

Parameters ​

NameTypeDescription
optionsFuncOptionsFunc<T, BaseBar, GenericBar>Bar options.

Returns ​

Bar<T>

Defined in ​

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

',37),d=[c];function s(l,i,n,u,p,b){return a(),t("div",null,d)}const m=e(o,[["render",s]]);export{f as __pageData,m as default};