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.

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

Report: add legend to decipher iconography left to us by the ancient ones #1841

Merged
merged 1 commit into from
Mar 9, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
111 changes: 95 additions & 16 deletions lighthouse-core/report/styles/report.css
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ span, div, p, section, header, h1, h2, li, ul {
--body-line-height: 20px;
--subitem-font-size: 14px;
--subitem-line-height: 20px;
--subitem-overall-icon-size: 14px;
--subheading-font-size: 16px;
--subheading-line-height: 24px;
--subheading-color: inherit;
Expand All @@ -50,6 +51,11 @@ span, div, p, section, header, h1, h2, li, ul {
--report-width: 1280px;
--report-menu-width: 280px;
--report-header-height: 58px;
--report-header-bg-color: #fafafa;
--report-border-color: #ebebeb;

--aggregation-padding: calc(var(--heading-line-height) + var(--gutter-width) + var(--gutter-gap));
--aggregation-icon-size: 20px;
}

:root[data-report-context="devtools"] {
Expand Down Expand Up @@ -120,7 +126,6 @@ summary {
margin: 0 auto;
max-width: var(--report-width);
background-color: #fff;
box-shadow: 0 0 6px 0 rgba(0,0,0,0.26);
}

.report-body__icon {
Expand Down Expand Up @@ -290,7 +295,7 @@ summary {
.menu__report-tab {
padding: 3px 13px;
color: #777;
border-top: 1px solid #ebebeb;
border-top: 1px solid var(--report-border-color);
display: flex;
flex-direction: column;
cursor: pointer;
Expand Down Expand Up @@ -327,7 +332,7 @@ summary {
.menu__nav-item {
height: 40px;
line-height: 40px;
border-top: 1px solid #ebebeb;
border-top: 1px solid var(--report-border-color);
}

.menu__link {
Expand Down Expand Up @@ -406,14 +411,14 @@ summary {
flex-direction: row;
align-items: center;
justify-content: flex-start;
border-bottom: 1px solid #ebebeb;
border-bottom: 1px solid var(--report-border-color);
padding-right: 14px;
position: fixed;
width: calc(100vw - var(--report-menu-width));
max-width: calc( var(--report-width) - var(--report-menu-width));
z-index: 1;
will-change: transform;
background-color: #fafafa;
background-color: var(--report-header-bg-color);
}

.report-body__more-toggle {
Expand Down Expand Up @@ -447,7 +452,7 @@ summary {
opacity: 0;
visibility: hidden;
transition: all 200ms cubic-bezier(0,0,0.2,1);
border-bottom: 1px solid #ebebeb;
border-bottom: 1px solid var(--report-border-color);
}

.report-body__header-container.expanded .report-body__header-content {
Expand All @@ -460,7 +465,7 @@ summary {
padding: 15px 0 15px 0;
}

.report-body__header-content .config-section__title {
.config-section__title {
font-size: var(--subheading-font-size);
font-weight: 400;
line-height: var(--subheading-line-height);
Expand Down Expand Up @@ -622,12 +627,87 @@ summary {
.footer {
margin-top: 40px;
margin-left: var(--report-menu-width);
height: 130px;
line-height: 90px;
text-align: center;
font-size: 12px;
border-top: 1px solid #ebebeb;
border-top: 1px solid var(--report-border-color);
color: #767676;
background-color: var(--report-header-bg-color);
border-top: 1px solid var(--report-border-color);
}

.footer__key-description {
padding-left: calc(var(--subitem-indent) / 2);
}

.footer__legend {
padding: var(--heading-line-height) var(--aggregation-padding);
padding-bottom: 0;
}

.footer__legend .config-section__title {
margin: 0 0 calc(var(--subitem-indent) / 2) 0;
}

.footer__legend h2.config-section__title {
text-transform: uppercase;
}

.legend_panel {
border: 1px solid var(--report-border-color);
border-radius: 2px;
padding: var(--subitem-indent);
background: #fff;
}

.legend_columns {
display: flex;
justify-content: space-between;
}

.legend_columns.single-line {
padding-bottom: var(--subitem-indent);
}

.legend_columns.single-line .legend_column {
display: flex;
justify-content: space-between;
}

.legend_categories {
width: 100%;
}

@media screen and (max-width: 900px) {
.legend_columns {
display: block;
}
.legend_columns.single-line .legend_column {
display: block;
}
}

.legend_column span[class*="subitem-result__"] {
flex-shrink: 0;
}

.legend_categories .aggregation__header__score {
height: var(--aggregation-icon-size);
width: var(--aggregation-icon-size);
flex-shrink: 0;
}

.legend_categories .aggregation__header__score::after {
background-size: var(--subitem-overall-icon-size);
}

.footer__legend li {
padding: calc(var(--subitem-indent) / 2) 0;
display: flex;
align-items: center;
}

.footer__generated {
text-align: center;
line-height: 90px;
}

.devtabs {
Expand All @@ -650,7 +730,7 @@ summary {

.aggregations {
padding: var(--heading-line-height);
padding-left: calc(var(--heading-line-height) + var(--gutter-width) + var(--gutter-gap));
padding-left: var(--aggregation-padding);
}

.aggregations:not(:first-child) {
Expand Down Expand Up @@ -717,7 +797,7 @@ summary {
}

.aggregation__header .aggregation__header__score::after {
background-size: 14px;
background-size: var(--subitem-overall-icon-size);
}

.aggregation__header > h2 {
Expand All @@ -728,7 +808,6 @@ summary {
}

.aggregation {
--aggregation-icon-size: 20px;
margin-top: var(--subheading-line-height);
max-width: var(--max-line-length);
padding-left: calc(var(--aggregation-icon-size) + var(--subitem-indent) / 2);
Expand Down Expand Up @@ -756,7 +835,6 @@ summary {

.aggregation__desc {
font-size: var(--body-font-size);
/*font-style: italic;*/
color: var(--secondary-text-color);
line-height: var(--body-line-height);
margin-top: calc(var(--body-line-height) / 2);
Expand Down Expand Up @@ -816,6 +894,7 @@ summary {
top: 0;
bottom: 0;
background-color: #fff;
border-radius: inherit;
}

.subitem-result__good::after {
Expand Down Expand Up @@ -980,7 +1059,7 @@ summary {

.export-dropdown {
position: absolute;
background-color: #fafafa;
background-color: var(--report-header-bg-color);
border: 1px solid #ccc;
border-radius: 3px;
margin: 0;
Expand Down
75 changes: 74 additions & 1 deletion lighthouse-core/report/templates/report-template.html
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,80 @@ <h2>{{ aggregation.name }}</h2>
</div>

<footer class="footer">
Generated by <b>Lighthouse</b> {{lighthouseVersion}} on {{ formatDateTime generatedTime }} | <a href="https://github.com/GoogleChrome/Lighthouse/issues" target="_blank" rel="noopener">File an issue</a>
<div class="footer__legend">
<h2 class="config-section__title">Legend</h2>
<div class="legend_panel">
<section class="legend_columns single-line">
<div class="legend_categories">
<h3 class="config-section__title">Audit categories</h3>
<ul class="legend_column">
<li>
<span class="aggregation__header__score score-good-bg subitem-result__good">Good</span>
<span class="footer__key-description">Overall category score is 75-100</span>
</li>
<li>
<span class="aggregation__header__score score-average-bg subitem-result__good">Average</span>
<span class="footer__key-description">Overall category score is 45-74</span>
</li>
<li>
<span class="aggregation__header__score score-poor-bg subitem-result__poor">Poor</span>
<span class="footer__key-description">Overall category score is < 45</span>
</li>
</ul>
</div>
</section>
<section class="legend_columns">
<div>
<h3 class="config-section__title">Scored audits</h3>
<ul class="legend_column">
<li>
<span class="subitem-result__points score-good-bg">90</span>
<span class="footer__key-description">"Good" score of 90/100</span>
</li>
<li>
<span class="subitem-result__points score-average-bg">45</span>
<span class="footer__key-description">"Average" score of 45/100</span>
</li>
<li>
<span class="subitem-result__points score-poor-bg">25</span>
<span class="footer__key-description">"Poor" score of 25/100</span>
</li>
</ul>
</div>
<div>
<h3 class="config-section__title">Pass/fail audits</h3>
<ul class="legend_column">
<li>
<span class="subitem-result__good score-good-bg">Pass</span>
<span class="footer__key-description">Passed the audit</span>
</li>
<li>
<span class="subitem-result__poor score-poor-bg">Fail</span>
<span class="footer__key-description">Failed the audit</span>
</li>
<li>
<span class="subitem-result__unknown score-warning-bg">Unknown</span>
<span class="footer__key-description">Error or score can't be determined</span>
</li>
</ul>
</div>
<div>
<h3 class="config-section__title">Informational audits</h3>
<ul class="legend_column">
<li>
<span class="subitem-result__info score-good-bg">Pass</span>
<span class="footer__key-description">Passed the audit</span>
</li>
<li>
<span class="subitem-result__warning score-warning-bg">Fail</span>
<span class="footer__key-description">Failed the audit</span>
</li>
</ul>
</div>
</section>
</div>
</div>
<div class="footer__generated">Generated by <b>Lighthouse</b> {{lighthouseVersion}} on {{ formatDateTime generatedTime }} | <a href="https://github.com/GoogleChrome/Lighthouse/issues" target="_blank" rel="noopener">File an issue</a></div>
</footer>
{{#ifEq reportContext "perf-x" }}
<div class="report-body__fixed-footer-container">
Expand Down