fix: add noHtml to axe.configure (dequelabs#2789)

* fix: add noHtml to axe.configure * docs * Update lib/core/utils/dq-element.js Co-authored-by: Wilco Fiers <[email protected]> * Update lib/core/utils/dq-element.js Co-authored-by: Stephen Mathieson <[email protected]> * tests Co-authored-by: Wilco Fiers <[email protected]> Co-authored-by: Stephen Mathieson <[email protected]>
annieshinn · Feb 8, 2021 · 6e23eb0 · 6e23eb0
1 parent 7da2c51
commit 6e23eb0
Show file tree

Hide file tree

Showing 9 changed files with 3,158 additions and 2,935 deletions.
diff --git a/doc/API.md b/doc/API.md
@@ -179,17 +179,18 @@ User specifies the format of the JSON structure passed to the callback of `axe.r
 
 ```js
 axe.configure({
-	branding: {
-		brand: String,
-		application: String
-	},
-	reporter: 'option' | Function,
-	checks: [Object],
-	rules: [Object],
-	standards: Object,
-	locale: Object,
-	axeVersion: String,
-	disableOtherRules: Boolean
+  branding: {
+    brand: String,
+    application: String
+  },
+  reporter: 'option' | Function,
+  checks: [Object],
+  rules: [Object],
+  standards: Object,
+  locale: Object,
+  axeVersion: String,
+  disableOtherRules: Boolean,
+  noHtml: Boolean
 });
 ```
 
@@ -232,6 +233,7 @@ axe.configure({
   - `disableOtherRules` - Disables all rules not included in the `rules` property.
   - `locale` - A locale object to apply (at runtime) to all rules and checks, in the same shape as `/locales/*.json`.
   - `axeVersion` - Set the compatible version of a custom rule with the current axe version. Compatible versions are all patch and minor updates that are the same as, or newer than those of the `axeVersion` property.
+  - `noHtml` - Disables the HTML output of nodes from rules.
 
 **Returns:** Nothing