createProgressbar

function

createProgressbar(props?): ProgressbarWidget

Create a Progressbar with given config props

Parameters

props?: PropsConfig<ProgressbarProps>

Returns

ProgressbarWidget

a ProgressbarWidget


getProgressbarDefaultConfig

function

getProgressbarDefaultConfig(): ProgressbarProps

Retrieve a shallow copy of the default Progressbar config

Returns

ProgressbarProps

the default Progressbar config


PartialProgressbarProps

type alias

PartialProgressbarProps: Partial<ProgressbarProps>


ProgressbarApi

interface

ProgressbarComponent

class
Implements
Constructors
new ProgressbarComponent

new ProgressbarComponent(): ProgressbarComponent

Returns

ProgressbarComponent

Properties
_widget

readonly _widget: AngularWidget<ProgressbarWidget>


animated

animated: undefined | boolean

If true, animates a striped progressbar. Takes effect only for browsers supporting CSS3 animations, and if striped is true.

Default Value

false


ariaLabel

ariaLabel: undefined | string

The aria label.

Default Value

'Progressbar'


ariaValueTextFn

ariaValueTextFn: undefined | (value, minimum, maximum) => undefined | string

Return the value for the 'aria-valuetext' attribute.

Param

current value

Param

minimum value

Param

maximum value

Default Value
() => undefined

children

children: SlotContent<ProgressbarContext>

Label of the progress.


className

className: undefined | string

CSS classes to be applied on the widget main container

Default Value

''


defaultSlots

readonly defaultSlots: WritableSignal<Partial<ProgressbarProps>, Partial<ProgressbarProps>>


height

height: undefined | string

Height of the progressbar, can be any valid css height value.

Default Value

''


max

max: undefined | number

The maximum value.

Default Value

100


min

min: undefined | number

The minimum value.

Default Value

0


slotStructureFromContent

slotStructureFromContent: undefined | ProgressbarStructureDirective


striped

striped: undefined | boolean

If true, shows a striped progressbar.

Default Value

false


structure

structure: SlotContent<ProgressbarContext>

Global template for the Progressbar.


type

type: undefined | BSContextualClass

Type of the progressbar, following bootstrap types.


value

value: undefined | number

The current value.

Default Value

0

Accessors
api

get api(): W["api"]

Returns

W["api"]


state

get state(): Signal<WidgetState<W>>

Returns

Signal<WidgetState<W>>


widget

get widget(): ContextWidget<W>

Returns

ContextWidget<W>

Methods
ngAfterContentChecked

ngAfterContentChecked(): void

A callback method that is invoked immediately after the default change detector has completed checking all of the directive's content.

Returns

void

Implementation of

AfterContentChecked.ngAfterContentChecked


ngOnChanges

ngOnChanges(changes): void

Parameters

changes: SimpleChanges

Returns

void

Inherit Doc

ngOnInit

ngOnInit(): void

Returns

void

Inherit Doc

ProgressbarContext

type alias

ProgressbarContext: WidgetSlotContext<ProgressbarWidget>


ProgressbarDefaultSlotsComponent

class
Constructors
new ProgressbarDefaultSlotsComponent

new ProgressbarDefaultSlotsComponent(): ProgressbarDefaultSlotsComponent

Returns

ProgressbarDefaultSlotsComponent

Properties
structure

structure: TemplateRef<ProgressbarContext>


progressbarDefaultSlotStructure

constant

const progressbarDefaultSlotStructure: ComponentTemplate<unknown, "structure", ProgressbarDefaultSlotsComponent>


ProgressbarDirectives

interface
Properties
ariaDirective

ariaDirective: Directive

A directive to be applied to the main container that handles aria attributes.


ProgressbarProps

interface
Properties
animated

animated: boolean

If true, animates a striped progressbar. Takes effect only for browsers supporting CSS3 animations, and if striped is true.

Default Value

false


ariaLabel

ariaLabel: string

The aria label.

Default Value

'Progressbar'


ariaValueTextFn

ariaValueTextFn: (value, minimum, maximum) => undefined | string

Return the value for the 'aria-valuetext' attribute.

Parameters

value: number

current value

minimum: number

minimum value

maximum: number

maximum value

Returns

undefined | string

Default Value
() => undefined

children

children: SlotContent<ProgressbarContext>

Label of the progress.


className

className: string

CSS classes to be applied on the widget main container

Default Value

''


height

height: string

Height of the progressbar, can be any valid css height value.

Default Value

''


max

max: number

The maximum value.

Default Value

100


min

min: number

The minimum value.

Default Value

0


striped

striped: boolean

If true, shows a striped progressbar.

Default Value

false


structure

structure: SlotContent<ProgressbarContext>

Global template for the Progressbar.


type

type: undefined | BSContextualClass

Type of the progressbar, following bootstrap types.


value

value: number

The current value.

Default Value

0


ProgressbarState

interface
Properties
animated

animated: boolean

If true, animates a striped progressbar. Takes effect only for browsers supporting CSS3 animations, and if striped is true.

Default Value

false


ariaLabel

ariaLabel: string

The aria label.

Default Value

'Progressbar'


ariaValueText

ariaValueText: undefined | string

The aria value text.


children

children: SlotContent<ProgressbarContext>

Label of the progress.


className

className: string

CSS classes to be applied on the widget main container

Default Value

''


finished

finished: boolean

true if the value has reached its maximum value.


height

height: string

Height of the progressbar, can be any valid css height value.

Default Value

''


max

max: number

The maximum value.

Default Value

100


min

min: number

The minimum value.

Default Value

0


percentage

percentage: number

Percentage of completion.


started

started: boolean

true if the value is above its minimum value.


striped

striped: boolean

If true, shows a striped progressbar.

Default Value

false


structure

structure: SlotContent<ProgressbarContext>

Global template for the Progressbar.


type

type: undefined | BSContextualClass

Type of the progressbar, following bootstrap types.


value

value: number

The current value.

Default Value

0


ProgressbarStructureDirective

class
Constructors
new ProgressbarStructureDirective

new ProgressbarStructureDirective(): ProgressbarStructureDirective

Returns

ProgressbarStructureDirective

Properties
templateRef

templateRef: TemplateRef<any>

Methods
ngTemplateContextGuard

static ngTemplateContextGuard(_dir, context): context is ProgressbarContext

Parameters

_dir: ProgressbarStructureDirective

context: unknown

Returns

context is ProgressbarContext


ProgressbarWidget

type alias

ProgressbarWidget: Widget<ProgressbarProps, ProgressbarState, ProgressbarApi, object, ProgressbarDirectives>