Progress bar¶
Progress bars notify users that an app needs more time to process a user action, and if possible tell how much time (approximately) it will take.
Usage¶
Progress bars inform users about the status of ongoing processes, such as loading an app, documents or data, submitting a form, saving data and more.
When to use¶
Use a progress bar for any action that takes longer than about one second. Anything shorter than that will act distracting to users.
Best practices¶
- An application should provide visual feedback for any extended waiting/loading period.
- Progress bars shall be used for non-blocking waiting/loading actions.
Design¶
A Progress bar consists of the following elements:
- Label (optional), 2. Progress, 3. Track, 4. Value (optional)
Besides the default size, there is also a small variant available.
- Default, 2. Small
Code¶
Usage¶
import { SiProgressbarComponent } from '@siemens/element-ng/progressbar';
@Component({
imports: [SiProgressbarComponent, ...]
})
SiProgressbarComponent API Documentation¶
selector
si-progressbar
Input Properties¶
Name | Type | Default | Description |
---|---|---|---|
ariaLabel ¶ | TranslatableString | $localize`:@@SI_PROGRESSBAR.LABEL:Progress` | Needed for a11y |
heading ¶ | string | Heading to display on top of progress bar. | |
height ¶ | ProgressbarHeight | 'normal' | Height for progress bar. |
max ¶ | number | 100 | Max value for progressbar |
progress ¶ | string | Optional progress text to be shown on top right (in LTR). It can be percentage value or a progress status. E.g 50 % or Downloading 2/8 . | |
value ¶ | (undefined | number ) | 0 | Current value |
Types Documentation¶
Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality. |
---|
Translatable import imported from @siemens/element-translate-ng |
---|
Except where otherwise noted, content on this site is licensed under MIT License.