createProgressbar(
config?):ProgressbarWidget
Create an ProgressbarWidget with given config props
• config?: PropsConfig<ProgressbarProps>
an optional progress bar config
an ProgressbarWidget
getProgressbarDefaultConfig():
ProgressbarProps
Retrieve a shallow copy of the default Progressbar config
the default Progressbar config
ariaDirective:
Directive
A directive to be applied to the main container that handles aria attributes.
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
() => undefinedclassName:
string
CSS classes to be applied on the widget main container
''
max:
number
The maximum value.
100
min:
number
The minimum value.
0
value:
number
The current value.
0
ariaLabel:
string
The aria label.
'Progressbar'
ariaValueText:
undefined|string
The aria value text.
className:
string
CSS classes to be applied on the widget main container
''
finished:
boolean
true if the value has reached its maximum 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.
value:
number
The current value.
0
ProgressbarWidget:
Widget<ProgressbarProps,ProgressbarState,ProgressbarApi,object,ProgressbarDirectives>