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
PartialProgressbarProps:
Partial
<ProgressbarProps
>
new ProgressbarComponent():
ProgressbarComponent
readonly
_widget:AngularWidget
<ProgressbarWidget
>
animated:
undefined
|boolean
If true
, animates a striped progressbar.
Takes effect only for browsers supporting CSS3 animations, and if striped
is true
.
false
ariaLabel:
undefined
|string
The aria label.
'Progressbar'
ariaValueTextFn:
undefined
| (value
,minimum
,maximum
) =>undefined
|string
Return the value for the 'aria-valuetext' attribute.
current value
minimum value
maximum value
() => undefined
children:
SlotContent
<ProgressbarContext
>
Label of the progress.
className:
undefined
|string
CSS classes to be applied on the widget main container
''
readonly
defaultSlots:WritableSignal
<Partial
<ProgressbarProps
>,Partial
<ProgressbarProps
>>
height:
undefined
|string
Height of the progressbar, can be any valid css height value.
''
max:
undefined
|number
The maximum value.
100
min:
undefined
|number
The minimum value.
0
slotStructureFromContent:
undefined
|ProgressbarStructureDirective
striped:
undefined
|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:
undefined
|number
The current value.
0
get
api():W
["api"
]
W
["api"
]
get
state():Signal
<WidgetState
<W
>>
Signal
<WidgetState
<W
>>
get
widget():ContextWidget
<W
>
ngAfterContentChecked():
void
A callback method that is invoked immediately after the default change detector has completed checking all of the directive's content.
void
AfterContentChecked.ngAfterContentChecked
ngOnChanges(
changes
):void
• changes: SimpleChanges
void
ngOnInit():
void
void
ProgressbarContext:
WidgetSlotContext
<ProgressbarWidget
>
new ProgressbarDefaultSlotsComponent():
ProgressbarDefaultSlotsComponent
structure:
TemplateRef
<ProgressbarContext
>
const
progressbarDefaultSlotStructure:ComponentTemplate
<unknown
,"structure"
,ProgressbarDefaultSlotsComponent
>
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
() => undefined
children:
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
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
new ProgressbarStructureDirective():
ProgressbarStructureDirective
templateRef:
TemplateRef
<any
>
static
ngTemplateContextGuard(_dir
,context
):context is ProgressbarContext
• _dir: ProgressbarStructureDirective
• context: unknown
context is ProgressbarContext
ProgressbarWidget:
Widget
<ProgressbarProps
,ProgressbarState
,ProgressbarApi
,object
,ProgressbarDirectives
>