Docs Updates - #229
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation and dependencies with a focus on accessibility improvements. The changes standardize close button implementation across components by replacing aria-label="Close" with visually-hidden span elements, update external documentation links, and resolve ESLint configuration compatibility issues.
- Standardized accessibility pattern for close buttons across modal and close-button components
- Added documentation for properly disabling actionable list group items
- Updated icon library version and external documentation references
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| site/content/docs/v2/components/modal.md | Replaced aria-label with visually-hidden spans for close buttons across 18 modal examples to improve accessibility |
| site/content/docs/v2/components/list-group.md | Added documentation explaining how to disable actionable list items with proper accessibility attributes |
| site/content/docs/v2/components/dropdowns.md | Updated Popper documentation link to v2 docs, standardized keyboard key naming (ESC → Esc), and changed button variant in link example |
| site/content/docs/v2/components/close-button.md | Updated close button examples to use visually-hidden spans instead of aria-label for screen reader support |
| site/content/docs/v2/components/chips.md | Standardized self-closing tag format for img element alt attribute |
| site/assets/scss/_navbar-search.scss | Updated modus-icons CDN version from 1.3.1 to 1.7.1 |
| package.json | Downgraded eslint-config-xo from 0.49.0 to 0.45.0 for compatibility with ESLint 8.57.1 |
| package-lock.json | Updated dependency tree to reflect eslint-config-xo downgrade and removed peer dependency markers |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request focuses on accessibility improvements, documentation updates, and minor dependency adjustments. The most significant changes enhance accessibility for close buttons in modals, clarify documentation for several components, and update some visual and dependency aspects.
Accessibility improvements:
<span>with the label "Close" instead of relying solely on thearia-labelattribute. This ensures better accessibility for screen readers. (site/content/docs/v2/components/close-button.md,site/content/docs/v2/components/modal.md) [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18]Documentation updates:
.list-group-item-actionelements appear disabled and accessible by adding.disabledandaria-disabled="true". (site/content/docs/v2/components/list-group.md)site/content/docs/v2/components/dropdowns.md)btn-secondaryfor visual consistency. (site/content/docs/v2/components/dropdowns.md)Visual and dependency updates:
site/assets/scss/_navbar-search.scss)eslint-config-xodev dependency from0.49.0to0.45.0. (package.json)Minor content and formatting tweaks:
site/content/docs/v2/components/modal.md,site/content/docs/v2/components/chips.md) [1] [2] [3]