Skip to content

Commit decb615

Browse files
authoredJul 7, 2023
fix(autocomplete): fix a11y violations (#5241)
Accessibility violations for autocompletion popover are fixed. role=listbox is moved to $textLayer of ace_autocomplete editor to make its direct children have role=option, otherwise there is aria-required-children violation (https://dequeuniversity.com/rules/axe/4.5/aria-required-children?application=axeAPI) aria-hidden set for textarea of autocomplete popover (there is textarea there since it is an editor instance). aria-posinset now starts from 1.
1 parent 67d318e commit decb615

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed
 

‎src/autocomplete/popup.js

+5-4
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,9 @@ class AcePopup {
5050
popup.renderer.setStyle("ace_autocomplete");
5151

5252
// Set aria attributes for the popup
53-
popup.renderer.container.setAttribute("role", "listbox");
54-
popup.renderer.container.setAttribute("aria-label", nls("Autocomplete suggestions"));
53+
popup.renderer.$textLayer.element.setAttribute("role", "listbox");
54+
popup.renderer.$textLayer.element.setAttribute("aria-label", nls("Autocomplete suggestions"));
55+
popup.renderer.textarea.setAttribute("aria-hidden", "true");
5556

5657
popup.setOption("displayIndentGuides", false);
5758
popup.setOption("dragDelay", 150);
@@ -133,12 +134,12 @@ class AcePopup {
133134
dom.addCssClass(selected, "ace_selected");
134135
var ariaId = getAriaId(row);
135136
selected.id = ariaId;
136-
popup.renderer.container.setAttribute("aria-activedescendant", ariaId);
137+
t.element.setAttribute("aria-activedescendant", ariaId);
137138
el.setAttribute("aria-activedescendant", ariaId);
138139
selected.setAttribute("role", "option");
139140
selected.setAttribute("aria-label", popup.getData(row).value);
140141
selected.setAttribute("aria-setsize", popup.data.length);
141-
selected.setAttribute("aria-posinset", row);
142+
selected.setAttribute("aria-posinset", row+1);
142143
selected.setAttribute("aria-describedby", "doc-tooltip");
143144
}
144145
});

‎src/autocomplete_test.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ module.exports = {
4848
assert.ok(!editor.container.querySelector("style"));
4949

5050
sendKey("a");
51-
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="2" aria-posinset="0" aria-describedby="doc-tooltip"><s "ace_completion-highlight">a</s><s "ace_">rraysort</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d><d "ace_line"><s "ace_completion-highlight">a</s><s "ace_">looooooooooooooooooooooooooooong_word</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
51+
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="2" aria-posinset="1" aria-describedby="doc-tooltip"><s "ace_completion-highlight">a</s><s "ace_">rraysort</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d><d "ace_line"><s "ace_completion-highlight">a</s><s "ace_">looooooooooooooooooooooooooooong_word</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
5252
sendKey("rr");
53-
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="1" aria-posinset="0" aria-describedby="doc-tooltip"><s "ace_completion-highlight">arr</s><s "ace_">aysort</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
53+
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="1" aria-posinset="1" aria-describedby="doc-tooltip"><s "ace_completion-highlight">arr</s><s "ace_">aysort</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
5454
sendKey("r");
55-
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="1" aria-posinset="0" aria-describedby="doc-tooltip"><s "ace_completion-highlight">arr</s><s "ace_">ayso</s><s "ace_completion-highlight">r</s><s "ace_">t</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
55+
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="arraysort" aria-setsize="1" aria-posinset="1" aria-describedby="doc-tooltip"><s "ace_completion-highlight">arr</s><s "ace_">ayso</s><s "ace_completion-highlight">r</s><s "ace_">t</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
5656

5757
sendKey("Return");
5858
assert.equal(editor.getValue(), "arraysort\narraysort alooooooooooooooooooooooooooooong_word");
5959
editor.execCommand("insertstring", " looooooooooooooooooooooooooooong_");
60-
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="alooooooooooooooooooooooooooooong_word" aria-setsize="1" aria-posinset="0" aria-describedby="doc-tooltip"><s "ace_">a</s><s "ace_completion-highlight">looooooooooooooooooooooooooooong_</s><s "ace_">word</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
60+
checkInnerHTML('<d "ace_line ace_selected" id="suggest-aria-id:0" role="option" aria-label="alooooooooooooooooooooooooooooong_word" aria-setsize="1" aria-posinset="1" aria-describedby="doc-tooltip"><s "ace_">a</s><s "ace_completion-highlight">looooooooooooooooooooooooooooong_</s><s "ace_">word</s><s "ace_completion-spacer"> </s><s "ace_completion-meta">local</s></d>', function() {
6161
sendKey("Return");
6262
editor.destroy();
6363
editor.container.remove();

0 commit comments

Comments
 (0)
Please sign in to comment.