Integrating Lighthouse into your product
Guidelines & Brand Assets
This document is meant as a resource for companies and individuals who are integrating Lighthouse as part of the products / services they're offering. First things first - we're so excited you are! We want as many people as possible to use Lighthouse, and this guide is meant to make it straightforward to show that Lighthouse is under the hood powering portions of your product. We also want to make sure that we are protecting the Lighthouse brand, and so appreciate your honoring these suggestions.
General Guidelines
When in doubt, do the following three things:
|
While the above default suggestion is good, we do suggest that you take a more nuanced approach - the level of Lighthouse branding you incorporate should reflect the amount of Lighthouse that you're using! Here are the various ways that you might be using Lighthouse, and the appropriate branding / terminology that you can use when doing so.
Example #1 | Example #2 | Example #3 |
Applies to Scenario 1 | Applies to Scenario 2, 3, & 4 | Applies to Scenario 5 |
Scenario 1: Entire Report
If you're using the entire Lighthouse report (all categories, all audits):
- Use the Lighthouse Logo, incorporate the language (and link) 'Powered by Lighthouse (v x.x).'
- Make sure that the Lighthouse version is updated and accurate.
- See example #1 above.
Scenario 2: Single Category
If you're using a single category of the Lighthouse report (e.g. Performance, or Best Practices):
- Same as Scenario 1 ++.
- Include the language 'To run a full Lighthouse report, go here.'
- See example #2 above.
Scenario 3: Subset of Audits
If you're choosing a subset of audits to show (e.g. picking and choosing some of the individual audits from a single category or multiple categories and not showing other audits):
- Same as Scenario 2.
- See example #2 above.
Scenario 4: Just the Performance Metrics
If you're showing just the metrics:
- Same as Scenario 2.
- See example #2 above.
Scenario 5: Changing the Logic
If you're changing the logic of the report (e.g. changing the scoring methodology, adding new audits / audit categories):
- Please refrain from using our logo or wordmark.
- Incorporate the language and link 'Portions of this [report/insight/consultation] use Lighthouse. For more information visit https://developers.google.com/web/tools/lighthouse.'
- See example #3 above.
**Important**
Lastly, please don't use terms like 'approved partner' or 'official partner' - just because we adore you (and we do) we can't say that we're affiliated officially. Sad, I know.
If you want to provide documentation about specific audits or categories, please link to the appropriate official Lighthouse audit documentation here.
Assets
Logos
- Download Logo Kit -- based on discussion in comments: recommendation is to host the assets in the same way we would anything else (e.g images). We might want to host those via the same infrastructure as zips to avoid any branding assets getting recompressed.
Iconography
Canonical Links
Terminology
Report
The Lighthouse Report refers to the entirety of the results that are returned upon running Lighthouse.
Audit Category
An Audit Category is a group of audits that share characteristics with regards to what aspect of quality you're trying to optimize for.
For instance, all audits in the 'Performance category' help to diagnose issues with, and provide opportunities for, helping your page's performance. Similarly, all audits within the 'Accessibility category' are aimed to help improve your site's accessibility. All audit categories represent important aspects of quality for your users.
There are 5 audit categories in Lighthouse, each representing a different dimension of user-facing quality:
- Performance
- Accessibility
- Best Practices
- SEO
- Progressive Web App
Category Score
A Category Score is the quantified result of how a page performed against an audit category. Category scores are summaries of how a page performed overall against the respective set of audits.
Metric
The Metrics in the Lighthouse report are various ways to measure your page's performance. For instance, 'First Contentful Paint' is a metric that helps to evaluate how quickly your page's content is first visible to a user. There are 6 metrics in the report, and they are weighted and blended to form the Performance Category Score.
Audit
A Lighthouse audit evaluates how well a page meets a specific best-practice. Audits typically provide an indication of how to fix issues meeting certain best-practices and may in some cases estimate the impact (e.g to a performance metric) of making a fix.
These audits are presented across a range of different categories, as noted above.