Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
accessibility.md 3.65 KB
Newer Older
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
1 
---
Mark Otto's avatar
Massive cleanup    
Mark Otto committed
2 
layout: docs
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
3 
title: Accessibility
Mark Otto's avatar
restore page headers, use partial and page frontmatter to organize it    
Mark Otto committed
4 
group: getting-started
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
5
6
7
8 
---

Bootstrap follows common web standards and—with minimal extra effort—can be used to create sites that are accessible to those using <abbr title="Assistive Technology" class="initialism">AT</abbr>.
Mark Otto's avatar
rewrite some button group docs    
Mark Otto committed
9
10
11
12
13
14
15
16
17
18
19
20
21
22 
## Component requirements

Some common HTML elements are always in need for basic accessibility enhancements through `role`s and Aria attributes. Below is a list of some of the most frequently used ones.

{% callout info %}
**Heads up!** As we go through the alphas, we'll be moving more accessibility notes here with links to specific sections from other areas of the docs.
{% endcallout %}

### Button groups

In order for assistive technologies–such as screen readers–to convey that a series of buttons is grouped, an appropriate `role` attribute needs to be provided. For button groups, this would be `role="group"`, while toolbars should have a `role="toolbar"`.

In addition, groups and toolbars should be given an explicit label, as most assistive technologies will otherwise not announce them, despite the presence of the correct `role` attribute. In the examples provided here, we use `aria-label`, but alternatives such as `aria-labelledby` can also be used.
Mark Otto's avatar
Merge branch 'master' into v4    
Mark Otto committed
23 
## Skip navigation
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
24
Curt Grimes's avatar
Fix links to A11Y Project posts    
Curt Grimes committed
25 
If your navigation contains many links and comes before the main content in the DOM, add a `Skip to main content` link before the navigation (for a simple explanation, see this [A11Y Project article on skip navigation links](http://a11yproject.com/posts/skip-nav-links)). Using the `.sr-only` class will visually hide the skip link, and the <code>.sr-only-focusable</code> class will ensure that the link becomes visible once focused (for sighted keyboard users).
Mark Otto's avatar
Merge branch 'master' into v4    
Mark Otto committed
26
Mark Otto's avatar
Redo all our callouts with the custom callout plugin    
Mark Otto committed
27 
{% callout danger %}
Chris Rebert's avatar
Refer to open successor Chrome bug in Accessibility docs    
Chris Rebert committed
28 
Due to long-standing shortcomings/bugs in Chrome (see [issue 454172 in the Chromium bug tracker](https://code.google.com/p/chromium/issues/detail?id=454172 "Chromium bug tracker - Issue 454172: Focus Link Target (sequential focus navigation starting point)")) and Internet Explorer (see this article on [in-page links and focus order](http://accessibleculture.org/articles/2010/05/in-page-links/)), you will need to make sure that the target of your skip link is at least programmatically focusable by adding `tabindex="-1"`.
Mark Otto's avatar
Redo all our callouts with the custom callout plugin    
Mark Otto committed
29
30
31
32
33 

In addition, you may want to explicitly suppress a visible focus indication on the target (particularly as Chrome currently also sets focus on elements with `tabindex="-1"` when they are clicked with the mouse) with `#content:focus { outline: none; }`.

Note that this bug will also affect any other in-page links your site may be using, rendering them useless for keyboard users. You may consider adding a similar stop-gap fix to all other named anchors / fragment identifiers that act as link targets.
{% endcallout %}
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
34
35
36
37 

{% highlight html %}
<body>
  <a href="#content" class="sr-only sr-only-focusable">Skip to main content</a>
Mark Otto's avatar
Merge branch 'master' into v4    
Mark Otto committed
38
39
40 
  ...
  <div class="container" id="content" tabindex="-1">
    <!-- The main page content -->
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
41
42
43
44 
  </div>
</body>
{% endhighlight %}
Mark Otto's avatar
Merge branch 'master' into v4    
Mark Otto committed
45 
## Nested headings
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
46
47
48
49
50 

When nesting headings (`<h1>` - `<h6>`), your primary document header should be an `<h1>`. Subsequent headings should make logical use of `<h2>` - `<h6>` such that screen readers can construct a table of contents for your pages.

Learn more at [HTML CodeSniffer](http://squizlabs.github.io/HTML_CodeSniffer/Standards/Section508/) and [Penn State's Accessability](http://accessibility.psu.edu/headings).
Mark Otto's avatar
Merge branch 'master' into v4    
Mark Otto committed
51 
## Additional resources
Mark Otto's avatar
Move accessibility to markdown  
Mark Otto committed
52
53
54
55 

- ["HTML Codesniffer" bookmarklet for identifying accessibility issues](https://github.com/squizlabs/HTML_CodeSniffer)
- [The A11Y Project](http://a11yproject.com/)
- [MDN accessibility documentation](https://developer.mozilla.org/en-US/docs/Accessibility)