Back to Status Indicator-guidelines

CSS ComponentThe latest version of this package is: 17.0.30-alpha.0, Opens in new window

Status indicators usually communicate to user where they are (or system is) in the process flow.

This component provides .css, .styl, .less and .scss -files.

To be able to install this component, please refer to the Project Setup documentation.

View repository, Opens in new windowView package, Opens in new window
$ npm i @ids-core/status-indicator@17.0.30-alpha.0
Status indicator
Preview

Table of Contents

Edit this section, Opens in new window

Usage

Status indicator without screen reader support to dynamic updates

<span class="if status-indicator active"><span class="if text meta">Active</span></span>

Status indicator with screen reader support to dynamic updates and hidden description text

<!-- or any other container element having `role="status" attribute` -->
<div class="if container" role="status">
    <span class="if status-indicator success"><span class="if axe sr-only">Success</span></span>
</div>
Edit this section, Opens in new window

Accessibility

Label

If the description text is omitted from inside of status indicator, aria-label (or aria-labelledby) must be provided to describe the current state of status indicator, which will be read out by screen reader.

<span class="if status-indicator paused" aria-label="currently paused"></span>

Or:

<span class="if text" id="id-to-label-current-status">Currently paused</span>
...
<span class="if status-indicator paused" aria-labelledby="id-to-label-current-status"></span>

Role

If the status indicator is subject to change dynamically, it is worth adding `role="status"` to status indicator container element to let the screen reader know when a change has happened.

When

<div class="if container" role="status">
    <span class="if text heading">Claim status</span>
    <span class="if status-indicator active"><span class="if text meta">Processing</span></span>
</div>

Becomes

<div class="if container" role="status">
    <span class="if text heading">Claim status</span>
    <span class="if status-indicator success"><span class="if text meta">Processed</span></span>
</div>

Screen reader will politely announce the new claim status.

NB

Please note that if the description text is omitted there must be some other textual change, apart from status indicator `class` and `aria-label` changes, in case of dynamic update for screen reader to pick it up. Screen reader will be able to read status state only when manually navigating to it: 
<div class="if container" role="status">
    <span class="if text heading">Claim status</span>
    <span class="if status-indicator paused" aria-label="currently paused"></span>
</div>

Will yield Claim status currently paused, but no dynamic updates will be announced.

Therefore, it is advisable to keep the textual content of status indicator within role="status".

Add .if .axe .sr-only classes to the textual element, which will hide it from the viewport but will keep it available for screen readers.

<div class="if container" role="status">
    <span class="if text heading">Claim status</span>
    <span class="if status-indicator success"><span class="if axe sr-only">Processed</span></span>
</div>

For more info on role="status" refer to w3 and MDN.

Edit this section, Opens in new window

Changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

14.22.2 (2022-05-03)

Miscellaneous chores

  • package locks: update package locks (813eac7)

14.20.1 (2022-04-19)

Miscellaneous chores

  • changelog: regenerate all CHANGELOG.md files (64ab385) , closes #586342
  • changelog: regenerate all changelogs after updating changelog generation (70789c9) , closes #587270

14.18.3 (2022-04-13)

Bug Fixes

  • changelog: generate new CHANGELOG.md files for root and packages (349fda4) , closes #586063 . We regenerate the files to include all relevant commits and to use conventional-commits at 100%

14.16.0 (2022-04-07)

Bug Fixes

  • 🐛 Add missing imports for global CSS Variables (fbf6f06) , closes #582437

14.9.0 (2022-03-03)

Miscellaneous chores

14.8.1 (2022-02-23)

Bug Fixes

  • 🐛 Add missing imports of typography CSS variables (e716c65) , closes #559412

reinstall (d425056)

bootstrap (9a713df)

merge (2b1c5f1)

reinstall (5221600)

reinstall (147df55)

  • use correct versions (f1b5deb)

  • Add engines for all packages (e95dfff)

reinstall (afce1f2)

reinstall (67f3140)

  • Add changelog.md to files (3338314)

Reinstall (a2abf51)

14.2.2 (2021-12-10)

Code Refactoring

reinstall (885c74b)

  • fix changelogs manually (b1232b4)

reinstall (545a069)

reinstall (e149c2c)

13.12.3 (2021-11-09)

⚠ BREAKING CHANGES

  • 🧨 The scope for If Design System npm packages has now changed from @if-design-system to @ids-core. We have also renamed the repository from if-design-system to ids-core
  • 🧨 Util is now renamed to Utils
  • 🧨 We have now changed the navigation structure for the documentation site. Please update any saved links!
  • 🧨 Navigation structure has now changed. Please see release notes!

Documentation Updates

  • ✏️ Move position of the quick links (5cb0897)

  • ✏️ Remove unneeded margins for shortcuts (36c7e8d)

  • ✏️ Separate out CSS documentation (dd255a8) , closes #467386

  • ✏️ Update links and change navigation structure (0bfd27d) , closes #490579

Code Refactoring

  • 💡 Categorize components (9965266) , closes #490579

  • 💡 Reduce spacing tokens, use correct size tokens (97aa461)

  • 💡 Rename scope and repository (3ea5423)

  • 💡 Use new navigation structure for documentation (415aee5) , closes #490579

  • another change in the structure (38a0d2e)

Miscellaneous chores

bootstrap (6fc1ed8)

  • fix all old references to util (d57bf17)

  • prepare for merge (0184490)

reinstall (da80dba)

  • Rename scope and repo (257684e)

  • use correct version for utils (49e72d9)

13.11.0 (2021-10-19)

Features

  • 🎸 Input field hot reload (eac76b7)

13.9.2 (2021-09-30)

Bug Fixes

  • 🐛 Complete the pseudo-element fix (1dcee2c)

13.7.0 (2021-09-22)

Documentation Updates

  • ✏️ Update linking layout and naming (15c383b)

13.6.3 (2021-09-17)

Bug Fixes

13.6.0 (2021-09-08)

Documentation Updates

  • Use default shortcut listing for demo links (a746602)

  • 🤖 Use node v14 (4009973)

bootstrap (d23e139)

  • 🤖 Use correct order for diff (cc6a4fd)

12.14.1 (2021-08-12)

Miscellaneous chores

  • 🤖 Add ci task to package.json without tests (21222e0) , closes #457627

12.13.1 (2021-08-11)

Bug Fixes

  • 🐛 Whitelist docs dir for npm packaging (1a5cfd0) , closes #457621

12.12.1 (2021-08-10)

Bug Fixes

  • 🐛 Make sure components using fonts, have fonts bundled (d5bb642) , closes #354912

  • 🤖 Remove .gitignore, use npm package.json files instead, ignore zip files for npm pack (49f0269) , closes #412081 . This will whitelist files to be used in "npm pack"

  • 🤖 Reinstall (e660696)

  • 🤖 Update published date (61e7ccf)

12.6.0 (2021-05-27)

Bug Fixes

  • 🐛 Manually set firstPublished and lastModified (e83af7d)

  • 🐛 We don't need lastModified (e458a12)

12.0.0 (2021-05-05)

⚠ BREAKING CHANGES

  • 🧨 All of the mixins have now been renamed
  • 🧨 Teasers are no more. It has been replaces with Lifestyle Navigational Card, Text Navigational Card. Studio Teasers is gone, use Studio Navigational Card instead, which is based on the old Studio Crosslinks
  • 🧨 This extracts the Hero variation with no image into a separate, design updated component named Header
  • 🧨 Footer is now renamed to Global Footer

Features

  • 🎸 Rename and extract and update hero with no image to (384eb77) , closes #336508 . Header component

Bug Fixes

Code Refactoring

Miscellaneous chores

  • 🤖 Convert util tokens from theo to style-dictionary (99fb4f5)

  • 🤖 Finalize breakpoint token conversion (f50ea0d)

  • 🤖 Reinstall (2c763ea)

  • 🤖 Reinstall (69e1a5b)

  • 🤖 Update all design token references (c640d15)

  • 🤖 Update references to util variables (b79ec36)

  • 🤖 Updating links (70f166e)

rebuild (7edb430)

10.2.2 (2021-03-10)

Documentation Updates

  • ✏️ Fix broken demo links (470b377)

  • 🤖 Rename Change Log to Changelog (d412e63)

  • 🤖 Remove all references to sketch (35fc554) , closes #339203

  • 🤖 Update package fields (200c0af)

  • reinstall packages (fcfacf4)

  • 🤖 Update versions (e7781db)

7.5.0 (2020-11-23)

Features

Documentation Updates

  • ✏️ Update documentation (7a42241)

  • 🤖 Refactor circle into a pseudo component (42fc8f7) . Also added example html

  • 🤖 Update demo and dev files with new markup (8feeb53)

  • 🤖 Update versions of status-indicator (eab22a3)

bootstrap (bbbb57e)

Edit this section, Opens in new window
Contact us, Opens in new window