-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: Add Accessibility page (#2844)
* Add Accessibility page Fixes: #2704 * Update super-linter.yml
- Loading branch information
Showing
3 changed files
with
58 additions
and
15 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
46 changes: 46 additions & 0 deletions
46
stencil-workspace/storybook/stories/introduction/accessibility.stories.mdx
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
import { Meta } from '@storybook/addon-docs'; | ||
|
||
<Meta | ||
title="Introduction/Accessibility" | ||
parameters={{ | ||
previewTabs: { | ||
canvas: { | ||
hidden: true, | ||
}, | ||
}, | ||
options: { | ||
isToolshown: false, | ||
}, | ||
viewMode: 'docs', | ||
}} | ||
/> | ||
|
||
# Accessibility | ||
|
||
The Modus Web Components package is designed to be accessible by default. This means that the components are built with accessibility in mind and are tested to ensure they meet the [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/WAI/standards-guidelines/wcag/). | ||
|
||
Features: | ||
|
||
- Meet [minimum contrast requirements (Level AA)](https://www.w3.org/WAI/WCAG21/Understanding/contrast-minimum.html). | ||
- Keyboard navigable where applicable. | ||
- Screen reader accessible. | ||
- Optimized and tested to work with [Windows High Contrast themes](https://blogs.windows.com/msedgedev/2020/09/17/styling-for-windows-high-contrast-with-new-standards-for-forced-colors/). | ||
- Supports the [prefers-reduced-motion media query](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-reduced-motion) to minimize the amount of non-essential motion. | ||
|
||
Found an accessibility issue? Please [report it at GitHub](https://github.com/trimble-oss/modus-web-components/issues/new?assignees=&labels=accessibility&template=accessibility-issue-report.md&title=). | ||
|
||
## For contributors | ||
|
||
The Storybook site has an Accessibility tab that can be used to test the components for accessibility issues. If you are contributing to the Modus Web Components package please ensure that your changes do not introduce accessibility issues. If there are any violations please address them before submitting your changes. If you are unsure, please reach out to the team for guidance. | ||
|
||
## Useful tools for testing your sites | ||
|
||
### Browser extensions | ||
|
||
- [axe DevTools](https://chromewebstore.google.com/detail/axe-devtools-web-accessib/lhdoppojpmngadmnindnejefpokejbdd) | ||
- [Lighthouse](https://chromewebstore.google.com/detail/lighthouse/blipmdconlkpinefehnmjammfjpmpbjk) | ||
- [Microsoft Accessibility Insights](https://accessibilityinsights.io/downloads/) | ||
|
||
## Further Reading | ||
|
||
You can find more information on accessibility on the [Modus website](https://modus.trimble.com/foundations/accessibility). |