• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<div id="pageData-name" class="pageData">experimental.webInspector.* APIs</div>
2
3<p>
4The following API modules provide support for extending
5Chrome Development Tools (aka WebInspector):
6</p>
7
8<a name="api-list"></a>
9<ul>
10  <li jsselect="webInspectorAPIs();">
11  <a jsvalues=".href: $this + '.html'" jscontent="$this"></a></li>
12</ul>
13
14<p class="warning">
15<b>Caution:</b>
16Don't depend on these experimental APIs. They might disappear, and they
17<em>will</em> change.
18Also, the Chrome Developer Dashboard doesn't allow you to
19upload extensions that use experimental APIs.
20</p>
21
22<h2 id="using">How to use WebInspector APIs</h2>
23
24<ol>
25  <li>
26    WebInspector APIs are currently experimental, so please start with
27    <a href="experimental.html">the steps for using experimental extension
28    APIs</a>.
29  </li>
30  <li>
31    Specify the "devtools_page" field in your extension's manifest and make
32    sure you have "experimental" permission:
33<pre>
34{
35  "name": ...
36  "version": "1.0",
37  "minimum_chrome_version": "10.0",
38  <b>"devtools_page": "devtools.html"</b>,
39  "permissions": [ <b>"experimental"</b> ... ],
40  ...
41}
42</pre>
43  </li>
44  <li>
45    An instance of the devtools_page specified in your extension's manifest
46    will be created for every Developer Tools window opened. The page may add
47    other extension pages as panels and sidebars to the Developer Tools window
48    using <a href="experimental.webInspector.panels"
49    >experimental.webInspector.panels</a>
50    API.
51  </li>
52  <li>The APIs available to extension pages within the Developer Tools
53    window include all <a href="#api-list">experimental.webInspector modules
54    listed above</a> and <a href="extension.html">chrome.extension</a> API.
55    Other extension APIs are not available to the Developer Tools pages, but
56    you may invoke them by sending a request to the background page of your
57    extension, similarly to how it's done in the
58    <a href="overview.html#contentScripts">content scripts</a>.
59  <li>Please note that, unlike other Chrome Extension APIs, the WebInspector
60    APIs lack "chrome" prefix. This is because the APIs, as the WebInspector
61    itself, are a part of WebKit and may eventually appear in other browsers.
62  </li>
63  <li>
64    <a href="http://groups.google.com/group/google-chrome-developer-tools/topics"
65    >Give us feedback!</a>
66    Your comments and suggestions help us improve the APIs and decide which
67    ones should move from experimental to supported.
68  </li>
69</ol>
70
71<h2 id="other">More information</h2>
72
73<p>
74For information on the standard APIs that extensions can use, see
75<a href="api_index.html">chrome.* APIs</a> and
76<a href="api_other.html">Other APIs</a>.
77</p>
78