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

core(tap-targets): exclude sticky elements from tap targets audit #7603

Merged
merged 2 commits into from
Mar 20, 2019
Merged

core(tap-targets): exclude sticky elements from tap targets audit #7603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fe4b17
Exclude sticky elements from tap targets audit
mattzeunert Mar 20, 2019
1526756
Remove extra css from position static element
mattzeunert Mar 20, 2019
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
11 changes: 10 additions & 1 deletion lighthouse-cli/test/fixtures/seo/seo-tap-targets.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@
<body>
<!-- Big tap target, but it's invisible because it's behind the main content div -->
<a style="background: red; position: absolute; top: 0; bottom: 0; left: 0; right: 0; z-index: -1;"></a>

<a style="background: red; position: sticky; top: 0; left: 0; display: block; width: 100vw; height: 40px; z-index: 1;">sticky</a>

<div style="background: white; padding: 20px;">
<h1>SEO Tap targets</h1>

Expand Down Expand Up @@ -108,13 +111,19 @@ <h1>SEO Tap targets</h1>
</div>

<!-- Links in text blocks are exempted from size/overlap requirements and should not fail -->
<p style="width: 100px">
<p style="width: 100px;margin-bottom: 30px;">
This is <a>a link in a text block.</a>
This is <a>a link in a text block.</a>
This is <a>a link in a text block.</a>
This is <a>a link in a text block.</a>
This is <a>a link in a text block.</a>
</p>

<a style="background: #afa; display: block; width: 100%; height: 800px;">
This link is intentionally placed at the bottom of the page, so that when we've scrolled
to the bottom of the page it overlaps with the sticky header. (Should not fail though
because the overlap depends on the current scroll position.)
</a>
</div>
</body>
</html>
11 changes: 8 additions & 3 deletions lighthouse-cli/test/smokehouse/seo/expectations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,12 @@ module.exports = [
finalUrl: BASE_URL + 'seo-tap-targets.html',
audits: {
'tap-targets': {
score: 0.8, // 10 passing targets/11 total visible targets, multiplied by 0.89 to get the score
score: (() => {
const PASSING_TAP_TARGETS = 11;
const TOTAL_TAP_TARGETS = 12;
const SCORE_FACTOR = 0.89;
return Math.floor(PASSING_TAP_TARGETS / TOTAL_TAP_TARGETS * SCORE_FACTOR * 100) / 100;
})(),
details: {
items: [
{
Expand All @@ -193,15 +198,15 @@ module.exports = [
'snippet': '<a ' +
'style="display: block; width: 100px; height: 30px;background: #ddd;">' +
'\n too small target\n </a>',
'path': '2,HTML,1,BODY,2,DIV,21,DIV,0,A',
'path': '2,HTML,1,BODY,3,DIV,21,DIV,0,A',
'selector': 'body > div > div > a',
},
'overlappingTarget': {
'type': 'node',
'snippet': '<a ' +
'style="display: block; width: 100px; height: 100px;background: #aaa;">' +
'\n big enough target\n </a>',
'path': '2,HTML,1,BODY,2,DIV,21,DIV,1,A',
'path': '2,HTML,1,BODY,3,DIV,21,DIV,1,A',
'selector': 'body > div > div > a',
},
'size': '100x30',
Expand Down
10 changes: 5 additions & 5 deletions lighthouse-core/gather/gatherers/seo/tap-targets.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,13 +225,13 @@ function elementIsInTextBlock(element) {
* @returns {boolean}
*/
/* istanbul ignore next */
function elementIsPositionFixedOrAbsolute(element) {
function elementIsPositionFixedStickyOrAbsolute(element) {
const {position} = getComputedStyle(element);
if (position === 'fixed' || position === 'absolute') {
if (position === 'fixed' || position === 'absolute' || position === 'sticky') {
return true;
}
if (element.parentElement) {
return elementIsPositionFixedOrAbsolute(element.parentElement);
return elementIsPositionFixedStickyOrAbsolute(element.parentElement);
}
return false;
}
Expand Down Expand Up @@ -273,7 +273,7 @@ function gatherTapTargets() {
// in the Web Content Accessibility Guidelines https://www.w3.org/TR/WCAG21/#target-size
return;
}
if (elementIsPositionFixedOrAbsolute(tapTargetElement)) {
if (elementIsPositionFixedStickyOrAbsolute(tapTargetElement)) {
// Absolutely positioned elements might not be visible if they have a lower z-index
// than other tap targets, but if we don't ignore them we can get false failures.
//
Expand Down Expand Up @@ -311,7 +311,7 @@ class TapTargets extends Gatherer {
const tapTargetsSelector = "${tapTargetsSelector}";
${pageFunctions.getElementsInDocumentString};
${filterClientRectsWithinAncestorsVisibleScrollArea.toString()};
${elementIsPositionFixedOrAbsolute.toString()};
${elementIsPositionFixedStickyOrAbsolute.toString()};
${elementIsVisible.toString()};
${elementHasAncestorTapTarget.toString()};
${getVisibleClientRects.toString()};
Expand Down