Skip to content

fix(landmark-complementary-is-top-level): allow aside inside main #2740

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

Merged
merged 3 commits into from
Jan 11, 2021
Merged

fix(landmark-complementary-is-top-level): allow aside inside main #2740

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
f0e3f9a
fix(landmark-complementary-is-top-level): allow aside inside main
straker Jan 7, 2021
341cb4c
fix
straker Jan 7, 2021
555d160
use getRole
straker Jan 8, 2021
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
15 changes: 10 additions & 5 deletions lib/checks/keyboard/landmark-is-top-level-evaluate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
import { implicitRole } from '../../commons/aria';
import { getRole, implicitRole } from '../../commons/aria';
import { getAriaRolesByType } from '../../commons/standards';
import { getComposedParent } from '../../commons/dom';

function landmarkIsTopLevelEvaluate(node) {
var landmarks = getAriaRolesByType('landmark');
var parent = getComposedParent(node);
var nodeRole = getRole(node);

this.data({
role: node.getAttribute('role') || implicitRole(node)
});
this.data({ role: nodeRole });

while (parent) {
var role = parent.getAttribute('role');
if (!role && parent.nodeName.toUpperCase() !== 'FORM') {
role = implicitRole(parent);
}
if (role && landmarks.includes(role)) {
// allow aside inside main
// @see https://github.com/dequelabs/axe-core/issues/2651
if (
role &&
landmarks.includes(role) &&
!(role === 'main' && nodeRole === 'complementary')
) {
return false;
}
parent = getComposedParent(parent);
Expand Down
11 changes: 10 additions & 1 deletion test/checks/keyboard/landmark-is-top-level.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,22 @@ describe('landmark-is-top-level', function() {

it('should return false if the complementary landmark is in another landmark', function() {
var params = checkSetup(
'<main><div role="complementary" id="target"></div></main>'
'<nav><div role="complementary" id="target"></div></nav>'
);
axe.utils.getFlattenedTree(document.documentElement);
assert.isFalse(check.evaluate.apply(checkContext, params));
assert.deepEqual(checkContext._data, { role: 'complementary' });
});

it('should return true if the complementary landmark is in main landmark', function() {
var params = checkSetup(
'<main><div role="complementary" id="target"></div></main>'
);
axe.utils.getFlattenedTree(document.documentElement);
assert.isTrue(check.evaluate.apply(checkContext, params));
assert.deepEqual(checkContext._data, { role: 'complementary' });
});

it('should return false if div with role set to main is in another landmark', function() {
var params = checkSetup(
'<div role="navigation"><div role="main" id="target"></div></div>'
Expand Down
4 changes: 2 additions & 2 deletions test/integration/full/landmark-complementary-is-top-level/frames/level1-fail.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
</head>
<body>
<p>This iframe should fail, too</p>
<main>
<nav>
<div role="complementary">
<p>This complementary landmark is in a main landmark</p>
</div>
</main>
</nav>
</body>
</html>
5 changes: 5 additions & 0 deletions ...on/full/landmark-complementary-is-top-level/landmark-complementary-is-top-level-pass.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@
<p>This div has role form</p>
<p></p>
</div>
<div role="main">
<div role="complementary">
<p>This div has role complementary></p>
</div>
</div>

<iframe id="frame1" src="frames/level1.html"></iframe>
<div id="mocha"></div>
Expand Down
4 changes: 2 additions & 2 deletions ...tion/full/landmark-complementary-is-top-level/landmark-complementary-is-top-level-pass.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ describe('landmark-complementary-is-top-level test pass', function() {
});

describe('passes', function() {
it('should find 4', function() {
assert.lengthOf(results.passes[0].nodes, 4);
it('should find 5', function() {
assert.lengthOf(results.passes[0].nodes, 5);
});
});

Expand Down