API reference for Angular Material progress-spinner
import {MatProgressSpinnerModule} from '@angular/material/progress-spinner';
Directives
MatProgressSpinner
Selector: mat-progress-spinner mat-spinner
Exported as: matProgressSpinnerProperties
Name | Description |
---|---|
@Input()
|
Theme color of the progress spinner. This API is supported in M2 themes only, it has no effect in M3 themes. For information on applying color variants in M3, see https://material.angular.io/guide/theming#using-component-color-variants. |
@Input({ transform: numberAttribute })
|
The diameter of the progress spinner (will set width and height of svg). |
@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 })
|
Stroke width of the progress spinner. |
@Input({ transform: numberAttribute })
|
Value of the progress bar. Defaults to zero. Mirrored to aria-valuenow. |
Interfaces
MatProgressSpinnerDefaultOptions
Default mat-progress-spinner
options that can be overridden.
Properties
Name | Description |
---|---|
|
Default theme color of the progress spinner. This API is supported in M2 themes only, it has no effect in M3 themes. For information on applying color variants in M3, see https://material.angular.io/guide/theming#using-component-color-variants. |
|
Diameter of the spinner. |
|
Width of the spinner's stroke. |
Type aliases
ProgressSpinnerMode
Possible mode for a progress spinner.
type ProgressSpinnerMode = 'determinate' | 'indeterminate';
Constants
MAT_PROGRESS_SPINNER_DEFAULT_OPTIONS
Injection token to be used to override the default options for mat-progress-spinner
.
const MAT_PROGRESS_SPINNER_DEFAULT_OPTIONS: InjectionToken<MatProgressSpinnerDefaultOptions>;
MatSpinner
const MatSpinner: typeof MatProgressSpinner;
API reference for Angular Material progress-spinner-testing
import {MatProgressSpinnerHarness} from '@angular/material/progress-spinner/testing';
Classes
MatProgressSpinnerHarness
extends
ComponentHarness
Harness for interacting with a MDC based mat-progress-spinner in tests.
Properties
Name | Description |
---|---|
|
The selector for the host element of a |
Methods
async
getMode
|
|
---|---|
Gets the progress spinner's mode. |
|
Returns | |
Promise<ProgressSpinnerMode>
|
|
async
getValue
|
|
---|---|
Gets the progress spinner's value. |
|
Returns | |
Promise<number | null>
|
|
async
host
|
|
---|---|
Gets a |
|
Returns | |
Promise<TestElement>
|
|
static
with
|
|
---|---|
Gets a |
|
Parameters | |
options ProgressSpinnerHarnessFilters = {}
|
Options for filtering which progress spinner instances are considered a match. |
Returns | |
HarnessPredicate<T>
|
a |
Interfaces
ProgressSpinnerHarnessFilters
A set of criteria that can be used to filter a list of MatProgressSpinnerHarness
instances.