Skip to content

Commit

Permalink
docs(API): add reviewOnFail (#2539)
Browse files Browse the repository at this point in the history
  • Loading branch information
straker authored Oct 6, 2020
1 parent 828864b commit ea89c82
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ axe.configure({
- each rule object can contain the following attributes
- `id` - string(required). This uniquely identifies the rule. If the rule already exists, it will be overridden with any of the attributes supplied. The attributes below that are marked required, are only required for new rules.
- `impact` - string(optional). Override the impact defined by checks
- `reviewOnFail` - boolean(option, default `false`). Override the result of a rule to return "Needs Review" rather than "Violation" if the rule fails.
- `selector` - string(optional, default `*`). A [CSS selector](./developer-guide.md#supported-css-selectors) used to identify the elements that are passed into the rule for evaluation.
- `excludeHidden` - boolean(optional, default `true`). This indicates whether elements that are hidden from all users are to be passed into the rule for evaluation.
- `enabled` - boolean(optional, default `true`). Whether the rule is turned on. This is a common attribute for overriding.
Expand Down

0 comments on commit ea89c82

Please sign in to comment.