Skip to content

Commit d277641

Browse files
Marcy Suttonbtford
Marcy Sutton
authored andcommitted
docs(guide/accessibility): Update documentation
1 parent e7cf04b commit d277641

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

docs/content/guide/accessibility.ngdoc

+21-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,26 @@
66

77
# Accessibility with ngAria
88

9-
You can use the `ngAria` module to have certain ARIA attributes automatically applied when you
10-
use certain directives.
9+
You can use the `ngAria` module to have common ARIA attributes automatically applied when you
10+
use certain directives. To enable `ngAria`, just require the module into your application and
11+
the code will hook into your ng-show/ng-hide, input, textarea, button, select and
12+
ng-required directives and add the appropriate ARIA states and properties.
13+
14+
Currently, the following attributes are implemented:
15+
* aria-hidden
16+
* aria-checked
17+
* aria-disabled
18+
* aria-required
19+
* aria-invalid
20+
* aria-multiline
21+
* aria-valuenow
22+
* aria-valuemin
23+
* aria-valuemax
24+
* tabindex
25+
26+
You can disable individual attributes by using the `{@link ngAria.$ariaProvider#config config}` method.
27+
28+
###Example
1129

1230
```js
1331
angular.module('myApp', ['ngAria'])...
@@ -39,3 +57,4 @@ Accessibility best practices that apply to web apps in general also apply to Ang
3957

4058
* [WebAim](http://webaim.org/)
4159
* [Using WAI-ARIA in HTML](http://www.w3.org/TR/2014/WD-aria-in-html-20140626/)
60+
* [Apps For All: Coding Accessible Web Applications](https://shop.smashingmagazine.com/apps-for-all-coding-accessible-web-applications.html)

0 commit comments

Comments
 (0)