Manual:Extension/StatusBadges: Difference between revisions

No edit summary
No edit summary
Line 16: Line 16:


== Accessibility ==
== Accessibility ==
Make sure to use label text for a status badge that clearly indicates the status. Do not rely on the color alone for conveying the meaning.  For example, negative numbers should have a qualifier (<code>-</code>) instead of just being formatted with a red background, for example.
'''Use of color:''' Make sure to use label text for a status badge that clearly indicates the status. Do not rely on the color alone for conveying the meaning.  For example, negative numbers should have a qualifier (<code>-</code>) instead of just being formatted with a red background, for example. {{WCAGref|use-of-color}}


Don't use status badges for any other purpose than indicating status. Screenreaders will read the badge as  a combination of badge type ("Status"), color (e.g. "green") and label text: "Status: green,  complete".
Don't use status badges for any other purpose than indicating status. Screenreaders will read the badge as  a combination of badge type ("Status"), color (e.g. "green") and label text: "Status: green,  complete".

Revision as of 09:17, 20 July 2026

PDF exclude - start
PDF exclude - end

A status badge is specially formatted text that indicates the status of a piece of information.

Adding a status badge

Status badges are available as a Content Droplet.

To add a status badge:

  1. Place your cursor where you want the status badge to appear.
  2. Open the Content Droplets menuContent Droplet menu item of Visual Editor.
  3. Search for "Status badge."
  4. Insert the Content Droplet.
  5. Add your status message.
  6. Select a color.
  7. Select "light badge" if you want to show a badge with a light background color (optional).

To add another status badge, you can click on the inserted status badge, copy it (Ctrl+c) and paste it somewhere else on the page. Double-click the duplicated badge to change its text and color.

Accessibility

Use of color: Make sure to use label text for a status badge that clearly indicates the status. Do not rely on the color alone for conveying the meaning. For example, negative numbers should have a qualifier (-) instead of just being formatted with a red background, for example. WCAG #use-of-color

Don't use status badges for any other purpose than indicating status. Screenreaders will read the badge as a combination of badge type ("Status"), color (e.g. "green") and label text: "Status: green, complete".



PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end