ProgressBar

A progress bar widget which displays a horizontal progress bar with optional label and value text.

Progress bar
//<code-header>
fiddle.title = 'Progress bar';
//</code-header>
new ProgressBar({
    appendTo  : targetElement,
    label     : 'Backend API Dev.',
    valueText : 'All done',
    value     : 1
});

new ProgressBar({
    appendTo : targetElement,
    label    : 'Frontend',
    valueRenderer(value) {
        return `${value}/${this.max} tasks`;
    },
    max   : 12,
    value : 4,
    color : 'blue'
});

new ProgressBar({
    appendTo  : targetElement,
    label     : 'Database',
    valueText : '3/8 tasks',
    value     : 3 / 8,
    color     : 'orange'
});

new ProgressBar({
    appendTo  : targetElement,
    label     : 'Documentation',
    valueText : '1/5 tasks',
    value     : .2,
    color     : 'red'
});

new ProgressBar({
    appendTo  : targetElement,
    label     : 'Code Review',
    valueText : '10/15 tasks',
    value     : .67,
    color     : 'purple'
});

Configs

79

Common

listenersEvents

Other

Color of the progress bar ('b-green', 'b-yellow', 'b-orange', etc.)

The label text to display at the top left

Maximum value for progress calculation. When specified, value is treated as absolute.

Progress value. If max is specified, this is an absolute value (e.g., 8 out of 10). If max is not specified, this should be between 0 and 1 (e.g., 0.5 for 50%)

Template function that can be used to customize the displayed value

ParameterTypeDescription
valueNumber

The value to provide a textual value for

maxNumber

The max value of the progress bar

Returns: String | Number | null

The value text to display at the top right If not specified and max is provided, will auto-generate as "value/max"

columnWidget
rtlRTL
spanWidget

Accessibility

ariaLabelWidget
keyMapKeyMap

CSS

clsWidget
htmlClsWidget
styleWidget
uiWidget

DOM

adoptWidget
appendToWidget
contentWidget
datasetWidget
htmlWidget
idWidget
tagWidget
titleWidget

Float & align

alignWidget
anchorWidget
centeredWidget
draggableWidget
floatingWidget
xWidget
yWidget

Layout

alignSelfWidget
dockWidget
flexWidget
heightWidget
hiddenWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
textAlignWidget
weightWidget
widthWidget

Misc

dataFieldWidget
disabledWidget
localeClassLocalizable
localizableLocalizable
maskedWidget
ownerWidget
readOnlyWidget
refWidget
rippleWidget
tabWidget
tooltipWidget

Scrolling

Properties

71

Class hierarchy

isProgressBar: Boolean= truereadonly
Identifies an object as an instance of ProgressBar class, or subclass thereof.
isProgressBar: Boolean= truereadonlystatic
Identifies an object as an instance of ProgressBar class, or subclass thereof.
isDelayableDelayable
isEventsEvents
isKeyMapKeyMap
isLocalizableLocalizable
isWidgetWidget

Other

Color of the progress bar ('b-green', 'b-yellow', 'b-orange', etc.)

The label text to display at the top left

Maximum value for progress calculation. When specified, value is treated as absolute.

Progress value. If max is specified, this is an absolute value (e.g., 8 out of 10). If max is not specified, this should be between 0 and 1 (e.g., 0.5 for 50%)

Template function that can be used to customize the displayed value

ParameterTypeDescription
valueNumber

The value to provide a textual value for

maxNumber

The max value of the progress bar

Returns: String | Number | null

The value text to display at the top right If not specified and max is provided, will auto-generate as "value/max"

$namestaticWidget
columnWidget
rtlRTL
spanWidget
typestaticWidget

Accessibility

keyMapKeyMap

CSS

clsWidget

DOM

appendToWidget
contentWidget
datasetWidget
elementWidget
htmlWidget
idWidget
styleWidget

Float & align

xWidget
yWidget

Layout

alignSelfWidget
flexWidget
heightWidget
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
widthWidget

Lifecycle

configBase

Misc

cellInfoWidget
disabledWidget
localeHelperLocalizable
localeManagerLocalizable
readOnlyWidget
refWidget
tabWidget
tooltipWidget

Visibility

hiddenWidget
isVisibleWidget

Widget hierarchy

ownerWidget
parentWidget

Functions

58

Configuration

applyDefaultsstaticBase

Events

Float & align

alignToWidget
setXYWidget
showByWidget
toFrontWidget

Lifecycle

createstaticWidget
destroystaticBase
initClassstaticWidget

Misc

attachTooltipstaticWidget
fromElementstaticWidget
fromSelectorstaticWidget
getByIdstaticWidget
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable

Other

composeWidget
createOnFrameDelayable
disableWidget
enableWidget
focusWidget
LstaticLocalizable
maskWidget
onEvents
recomposeWidget
relayAllEvents
triggerEvents
unEvents
unmaskWidget

Visibility

hideWidget
showWidget

Widget hierarchy

closestWidget
containsWidget
ownsWidget
queryWidget
queryAllWidget
upWidget

Events

14
catchAllEvents
destroyEvents
focusInWidget
focusOutWidget
hideWidget
paintWidget
readOnlyWidget
recomposeWidget
resizeWidget
showWidget

Event handlers

14

Typedefs

6

CSS variables

21
NameDescription
--b-progress-bar-backgroundThe progress bar background

Inherited