• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<h1 class="page_title">chrome.experimental.* APIs</h1>
2
3<h2 id="overview">
4List of APIs
5</h2>
6
7{{^is_apps}}
8<p class="doc-family extensions">
9We'd like your <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">feedback</a>
10on the following experimental APIs:
11</p>
12{{/is_apps}}
13
14{{+partials.api_table apis:apis is_stable:false/}}
15
16{{^is_apps}}
17<p class="doc-family extensions">
18Pay special attention to the following APIs,
19which we expect to finalize soon:
20<b>devtools</b>,
21<b>permissions</b>,
22For examples of using the experimental APIs, see
23<a href="samples#experimental">Samples</a>.
24</p>
25{{/is_apps}}
26
27<p class="warning">
28<b>Caution:</b>
29Don't depend on these experimental APIs.
30They might disappear,
31and they <em>will</em> change.
32Also, the Chrome Web Store doesn't allow you to
33upload items that use experimental APIs.
34</p>
35
36
37<h2 id="using">How to use experimental APIs</h2>
38
39<ol>
40  {{^is_apps}}
41  <li class="doc-family extensions">
42    Make sure you're using either
43    <a href="http://tools.google.com/dlpage/chromesxs">Canary</a>
44    (which you can use at the same time as other Chrome channels) or the
45<a href="http://www.chromium.org/getting-involved/dev-channel">Dev channel</a>.
46    Although the experimental APIs might work in other versions,
47    we need your feedback on the latest incarnation of the APIs,
48    which you can find in Canary and on the Dev channel.
49  </li>
50  {{/is_apps}}
51  <li>
52    Specify the "experimental"
53    <a href="declare_permissions">permission</a>
54    in your manifest, like this:
55<pre data-filename="manifest.json">
56"permissions": [
57  <b>"experimental"</b>,
58  ...
59],
60</pre>
61  </li>
62  <li>
63    Enable the experimental API in your browser.
64    You can do this in either of two ways:
65    <ul>
66      <li> Go to <b>chrome://flags</b>,
67        find "Experimental Extension APIs",
68        click its "Enable" link,
69        and restart Chrome.
70        From now on,
71        unless you return to that page and disable experimental APIs,
72        you'll be able to run extensions and apps that use experimental APIs.
73      </li>
74      <li> Specify the <b>--enable-experimental-extension-apis</b> flag
75        each time you launch the browser.
76        On Windows, you can do this by modifying
77        the properties of the shortcut that you use to launch Google Chrome.
78        For example:
79
80<pre>
81<em>path_to_chrome.exe</em> <b>--enable-experimental-extension-apis</b></pre>
82      </li>
83    </ul>
84  </li>
85
86  {{^is_apps}}
87  <li class="doc-family extension">
88    <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">Give us feedback!</a>
89    Your comments and suggestions help us
90    improve the APIs and decide
91    which ones should move from experimental to supported.
92  </li>
93  {{/is_apps}}
94</ol>
95
96<h2 id="other">More APIs</h2>
97
98<p>
99For information on the standard APIs, see
100<a href="api_index">chrome.* APIs</a> and
101<a href="api_other">Other APIs</a>.
102</p>
103