Skip to content

Commit f475fc9

Browse files
authored
docs: add ACCESSIBILITY.md with Vaadin a11y statement to repo root (#12968)
1 parent a11f28f commit f475fc9

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

‎ACCESSIBILITY.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Accessibility
2+
3+
Accessibility is a top priority for Vaadin. We build all user-facing features according to [WCAG 2.1](https://www.w3.org/TR/WCAG21/) level AA criteria, using semantic HTML and [WAI-ARIA](https://www.w3.org/WAI/standards-guidelines/aria/) features and techniques.
4+
5+
Most of existing digital accessibility laws worldwide, such as the European Accessibility Act and Section 508, base their requirements on WCAG level AA. Check out [Vaadin accessibility page](https://vaadin.com/accessibility) for more information on accessibility standards and legislation.
6+
7+
## How we test
8+
9+
- We test new UI features with screen readers during development and before each release.
10+
- The reputable accessibility agency [TetraLogical](https://tetralogical.com) tests Vaadin web components once a year.
11+
- We add known accessibility issues to our backlog and fix them as part of regular maintenance.
12+
13+
## Recommended environments
14+
15+
The following screen reader and browser combinations are used to test Vaadin UI features and are recommended for use with Vaadin-based applications:
16+
17+
- NVDA with Chrome or Firefox on Windows
18+
- JAWS with Chrome or Firefox on Windows
19+
- VoiceOver with Safari on macOS
20+
- VoiceOver with Safari on iOS
21+
22+
## Component conformance
23+
24+
Check out the [accessibility overview table](https://docs.google.com/spreadsheets/d/1VJuzr1H2BWxPAGdtLxTe7yj12_vn0RcTu-UO79WOp8w/edit?usp=sharing) for the WCAG 2.1 level A and AA status of each component included to recent versions of the Vaadin platform. Most issue cells link to the related GitHub issues.
25+
26+
## Reporting issues
27+
28+
Find open accessibility issues with the `a11y` label:
29+
30+
- [Web components](https://github.com/vaadin/web-components/issues?q=is%3Aissue+is%3Aopen+label%3Aa11y)
31+
- [Flow components](https://github.com/vaadin/flow-components/issues?q=is%3Aissue+is%3Aopen+label%3Aa11y)
32+
33+
If you find an accessibility issue, file an [accessibility bug report](https://github.com/vaadin/web-components/issues/new?labels=a11y&template=a11y-test-finding.yml).
34+
35+
## Enterprise
36+
37+
Accessibility review is available as part of [Vaadin Enterprise Edition](https://vaadin.com/enterprise), with a certificate and an Accessibility Conformance Report (VPAT) covering WCAG 2.1 Level AA, Section 508, and EN 301 549.
38+
39+
Enterprise subscribers can use the [bugfix warranty](https://vaadin.com/solutions/support) to prioritize accessibility issues.
40+
41+
## Contributing
42+
43+
Read the [accessibility guidelines](guidelines/a11y.md) before you change a component. They describe roles, labels, focus and keyboard support. See also [CONTRIBUTING.md](CONTRIBUTING.md).
44+
45+
Real screen reader support takes priority over WCAG conformance. A fix must work in all supported environments listed above.
46+
47+
## Learn more
48+
49+
Accessible components alone do not make an application accessible. Developers must use the components in accessible ways. Layouts and styling must also give enough color contrast, keyboard support and screen reader support.
50+
51+
Check out the following posts on the Vaadin blog:
52+
53+
- [Basic Tips for Improving Accessibility](https://vaadin.com/blog/basic-tips-for-improving-accessibility)
54+
- [How We Built an Accessible Dashboard Component](https://vaadin.com/blog/how-we-built-an-accessible-dashboard-component)

0 commit comments

Comments
 (0)