From da080b54d634f660c2018f49263a8c31ac79bf08 Mon Sep 17 00:00:00 2001 From: Steven Lambert <2433219+straker@users.noreply.github.com> Date: Thu, 30 Jul 2020 08:14:26 -0600 Subject: [PATCH] docs: add reviewOnFail (#2429) --- doc/check-options.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/check-options.md b/doc/check-options.md index e2ba566818..3aab027dc5 100644 --- a/doc/check-options.md +++ b/doc/check-options.md @@ -4,6 +4,7 @@ - [How Checks Work](#how-checks-work) - [Options](#options) + - [Global Options](#global-options) - [aria-allowed-role](#aria-allowed-role) - [aria-required-children](#aria-required-children) - [aria-roledescription](#aria-roledescription) @@ -56,6 +57,14 @@ axe.configure({ ## Options +### Global Options + +All checks allow these global options: + +| Option | Default | Description | +| -------------- | :------ | :-------------------------------------------------------------- | +| `reviewOnFail` | `false` | Have the check return as "Needs Review" rather than a violation | + ### aria-allowed-role | Option | Default | Description | @@ -123,7 +132,7 @@ axe.configure({ 'menuitemradio' ] -
aria-roledescription
attribute