Skip to content

Commit da080b5

Browse files
authored
docs: add reviewOnFail (#2429)
1 parent a804253 commit da080b5

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

doc/check-options.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
- [How Checks Work](#how-checks-work)
66
- [Options](#options)
7+
- [Global Options](#global-options)
78
- [aria-allowed-role](#aria-allowed-role)
89
- [aria-required-children](#aria-required-children)
910
- [aria-roledescription](#aria-roledescription)
@@ -56,6 +57,14 @@ axe.configure({
5657

5758
## Options
5859

60+
### Global Options
61+
62+
All checks allow these global options:
63+
64+
| Option | Default | Description |
65+
| -------------- | :------ | :-------------------------------------------------------------- |
66+
| `reviewOnFail` | `false` | Have the check return as "Needs Review" rather than a violation |
67+
5968
### aria-allowed-role
6069

6170
| Option | Default | Description |
@@ -123,7 +132,7 @@ axe.configure({
123132
'menuitemradio'
124133
]</code></pre>
125134
</td>
126-
<td align="left">List of ARIA roles that support the `aria-roledescription` attribute</td>
135+
<td align="left">List of ARIA roles that support the <code>aria-roledescription</code> attribute</td>
127136
</tr>
128137
</tbody>
129138
</table>

0 commit comments

Comments
 (0)