API reference for Angular Material progress-bar
import {MatProgressBarModule} from '@angular/material/progress-bar';
Directives
MatProgressBar
Selector: mat-progress-bar
Exported as: matProgressBarProperties
Name | Description |
---|---|
@Input({ transform: numberAttribute })
|
Buffer value of the progress bar. Defaults to zero. |
@Input()
|
Theme color of the progress bar. This API is supported in M2 themes only, it has no effect in M3 themes. For color customization in M3, see https://material.angular.io/components/progress-bar/styling. For information on applying color variants in M3, see https://material.angular.io/guide/material-2-theming#optional-add-backwards-compatibility-styles-for-color-variants |
@Input()
|
Mode of the progress bar. Input must be one of these values: determinate, indeterminate, buffer, query, defaults to 'determinate'. Mirrored to mode attribute. |
@Input({ transform: numberAttribute })
|
Value of the progress bar. Defaults to zero. Mirrored to aria-valuenow. |
@Output()
|
Event emitted when animation of the primary progress bar completes. This event will not be emitted when animations are disabled, nor will it be emitted for modes with continuous animations (indeterminate and query). |
Interfaces
ProgressAnimationEnd
Last animation end data.
Properties
Name | Description |
---|---|
|
MatProgressBarDefaultOptions
Default mat-progress-bar
options that can be overridden.
Properties
Name | Description |
---|---|
|
Default theme color of the progress bar. This API is supported in M2 themes only, it has no effect in M3 themes. For color customization in M3, see https://material.angular.io/components/progress-bar/styling. For information on applying color variants in M3, see https://material.angular.io/guide/material-2-theming#optional-add-backwards-compatibility-styles-for-color-variants |
|
Default mode of the progress bar. |
Type aliases
ProgressBarMode
type ProgressBarMode = 'determinate' | 'indeterminate' | 'buffer' | 'query';
Constants
MAT_PROGRESS_BAR_DEFAULT_OPTIONS
Injection token to be used to override the default options for mat-progress-bar
.
const MAT_PROGRESS_BAR_DEFAULT_OPTIONS: InjectionToken<MatProgressBarDefaultOptions>;
API reference for Angular Material progress-bar-testing
import {MatProgressBarHarness} from '@angular/material/progress-bar/testing';
Classes
MatProgressBarHarness
extends
ComponentHarness
Harness for interacting with a mat-progress-bar
in tests.
Properties
Name | Description |
---|---|
|
Methods
async
getMode
|
|
---|---|
Gets a promise for the progress bar's mode. |
|
Returns | |
Promise<string | null>
|
|
async
getValue
|
|
---|---|
Gets a promise for the progress bar's value. |
|
Returns | |
Promise<number | null>
|
|
async
host
|
|
---|---|
Gets a |
|
Returns | |
Promise<TestElement>
|
|
static
with
|
|
---|---|
Gets a |
|
Parameters | |
options ProgressBarHarnessFilters = {}
|
Options for filtering which progress bar instances are considered a match. |
Returns | |
HarnessPredicate<T>
|
a |
Interfaces
ProgressBarHarnessFilters
A set of criteria that can be used to filter a list of MatProgressBarHarness
instances.