createProgressbar(
props?):ProgressbarWidget
Create a Progressbar with given config props
• props?: PropsConfig<ProgressbarProps>
a ProgressbarWidget
getProgressbarDefaultConfig():
ProgressbarProps
Retrieve a shallow copy of the default Progressbar config
the default Progressbar config
ProgressbarContext:
WidgetSlotContext<ProgressbarWidget>
ariaDirective:
Directive
A directive to be applied to the main container that handles aria attributes.
animated:
boolean
If true, animates a striped progressbar.
Takes effect only for browsers supporting CSS3 animations, and if striped is true.
false
ariaLabel:
string
The aria label.
'Progressbar'
ariaValueTextFn: (
value,minimum,maximum) =>undefined|string
Return the value for the 'aria-valuetext' attribute.
• value: number
current value
• minimum: number
minimum value
• maximum: number
maximum value
undefined | string
() => undefinedchildren:
SlotContent<ProgressbarContext>
Label of the progress.
className:
string
CSS classes to be applied on the widget main container
''
height:
string
Height of the progressbar, can be any valid css height value.
''
max:
number
The maximum value.
100
min:
number
The minimum value.
0
striped:
boolean
If true, shows a striped progressbar.
false
structure:
SlotContent<ProgressbarContext>
Global template for the Progressbar.
type:
undefined|BSContextualClass
Type of the progressbar, following bootstrap types.
value:
number
The current value.
0
default:
ProgressbarContext
structure:
ProgressbarContext
animated:
boolean
If true, animates a striped progressbar.
Takes effect only for browsers supporting CSS3 animations, and if striped is true.
false
ariaLabel:
string
The aria label.
'Progressbar'
ariaValueText:
undefined|string
The aria value text.
children:
SlotContent<ProgressbarContext>
Label of the progress.
className:
string
CSS classes to be applied on the widget main container
''
finished:
boolean
true if the value has reached its maximum value.
height:
string
Height of the progressbar, can be any valid css height value.
''
max:
number
The maximum value.
100
min:
number
The minimum value.
0
percentage:
number
Percentage of completion.
started:
boolean
true if the value is above its minimum value.
striped:
boolean
If true, shows a striped progressbar.
false
structure:
SlotContent<ProgressbarContext>
Global template for the Progressbar.
type:
undefined|BSContextualClass
Type of the progressbar, following bootstrap types.
value:
number
The current value.
0
ProgressbarWidget:
Widget<ProgressbarProps,ProgressbarState,ProgressbarApi,object,ProgressbarDirectives>