Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the BSD License.
©2012 Google
chrome extensions
|
Use the chrome.experimental.devtools.audits module to add new audit
categories to Developer Tools' Audit panel.
See DevTools APIs summary for general introduction to using Developer Tools APIs.
Each audit category is represented by a line on Select audits to run screen in the Audits panel. The following example adds a category named Readability:
var category = chrome.experimental.devtools.audits.addCategory("Readability", 2);
If the category's checkbox is checked, the onAuditStarted event of
that category will be fired when user clicks the Run button.
The event handler in your extension receives AuditResults
as an argument and should add one or more results using addResult()
method. This may be done asynchronously, i.e. after the handler returns. The
run of the category is considered to be complete once the extension adds the
number of results declared when adding the category with
addCategory() or
calls AuditResult's done() method.
The results may include additional details visualized as an expandable
tree by the Audits panel. You may build the details tree using the
createResult() and addChild() methods. The child node
may include specially formatted fragments created by the
auditResults.createSnippet()
and auditResults.createURL() methods.
The following example adds a handler for onAuditStarted event that creates two audit results and populates one of them with the additional details:
category.onAuditStarted.addListener(function(results) {
var details = results.createResult("Details...");
var styles = details.addChild("2 styles with small font");
var elements = details.addChild("3 elements with small font");
results.addResult("Font Size (5)",
"5 elements use font size below 10pt",
results.Severity.Severe,
details);
results.addResult("Contrast",
"Text should stand out from background",
results.Severity.Info);
});
The audit result tree produced by the snippet above will look like this:
You can find more examples that use this API in Samples.
If the category is enabled, this event is fired when the audit is started. The event handler is expected to initiate execution of the audit logic that will populate the results collection.
createResult() or addChild(). See AuditResults.createSnippet and AuditResults.createURL.
Adds an audit result. The results are rendered as bulleted items under the audit category assoicated with the AuditResults object.
Creates a result node that may be used as the details parameters to the addResult() method.
Signals the DevTools Audits panel that the run of this category is over. The audit run also completes automatically when the number of added top-level results is equal to that declared when AuditCategory was created.
Adds a child node to this node.