This repository has been archived by the owner on Apr 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(step_15): create new step about accessibility
- Loading branch information
1 parent
7551b89
commit 8a62975
Showing
3 changed files
with
330 additions
and
3 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
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,327 @@ | ||
@ngdoc tutorial | ||
@name 15 - Accessibility | ||
@step 15 | ||
@description | ||
|
||
<ul doc-tutorial-nav="15"></ul> | ||
|
||
In this step, we will learn how to fix the accessibility issues in our application. | ||
|
||
* We will use the {@link ngAria ngAria} module to enable WAI-ARIA. | ||
* We will fix some issues in the templates. | ||
* We will use the [protractor-accessibility-plugin](protractor-a11y-plugin) to review the accessibility of our application when we run our e2e tests. | ||
|
||
<div doc-tutorial-reset="15"></div> | ||
|
||
## Why accessibility matters | ||
|
||
* [Creating an accessible web - Access iQ](https://www.youtube.com/watch?v=47n0wEcm6JU) | ||
* [Web Accessibility](https://www.youtube.com/watch?v=bEM9Fn9aOG8) | ||
* [Google Accessibility course](https://webaccessibility.withgoogle.com/course) | ||
* [Accessibility in AngularJS and Beyond](http://marcysutton.com/slides/fluent2015/) | ||
* [Apps For All: Coding Accessible Web Applications](https://shop.smashingmagazine.com/products/apps-for-all) | ||
|
||
## Main accessibility issues in the application | ||
|
||
If you make a review of the accessibility of the application you will find some issues: | ||
|
||
* Lack of information about the current results when the user interacts with the filters. | ||
* Lack of labels elements in the search and order filters in the Phone list. | ||
* Lack of headers elements to help the user to navigate throw the content of the page. | ||
* In the Phone detail, the user can't access via keyboard over the thumbnails images. | ||
|
||
In the next sections we are going to show you, how to fix some of these issues to make the application accessible. | ||
|
||
To help us, we will use the {@link ngAria ngAria} module, and we will install the [protractor-a11y-plugin] plugin too. | ||
|
||
## Dependencies | ||
|
||
The `ngAria` module, is distributed separately from the core Angular framework. | ||
|
||
Since we are using [Bower][bower] to install client-side dependencies, this step updates the | ||
`bower.json` configuration file to include the new dependencies: | ||
|
||
<br /> | ||
**`bower.json`:** | ||
|
||
``` | ||
{ | ||
"name": "angular-phonecat", | ||
"description": "A starter project for AngularJS", | ||
"version": "0.0.0", | ||
"homepage": "https://github.com/angular/angular-phonecat", | ||
"license": "MIT", | ||
"private": true, | ||
"dependencies": { | ||
"angular": "1.5.x", | ||
"angular-animate": "1.5.x", | ||
"angular-aria": "1.5.x", | ||
"angular-mocks": "1.5.x", | ||
"angular-resource": "1.5.x", | ||
"angular-route": "1.5.x", | ||
"bootstrap": "3.3.x", | ||
"jquery": "2.2.x" | ||
} | ||
} | ||
``` | ||
|
||
* `"angular-aria": "1.5.x"` tells bower to install a version of the angular-aria module that | ||
is compatible with version 1.5.x of Angular. | ||
|
||
To install the [protractor-a11y-plugin], we can add the plugin into the `devDependencies` section in the `package.json` file, | ||
|
||
<br /> | ||
**`package.json`:** | ||
|
||
``` | ||
{ | ||
"devDependencies": { | ||
"bower": "^1.7.7", | ||
"http-server": "^0.9.0", | ||
"jasmine-core": "^2.4.1", | ||
"karma": "^0.13.22", | ||
"karma-chrome-launcher": "^0.2.3", | ||
"karma-firefox-launcher": "^0.1.7", | ||
"karma-jasmine": "^0.3.8", | ||
"protractor": "^3.2.2", | ||
"protractor-accessibility-plugin": "^0.1.1", | ||
"shelljs": "^0.6.0" | ||
} | ||
} | ||
``` | ||
|
||
Now, we must tell bower to download and install these dependencies. | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
<div class="alert alert-info"> | ||
**Note:** If you have bower installed globally, you can run `bower install`, but for this project | ||
we have preconfigured `npm install` to run bower for us. | ||
</div> | ||
|
||
<div class="alert alert-warning"> | ||
**Warning:** If a new version of Angular has been released since you last ran `npm install`, then | ||
you may have a problem with the `bower install` due to a conflict between the versions of | ||
angular.js that need to be installed. If you run into this issue, simply delete your | ||
`app/bower_components` directory and then run `npm install`. | ||
</div> | ||
|
||
|
||
## How to use the `ngAria` module | ||
|
||
The `ngAria` module provides support for common ARIA attributes that convey state or semantic information about the application for users of assistive technologies, such as screen readers. | ||
|
||
### Template | ||
|
||
In order to enable the module, we need to update `index.html`, loading the necessary dependencies | ||
(**angular-aria.js**) that contain JavaScript code. | ||
|
||
The WAI-ARIA module, {@link ngAria ngAria}, contains the code necessary to help you to add WAI-ARIA attributes in your application. | ||
|
||
<br /> | ||
**`app/index.html`:** | ||
|
||
```html | ||
... | ||
<!-- Adds WAI-ARIA module in AngularJS --> | ||
<script src="bower_components/angular-aria/angular-aria.js"></script> | ||
... | ||
``` | ||
|
||
### Dependencies | ||
|
||
We need to add a dependency on `ngAria` to our main module first: | ||
|
||
<br /> | ||
**`app/app.module.js`:** | ||
|
||
```js | ||
angular. | ||
module('phonecatApp', [ | ||
... | ||
'ngAria', | ||
... | ||
]); | ||
``` | ||
|
||
## How to inform the user that _something_ is happening | ||
|
||
Today, is very common to find applications or webpages where the user make some interaction with an element and obtains and inmediate reply to the action. | ||
|
||
The problem is that in most of the cases this action is only reported in a way that you need to see it in your screen but if a user is navigating with a screenreader like [JAWS](http://www.freedomscientific.com/Products/Blindness/JAWS), [NVDA](http://www.nvaccess.org/) or [ChromeVox](http://www.chromevox.com/), this information never won't be accessible. | ||
|
||
When the user is searching or filtering mobiles in the application, the list updates automatically. It is mandatory that user knows, in some way, the result after the search or order action. | ||
|
||
To fix this, we add two directives to inform the user how many items are know in the list after search or order them. This directive will fill an element in our page to tell the user how many elements are after the action. | ||
|
||
<br /> | ||
**`app/phone-list/phone-list-template.html`:** | ||
|
||
```html | ||
<div> | ||
<label for="search">Search:</label> | ||
<input id="search" ng-model="$ctrl.query" ng-model-options="{ debounce: 900 }"> | ||
</div> | ||
|
||
<div class="aria-status" aria-live="assertive" aria-atomic="true"></div> | ||
|
||
... | ||
|
||
<div class="aria-status-sort" aria-live="assertive" aria-atomic="true"></div> | ||
|
||
``` | ||
|
||
The new element is a _region live_. It means that every time this region is updated, it will inform the user about its content. | ||
|
||
In order to update the information correctly, it is neccesary to add a _`debounce`_ option to the model. | ||
|
||
Please note that now the inputs are associated with theirs labels using `label` elements. | ||
|
||
The directives are based on an idea of [Marcy Sutton](http://marcysutton.com/slides/fluent2015/) about how to add accessibility in the AngularJS applications. | ||
|
||
|
||
### How to use the directives | ||
|
||
<br /> | ||
**`app/phone-list/phone-list-template.html`:** | ||
|
||
```html | ||
|
||
... | ||
|
||
<div> | ||
<label for="order">Sort by:</label> | ||
<select inform-order id="order" ng-model="$ctrl.orderProp"> | ||
<option value="name">Alphabetical</option> | ||
<option value="age">Newest</option> | ||
</select> | ||
</div> | ||
|
||
... | ||
|
||
<ul result-list class="phones"> | ||
<li ng-repeat="phone in filtered = ($ctrl.phones | filter:$ctrl.query | orderBy:$ctrl.orderProp)" | ||
class="thumbnail phone-list-item"> | ||
<a href="#!/phones/{{phone.id}}" class="thumb"> | ||
<img ng-src="{{phone.imageUrl}}" alt="{{phone.name}}" /> | ||
</a> | ||
<a href="#!/phones/{{phone.id}}">{{phone.name}}</a> | ||
<p>{{phone.snippet}}</p> | ||
</li> | ||
</ul> | ||
|
||
``` | ||
|
||
<br /> | ||
**`app/index.html`:** | ||
|
||
```html | ||
... | ||
<script src="phone-list/phone-list.directive.js"></script> | ||
... | ||
``` | ||
|
||
|
||
<br /> | ||
**`app/phone-list/phone-list.directive.js`:** | ||
|
||
```js | ||
|
||
'use strict'; | ||
|
||
/* Directives */ | ||
|
||
angular. | ||
module('phoneList'). | ||
directive('resultList', [function () { | ||
var ariaStatus = document.querySelector('.aria-status'); | ||
return { | ||
restrict: 'A', | ||
link: function ($scope) { | ||
$scope.$watch('filtered.length', function (length) { | ||
if(length === 1) { | ||
ariaStatus.innerHTML = length + ' item found'; | ||
} else if(length > 1) { | ||
ariaStatus.innerHTML = length + ' items found'; | ||
} else { | ||
ariaStatus.innerHTML = 'No items found'; | ||
} | ||
}); | ||
} | ||
} | ||
} | ||
]). | ||
directive('informOrder', [function () { | ||
var ariaStatusSort = document.querySelector('.aria-status-sort'); | ||
return { | ||
restrict: 'A', | ||
link: function ($scope) { | ||
$scope.$watch('$ctrl.orderProp', function (order) { | ||
if(order === 'age') { | ||
ariaStatusSort.innerHTML = 'Items filter by newest' | ||
} else { | ||
ariaStatusSort.innerHTML = 'Items filter by alphabetical order' | ||
} | ||
|
||
}); | ||
} | ||
} | ||
} | ||
]); | ||
|
||
``` | ||
|
||
## Using the keyboard | ||
|
||
The current detail of a phone prevents a user to use a keyboard to navigate for over each thumbnail image. It is very important due to accessibility that all the actions and information are available via keyboard too. For example, lightboxes, carousels, slides, etc. | ||
|
||
_Tip_: Try to navigate over the application using only the _TAB_ key. You will discover that some actions can't be accessed nor the focus on some elements. | ||
|
||
<br /> | ||
**`app/phone-detail/phone-detail.template.html`:** | ||
|
||
```html | ||
... | ||
<ul class="phone-thumbs"> | ||
<li ng-repeat="img in $ctrl.phone.images"> | ||
<button type="button" aria-label="view enlarge version of the image" ng-click="$ctrl.setImage(img)"><img ng-src="{{img}}" alt="" /></button> | ||
</li> | ||
</ul> | ||
... | ||
``` | ||
|
||
## How to run the e2e tests using the Protractor accessibility plugin | ||
|
||
Once the plugin is installed, we have to modify the `protractor.conf.js` file to inform Protractor to use this plugin too. | ||
|
||
<br /> | ||
**`protractor.conf.js`:** | ||
|
||
``` | ||
plugins: [{ | ||
chromeA11YDevTools: { | ||
treatWarningsAsFailures: true | ||
}, | ||
package: 'protractor-accessibility-plugin' | ||
}] | ||
``` | ||
|
||
After that, every time we run the e2e tests, Protractor will review the accessibility of your application using the [Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools). | ||
|
||
|
||
|
||
# Summary | ||
|
||
Our application is now accessible, thanks to these small changes. | ||
|
||
There you have it! We have created a web application in a relatively short amount of time. In the | ||
{@link the_end closing notes} we will cover where to go from here. | ||
|
||
|
||
<ul doc-tutorial-nav="15"></ul> | ||
|
||
|
||
[bower]: http://bower.io/ | ||
[protractor-a11y-plugin]: https://github.com/angular/protractor-accessibility-plugin |