You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* chore(markdownlint): Fix MD040 Fenced code blocks should have a language
Removed fence from "Breaking Change since it didn't seem like code
* chore(markdownlint): Fix MD030 Spaces after list markers
* chore(markdownlint): Fix MD012 Multiple consecutive blank lines
* chore(markdownlint): Fix MD007 Unordered list indentation
* chore(markdownlint): Fix MD010 Hard tabs
Modified the EditorConfig file to enforce this in Markdown files too
* chore(markdownlint): Fix MD022 Headers should be surrounded byblank line
Copy file name to clipboardexpand all lines: doc/accessibility-supported.md
-1
Original file line number
Diff line number
Diff line change
@@ -31,4 +31,3 @@ In addition, we disallow invalid attributes starting with `aria-` and invalid at
31
31
We recognize that there are best practices that significantly improve the usability of application, even though they are not strictly required in order to conform with WCAG 2. We develop the best practice rules to help content developers to identify these and adhere to them.
32
32
33
33
We recognize that this topic is somewhat controvertial and the rules we have represent Deque's opinion on what constitutes a best practice.
Run the following commands to apply all commits from that pull request on top of your branch's local history:
126
125
127
-
```
126
+
```console
128
127
curl -L https://github.com/dequelabs/axe-core/pull/205.patch | git am -3
129
128
```
130
129
@@ -137,7 +136,7 @@ Before merging a pull request with many commits into develop, make sure there is
137
136
changes in the pull request, so the git log stays lean. We particularly want to avoid merge messages and vague commits that don't follow our commit policy (like `Merged develop into featurebranch` or `fixed some stuff`).
138
137
139
138
You can use git's interactive rebase to manipulate, merge, and rename commits in your local
140
-
history. If these steps are followed, a force push shouldn't be necessary.
139
+
history. If these steps are followed, a force push shouldn't be necessary.
141
140
142
141
**Do not force push to develop or master under any circulstances.**
2.Grunt must be installed globally. `npm install -g grunt-cli` (You may need to do this as `sudo npm install -g grunt-cli`)
29
-
3.Install npm development dependencies. In the root folder of your axe-core repository, run `npm install`
27
+
1. You must have NodeJS installed.
28
+
2. Grunt must be installed globally. `npm install -g grunt-cli` (You may need to do this as `sudo npm install -g grunt-cli`)
29
+
3. Install npm development dependencies. In the root folder of your axe-core repository, run `npm install`
30
30
31
31
### Building axe.js
32
32
@@ -38,12 +38,11 @@ To run all tests from the command line you can run `grunt test`, which will run
38
38
39
39
You can also load tests in any supported browser, which is helpful for debugging. Tests require a local server to run, you must first start a local server to serve files. You can use Grunt to start one by running `grunt dev`. Once your local server is running you can load the following pages in any browser to run tests:
40
40
41
-
42
-
1.[Core Tests](../test/core/)
43
-
2.[Commons Tests](../test/commons/)
44
-
3.[Check Tests](../test/checks/)
45
-
4.[Integration Tests](../test/integration/rules/)
46
-
5. There are additional tests located in [test/integration/full/](../test/integration/full/) for tests that need to be run against their own document.
41
+
1.[Core Tests](../test/core/)
42
+
2.[Commons Tests](../test/commons/)
43
+
3.[Check Tests](../test/checks/)
44
+
4.[Integration Tests](../test/integration/rules/)
45
+
5. There are additional tests located in [test/integration/full/](../test/integration/full/) for tests that need to be run against their own document.
47
46
48
47
## Architecture Overview
49
48
@@ -53,7 +52,6 @@ Upon execution, a Rule runs each of its Checks against all relevant nodes. Which
53
52
54
53
After execution, a Check will return `true` or `false` depending on whether or not the tested condition was satisfied. The result, as well as more information on what caused the Check to pass or fail, will be stored in either the `passes` array or the `violations` array.
55
54
56
-
57
55
### Rules
58
56
59
57
Rules are defined by JSON files in the [lib/rules directory](../lib/rules). The JSON object is used to seed the [Rule object](../lib/core/base/rule.js#L30). A valid Rule JSON consists of the following:
@@ -66,9 +64,9 @@ Rules are defined by JSON files in the [lib/rules directory](../lib/rules). The
66
64
*`matches` - **optional**`String` Relative path to the JavaScript file of a custom matching function. See [matches function](#matches-function) for more information.
67
65
*`tags` - **optional**`Array` Strings of the accessibility guidelines of which the Rule applies.
68
66
*`metadata` - `Object` Consisting of:
69
-
* `description` - `String` Text string that describes what the rule does.
70
-
* `helpUrl` - `String` **optional** URL that provides more information about the specifics of the violation. Links to a page on the Deque University site.
71
-
* `help` - `String` Help text that describes the test that was performed.
67
+
*`description` - `String` Text string that describes what the rule does.
68
+
*`helpUrl` - `String`**optional** URL that provides more information about the specifics of the violation. Links to a page on the Deque University site.
69
+
*`help` - `String` Help text that describes the test that was performed.
72
70
*`any` - `Array` Checks that make up this Rule; one of these checks must return `true` for a Rule to pass.
73
71
*`all` - `Array` Checks that make up this Rule; all these checks must return `true` for a Rule to pass.
74
72
*`none` - `Array` Checks that make up this Rule; none of these checks must return `true` for a Rule to pass.
@@ -97,11 +95,11 @@ Similar to Rules, Checks are defined by JSON files in the [lib/checks directory]
97
95
*`after` - **optional**`String` Relative path to the JavaScript file which contains the function body of a Check's after (or post-processing) function.f
98
96
*`options` - **optional**`Mixed` Any information the Check needs that you might need to customize and/or is locale specific. Options can be overridden at runtime (with the options parameter) or config-time. For example, the [valid-lang](../lib/checks/language/valid-lang.json) Check defines what ISO 639-1 language codes it should accept as valid. Options do not need to follow any specific format or type; it is up to the author of a Check to determine the most appropriate format.
99
97
*`metadata` - `Object` Consisting of:
100
-
* `impact` - `String` (one of `minor`, `moderate`, `serious`, or `critical`)
101
-
* `messages` - `Object` These messages are displayed when the Check passes or fails
102
-
* `pass` - `String` [doT.js](http://olado.github.io/doT/) template string displayed when the Check passes
103
-
* `fail` - `String` [doT.js](http://olado.github.io/doT/) template string displayed when the Check fails
104
-
* `incomplete` – `String|Object` – [doT.js](http://olado.github.io/doT/) template string displayed when the Check is incomplete OR an object with `missingData` on why it returned incomplete. Refer to [rules.md](./rules.md).
98
+
*`impact` - `String` (one of `minor`, `moderate`, `serious`, or `critical`)
99
+
*`messages` - `Object` These messages are displayed when the Check passes or fails
100
+
*`pass` - `String`[doT.js](http://olado.github.io/doT/) template string displayed when the Check passes
101
+
*`fail` - `String`[doT.js](http://olado.github.io/doT/) template string displayed when the Check fails
102
+
*`incomplete` – `String|Object` – [doT.js](http://olado.github.io/doT/) template string displayed when the Check is incomplete OR an object with `missingData` on why it returned incomplete. Refer to [rules.md](./rules.md).
105
103
106
104
#### Check `evaluate`
107
105
@@ -132,11 +130,11 @@ The after function must return an `Array` of CheckResults, due to this, it is a
132
130
```javascript
133
131
var uniqueIds = [];
134
132
returnresults.filter(function (r) {
135
-
if (uniqueIds.indexOf(r.data) ===-1) {
136
-
uniqueIds.push(r.data);
137
-
returntrue;
138
-
}
139
-
returnfalse;
133
+
if (uniqueIds.indexOf(r.data) ===-1) {
134
+
uniqueIds.push(r.data);
135
+
returntrue;
136
+
}
137
+
returnfalse;
140
138
});
141
139
```
142
140
@@ -245,12 +243,11 @@ The queue function creates an asynchronous "queue", list of functions to be invo
245
243
*`then(callback)` The callback to execute once all "deferred" functions have completed. Will only be invoked once.
246
244
*`abort()` Abort the "queue" and prevent `then` function from firing
247
245
248
-
249
246
#### DqElement Class
250
247
251
248
The DqElement is a "serialized" `HTMLElement`. It will calculate the CSS selector, grab the source outerHTML and offer an array for storing frame paths. The DqElement class takes the following parameters:
252
-
*`Element` - `HTMLElement` The element to serialize
253
-
*`Spec` - `Object` Properties to use in place of the element when instantiated on Elements from other frames
249
+
*`Element` - `HTMLElement` The element to serialize
250
+
*`Spec` - `Object` Properties to use in place of the element when instantiated on Elements from other frames
254
251
255
252
```javascript
256
253
var firstH1 =document.getElementByTagName('h1')[0];
@@ -263,7 +260,6 @@ Elements returned by the DqElement class have the following methods and properti
263
260
*`element` - `DOMNode` The element which this object is based off or the containing frame, used for sorting.
264
261
*`toJSON()` - Returns an object containing the selector and source properties
265
262
266
-
267
263
## Virtual DOM APIs
268
264
269
265
Note: You shouldn’t need the Shadow DOM APIs below unless you’re working on the axe-core
0 commit comments