Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(aria-required-children): allow group and rowgroup roles #2661

Merged
merged 3 commits into from
Nov 30, 2020
Merged

fix(aria-required-children): allow group and rowgroup roles #2661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2d381f2
fix(aria-required-children): allow group and rowgroup roles
straker Nov 24, 2020
0703f7d
fix
straker Nov 25, 2020
976159e
Merge branch 'develop' into required-children-group
straker Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions lib/checks/aria/aria-required-children-evaluate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,22 @@ import { hasContentVirtual, idrefs } from '../../commons/dom';
/**
* Get all owned roles of an element
*/
function getOwnedRoles(virtualNode) {
function getOwnedRoles(virtualNode, required) {
const ownedRoles = [];
const ownedElements = getOwnedVirtual(virtualNode);
for (let i = 0; i < ownedElements.length; i++) {
let ownedElement = ownedElements[i];
let role = getRole(ownedElement);
let role = getRole(ownedElement, { noPresentational: true });

// if owned node has no role or is presentational we keep
// parsing the descendant tree. this means intermediate roles
// between a required parent and child will fail the check
if (['presentation', 'none', null].includes(role)) {
// if owned node has no role or is presentational, or if role
// allows group or rowgroup, we keep parsing the descendant tree.
// this means intermediate roles between a required parent and
// child will fail the check
if (
!role ||
(['group', 'rowgroup'].includes(role) &&
required.some(requiredRole => requiredRole === role))
) {
ownedElements.push(...ownedElement.children);
} else if (role) {
ownedRoles.push(role);
Expand Down Expand Up @@ -99,11 +104,11 @@ function ariaRequiredChildrenEvaluate(node, options, virtualNode) {
options && Array.isArray(options.reviewEmpty) ? options.reviewEmpty : [];
const role = getExplicitRole(virtualNode, { dpub: true });
const required = requiredOwned(role);
if (!required) {
if (required === null) {
return true;
}

const ownedRoles = getOwnedRoles(virtualNode);
const ownedRoles = getOwnedRoles(virtualNode, required);
straker marked this conversation as resolved.
Show resolved Hide resolved
const missing = missingRequiredChildren(
virtualNode,
role,
Expand Down
8 changes: 4 additions & 4 deletions lib/standards/aria-roles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ const ariaRoles = {
},
list: {
type: 'structure',
requiredOwned: ['listitem'],
requiredOwned: ['group', 'listitem'],
allowedAttrs: ['aria-expanded'],
superclassRole: ['section']
},
Expand Down Expand Up @@ -322,7 +322,7 @@ const ariaRoles = {
},
menu: {
type: 'composite',
requiredOwned: ['menuitemradio', 'menuitem', 'menuitemcheckbox'],
requiredOwned: ['group', 'menuitemradio', 'menuitem', 'menuitemcheckbox'],
allowedAttrs: [
'aria-activedescendant',
'aria-expanded',
Expand All @@ -332,7 +332,7 @@ const ariaRoles = {
},
menubar: {
type: 'composite',
requiredOwned: ['menuitemradio', 'menuitem', 'menuitemcheckbox'],
requiredOwned: ['group', 'menuitemradio', 'menuitem', 'menuitemcheckbox'],
allowedAttrs: [
'aria-activedescendant',
'aria-expanded',
Expand Down Expand Up @@ -744,7 +744,7 @@ const ariaRoles = {
},
tree: {
type: 'composite',
requiredOwned: ['treeitem'],
requiredOwned: ['group', 'treeitem'],
allowedAttrs: [
'aria-multiselectable',
'aria-required',
Expand Down
74 changes: 70 additions & 4 deletions test/checks/aria/required-children.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ describe('aria-required-children', function() {
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
assert.deepEqual(checkContext._data, ['listitem']);
assert.deepEqual(checkContext._data, ['group', 'listitem']);
});

(shadowSupported ? it : xit)(
Expand All @@ -43,7 +43,7 @@ describe('aria-required-children', function() {
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
assert.deepEqual(checkContext._data, ['listitem']);
assert.deepEqual(checkContext._data, ['group', 'listitem']);
}
);

Expand Down Expand Up @@ -309,7 +309,7 @@ describe('aria-required-children', function() {
.apply(checkContext, params)
);

assert.deepEqual(checkContext._data, ['listitem']);
assert.deepEqual(checkContext._data, ['group', 'listitem']);
});

it('should fail when list has intermediate child with role that is not a required role', function() {
Expand All @@ -322,7 +322,7 @@ describe('aria-required-children', function() {
.apply(checkContext, params)
);

assert.deepEqual(checkContext._data, ['listitem']);
assert.deepEqual(checkContext._data, ['group', 'listitem']);
});

it('should fail when nested child with role row does not have required child role cell', function() {
Expand Down Expand Up @@ -492,6 +492,72 @@ describe('aria-required-children', function() {
);
});

it('should pass when role allows group and group has required child', function() {
var params = checkSetup(
'<div role="menu" id="target"><ul role="group"><li role="menuitem">Menuitem</li></ul></div>'
);
assert.isTrue(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

it('should fail when role allows group and group does not have required child', function() {
var params = checkSetup(
'<div role="menu" id="target"><ul role="group"><li>Menuitem</li></ul></div>'
);
assert.isFalse(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

it('should fail when role does not allow group', function() {
var params = checkSetup(
'<div role="listbox" id="target"><ul role="group"><li role="option">Option</li></ul></div>'
);
assert.isFalse(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

it('should pass when role allows rowgroup and rowgroup has required child', function() {
var params = checkSetup(
'<div role="table" id="target"><ul role="rowgroup"><li role="row">Row</li></ul></div>'
);
assert.isTrue(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

it('should fail when role allows rowgroup and rowgroup does not have required child', function() {
var params = checkSetup(
'<div role="table" id="target"><ul role="rowgroup"><li>Row</li></ul></div>'
);
assert.isFalse(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

it('should fail when role does not allow rowgroup', function() {
var params = checkSetup(
'<div role="listbox" id="target"><ul role="rowgroup"><li role="option">Option</li></ul></div>'
);
assert.isFalse(
axe.testUtils
.getCheckEvaluate('aria-required-children')
.apply(checkContext, params)
);
});

describe('options', function() {
it('should return undefined instead of false when the role is in options.reviewEmpty', function() {
var params = checkSetup('<div role="grid" id="target"></div>', {
Expand Down
9 changes: 9 additions & 0 deletions test/integration/rules/aria-required-children/aria-required-children.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,12 @@
</div>
</div>
</div>

<div role="menu" id="pass17">
<ul role="group" id="pass18">
>
<li role="menuitem" id="pass19">>Inbox</li>
<li role="menuitem" id="pass20">>Archive</li>
<li role="menuitem" id="pass21">>Trash</li>
</ul>
</div>
7 changes: 6 additions & 1 deletion test/integration/rules/aria-required-children/aria-required-children.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,12 @@
["#pass13"],
["#pass14"],
["#pass15"],
["#pass16"]
["#pass16"],
["#pass17"],
["#pass18"],
["#pass19"],
["#pass20"],
["#pass21"]
],
"incomplete": [
["#incomplete1"],
Expand Down