lion/docs/components/progress-indicator/overview.md
Hardik Pithva a616fd8dca
feat(progress-indicator): add support for progress bar (#1713)
Co-authored-by: gerjanvangeest <gerjanvangeest@users.noreply.github.com>
2022-08-11 08:55:25 +02:00

36 lines
959 B
Markdown

# Progress Indicator >> Overview ||10
A web component that implements accessibility requirements for progress indicators.
```js script
import { html } from '@mdjs/mdjs-preview';
import '@lion/progress-indicator/define';
```
```html
<lion-progress-indicator aria-label="Interest rate" value="50"></lion-progress-indicator>
```
## Features
This component is designed to be extended in order to add visuals.
- Can be indeterminate or determinate, depending on whether it has a value.
- Accessibility compliant
- Localized "Loading" label in case of an indeterminate progress-indicator
- Implementation independent of visuals
- `value`: progress value, setting this makes the progress-indicator determinate.
- `min`: progress min value
- `max`: progress max value
## Installation
```bash
npm i --save @lion/progress-indicator
```
```js
import { LionProgressIndicator } from '@lion/progress-indicator';
// or
import '@lion/progress-indicator/define';
```