Skip to content

Commit

Permalink
Docs: Add accessbility specific page (#13169)
Browse files Browse the repository at this point in the history
* Docs: Add accessbility specific page

Adds an additional page to the developer handbook on accessibility
in particular the landmark regions.

Fixes #3217

* Add navigationRegions link
  • Loading branch information
mkaz authored and youknowriad committed Mar 6, 2019
1 parent 27e1134 commit 2600e05
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/designers-developers/developers/accessibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Accessibility

Accessibility documentation for developers working on the Gutenberg Project.

For more information on accessibility and WordPress see the [Make WordPress Accessibility Handbook](https://make.wordpress.org/accessibility/handbook/) and the [Accessibility Team section](https://make.wordpress.org/accessibility/).

## Landmark Regions

It is a best practice to include ALL content on the page in landmarks, so that screen reader users who rely on them to navigate from section to section do not lose track of content.

For setting up navigation between different regions, see the [navigateRegions package](/packages/components/src/higher-order/navigate-regions/README.md) for additional documentation.

Read more regarding landmark design from W3C:

- [General Principles of Landmark Design](https://www.w3.org/TR/wai-aria-practices-1.1/#general-principles-of-landmark-design)
- [ARIA Landmarks Example](https://www.w3.org/TR/wai-aria-practices/examples/landmarks/)
- [HTML5 elements that by default define ARIA landmarks](https://www.w3.org/TR/wai-aria-practices/examples/landmarks/HTML5.html)
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/designers-developers/developers/internationalization.md",
"parent": "developers"
},
{
"title": "Accessibility",
"slug": "accessibility",
"markdown_source": "https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/designers-developers/developers/accessibility.md",
"parent": "developers"
},
{
"title": "Data Module Reference",
"slug": "data",
Expand Down
1 change: 1 addition & 0 deletions docs/toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
{"docs/designers-developers/developers/filters/autocomplete-filters.md": []}
]},
{"docs/designers-developers/developers/internationalization.md": []},
{"docs/designers-developers/developers/accessibility.md": []},
{"docs/designers-developers/developers/data/README.md": "{{data}}"},
{"docs/designers-developers/developers/packages.md": "{{packages}}"},
{"packages/components/README.md": "{{components}}"},
Expand Down

0 comments on commit 2600e05

Please sign in to comment.