Skip to content

Improve avatar status accessibility and update CSS hash #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coliff merged 2 commits into from
Jan 16, 2026
Merged

Improve avatar status accessibility and update CSS hash #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b2c5e1
Improve avatar status accessibility and update CSS hash
coliff Jan 16, 2026
3172de3
Update README.md
coliff Jan 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ Our default branch (main) is for development of our Modus Bootstrap v2 release.

## Copyright and license

Code and documentation copyright 2011-2025 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors). Code released under the [MIT License](https://github.com/twbs/bootstrap/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
Code and documentation copyright 2011-2026 the [Bootstrap Authors](https://github.com/twbs/bootstrap/graphs/contributors). Code released under the [MIT License](https://github.com/twbs/bootstrap/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).

Modus Bootstrap code and documentation copyright 2025 Trimble Inc. Code released under the [MIT License](https://github.com/trimble-oss/modus-bootstrap/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
Modus Bootstrap code and documentation copyright 2026 Trimble Inc. Code released under the [MIT License](https://github.com/trimble-oss/modus-bootstrap/blob/main/LICENSE). Docs released under [Creative Commons](https://creativecommons.org/licenses/by/3.0/).
2 changes: 1 addition & 1 deletion hugo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ params:
cdn:
# See https://www.srihash.org for info on how to generate the hashes
css: "https://cdn.jsdelivr.net/npm/@trimble-oss/modus-bootstrap@2.3.1/dist/css/modus-bootstrap.min.css"
css_hash: "sha256-g+9n+sOv8JCIyfpi7F42H4ehNVO0W2Hpo/vyS5N7tlc="
css_hash: "sha256-vCEqbLyQ6pBh2NC9EkW/6NUAU6FbvuoHMMAqEWEld9o="
js: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.min.js"
js_hash: "sha384-G/EV+4j2dNv+tEPo3++6LCgdCROaejBqfUeNjuKAiuXbjrxilcCdDz6ZAVfHWe1Y"
js_bundle: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js"
Expand Down
18 changes: 9 additions & 9 deletions site/content/docs/v2/components/avatar.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,19 +70,19 @@ Add a `.avatar-status` element inside the avatar to show a status indicator. Eac
{{< example >}}
<span class="avatar">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
</span>
<span class="avatar">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-offline"></span>
<span class="avatar-status status-offline" role="status" aria-label="Offline"></span>
</span>
<span class="avatar">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-busy"></span>
<span class="avatar-status status-busy" role="status" aria-label="Busy"></span>
</span>
<span class="avatar">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-away"></span>
<span class="avatar-status status-away" role="status" aria-label="Away"></span>
Comment on lines +73 to +85

Copilot AI Jan 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of role="status" for avatar status indicators is semantically incorrect. The ARIA status role is intended for live regions that provide advisory information that changes dynamically (e.g., "5 results found" or "Saving..."). Avatar status indicators are static visual decorations that don't change content dynamically in the DOM.

For these purely decorative status indicators, consider one of these approaches:

  1. Use role="img" with aria-label if the status is important enough to be announced
  2. Use aria-hidden="true" if the status is conveyed through other means (e.g., the avatar is in a list that textually indicates status)
  3. If status needs to be announced, ensure the parent avatar element has appropriate accessible text that includes the status

The role="status" with its implicit aria-live="polite" will cause screen readers to announce these every time they encounter them, which may not be the intended behavior for static status indicators.

Copilot uses AI. Check for mistakes.
</span>
{{< /example >}}

Expand All @@ -93,23 +93,23 @@ The status indicator scales with the avatar size.
{{< example >}}
<span class="avatar avatar-xs">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
</span>
<span class="avatar avatar-sm">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
</span>
<span class="avatar">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
</span>
<span class="avatar avatar-lg">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
</span>
<span class="avatar avatar-xl">
<img class="avatar-img" src="https://github.com/coliff.png" alt="CO">
<span class="avatar-status status-online"></span>
<span class="avatar-status status-online" role="status" aria-label="Online"></span>
Comment on lines +96 to +112

Copilot AI Jan 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of role="status" for avatar status indicators is semantically incorrect. The ARIA status role is intended for live regions that provide advisory information that changes dynamically (e.g., "5 results found" or "Saving..."). Avatar status indicators are static visual decorations that don't change content dynamically in the DOM.

For these purely decorative status indicators, consider one of these approaches:

  1. Use role="img" with aria-label if the status is important enough to be announced
  2. Use aria-hidden="true" if the status is conveyed through other means (e.g., the avatar is in a list that textually indicates status)
  3. If status needs to be announced, ensure the parent avatar element has appropriate accessible text that includes the status

The role="status" with its implicit aria-live="polite" will cause screen readers to announce these every time they encounter them, which may not be the intended behavior for static status indicators.

Copilot uses AI. Check for mistakes.
</span>
{{< /example >}}

Expand Down