Skip to content

Commit 277332b

Browse files
author
Farzad Hayatbakhsh
committed
DOC-2592: Add contentID property to API section
1 parent a4800a3 commit 277332b

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

modules/ROOT/pages/a11ychecker.adoc

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -399,18 +399,20 @@ console.log(issues);
399399
// example result
400400
[
401401
{
402+
"contentID": "<div id=\"accessibility-issue__contentID\"><span>Text:&nbsp;</span><span>\"H5\"</span></div>",
403+
"description": "Headings must be applied in sequential order. For example: Heading 1 should be followed by Heading 2, not Heading 3.",
404+
"element": [object], // The element value contains the DOM element (such as <h4>).
402405
"id": "D2",
403406
"severity": "error",
404-
"url": "http://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html",
405-
"description": "Headings must be applied in sequential order. For example: Heading 1 should be followed by Heading 2, not Heading 3.",
406-
"element": {} // The element value contains the DOM element (such as <h4>).
407+
"url": "https://www.w3.org/WAI/WCAG21/Techniques/general/G141.html",
407408
},
408409
{
410+
"contentID": "<div id=\"accessibility-issue__contentID\"><span>Table:&nbsp;</span><span>\"2x2\"</span></div>",
411+
"description": "Tables must have captions",
412+
"element": [object], // The element value contains the DOM element (such as <table>).
409413
"id": "T1",
410414
"severity": "error",
411-
"url": "http://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html",
412-
"description": "Tables must have captions",
413-
"element": {} // The element value contains the DOM element (such as <table>).
415+
"url": "https://www.w3.org/WAI/WCAG21/Techniques/html/H39.html",
414416
}
415417
]
416418
----
@@ -431,3 +433,5 @@ The `+'issue'+` object provides relevant data pertaining to any issue generated
431433
* `+url+` : `+String+` URL reference for the issue. By default, this will be a link to the W3 website, containing the W3 WCAG technique that needs to be addressed to clear the issue.
432434

433435
* `+element+` : `+Object+` DOM element where the issue was found.
436+
437+
* `+contentID+` : `+String+` A short snippet of the content (such as text, image, or table) where the issue was found.

0 commit comments

Comments
 (0)