Skip to content

Docs Updates - #229

Merged
coliff merged 1 commit into
mainfrom
dev/coliff/docs-update
Jan 8, 2026
Merged

Docs Updates#229
coliff merged 1 commit into
mainfrom
dev/coliff/docs-update

Conversation

@coliff

@coliff coliff commented Jan 8, 2026

Copy link
Copy Markdown
Contributor

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:

  • Updated all modal and close button examples in documentation to use a visually hidden <span> with the label "Close" instead of relying solely on the aria-label attribute. 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:

  • Added guidance for making .list-group-item-action elements appear disabled and accessible by adding .disabled and aria-disabled="true". (site/content/docs/v2/components/list-group.md)
  • Updated Popper.js documentation links to point to the latest v2 docs and clarified keyboard interaction language. (site/content/docs/v2/components/dropdowns.md)
  • Adjusted dropdown button example to use btn-secondary for visual consistency. (site/content/docs/v2/components/dropdowns.md)

Visual and dependency updates:

  • Updated the search icon in the navbar to use a newer version of the Modus icon set. (site/assets/scss/_navbar-search.scss)
  • Downgraded the eslint-config-xo dev dependency from 0.49.0 to 0.45.0. (package.json)

Minor content and formatting tweaks:

  • Fixed minor typographical and formatting issues, such as using typographic apostrophes and self-closing image tags. (site/content/docs/v2/components/modal.md, site/content/docs/v2/components/chips.md) [1] [2] [3]

Copilot AI review requested due to automatic review settings January 8, 2026 12:45
@coliff
coliff merged commit 9760cfd into main Jan 8, 2026
19 checks passed
@coliff
coliff deleted the dev/coliff/docs-update branch January 8, 2026 12:47

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants