@ng-zi/extensions-progress-spinner
v0.0.2
Published
Angular Material Extensions for progress-spinner
Downloads
3
Readme
MtxProgressSpinner Component Overview
The progress spinner component displays a circular indicator of progress and activity.
Usage
Basic Example
<mtx-progress-spinner></mtx-progress-spinner>
Configurable Options
The MtxProgressSpinnerComponent
supports various configuration options to customize its appearance and behavior:
- color: Color of the spinner. Supports any valid CSS color.
- mode: Mode of the spinner. Can be
'determinate'
or'indeterminate'
. - value: Value of the spinner in determinate mode (0-100).
- diameter: Diameter of the spinner in pixels.
- strokeWidth: Width of the spinner's stroke in pixels.
- ariaLabel: Aria label for accessibility.
- strokeWidthRatio: Ratio for dynamic stroke width relative to diameter.
- gapDegree: Degree of the gap in the spinner circle (0-360).
- gapPosition: Position of the gap within the spinner circle (
'start'
or'end'
). - overlay: Whether to overlay the spinner on the entire container.
Example
<mtx-progress-spinner [config]="myConfig"></mtx-progress-spinner>
Where myConfig
is an object of type MtxProgressSpinnerConfig
defined in your application.
Accessibility
Ensure to provide an appropriate ariaLabel
for screen readers to describe the purpose of the spinner.
API Summary
Inputs
config
: Configuration object of typeMtxProgressSpinnerConfig
to customize the spinner.
Styles
Customize the appearance of the spinner using the provided SCSS file (progress-spinner.scss
).