summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/static/experimental.html
blob: 211cabca57d386188a3c5ae3d082f8f844dce945 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<div id="pageData-name" class="pageData">chrome.experimental.* APIs</div>
<div id="pageData-showTOC" class="pageData">true</div>

<p>
Before you start, <strong>choose the right version of this page.</strong>
You should read either:
</p>

<ul>
  <li> <a href="http://code.google.com/chrome/extensions/trunk/experimental.html">Most recent experimental APIs</a>
  <li> <a href="http://code.google.com/chrome/extensions/dev/experimental.html">Dev channel experimental APIs</a></li>
</ul>

<p>
For information about browser versions such as
Canary (bleeding edge) and the Dev channel, see
<a href="http://www.chromium.org/getting-involved/dev-channel">Chrome Release Channels</a>.
For details about channel-specific docs,
see <a href="docs.html#versions">Doc versions</a>.
</p>

<h2 id="overview">
List of APIs
</h2>

<p>
We'd like your <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">feedback</a>
on the following experimental APIs:
</p>

<ul>
  <li jsselect="experimentalAPIs();">
  <a jsvalues=".href: $this + '.html'" jscontent="$this"></a></li>
</ul>

<p>
Pay special attention to the following APIs,
which we expect to finalize soon:
<b>devtools</b>,
<b>infobars</b>,
<b>permissions</b>,
For examples of using the experimental APIs, see
<a href="samples.html#experimental">Samples</a>.
</p>

<p class="warning">
<b>Caution:</b>
Don't depend on these experimental APIs.
They might disappear,
and they <em>will</em> change.
Also, the Chrome Web Store doesn't allow you to
upload extensions that use experimental APIs.
</p>


<h2 id="using">How to use experimental APIs</h2>

<ol>
  <li>
    Make sure you're using either
    <a href="http://tools.google.com/dlpage/chromesxs">Canary</a>
    (which you can use at the same time as other Chrome channels) or the
<a href="http://www.chromium.org/getting-involved/dev-channel">Dev channel</a>.
    Although the experimental APIs might work in other versions,
    we need your feedback on the latest incarnation of the APIs,
    which you can find in Canary and on the Dev channel.
  </li>
  <li>
    Using either the
    <a href="http://code.google.com/chrome/extensions/trunk/experimental.html">most recent API documentation</a> (if you're using Canary) or the
    <a href="http://code.google.com/chrome/extensions/dev/experimental.html">API documentation for the Dev channel</a>,
    write the code for your extension.
  </li>
  <li>
    Specify the "experimental"
    <a href="manifest.html#permissions">permission</a>
    in your extension's manifest, like this:
<pre>
"permissions": [
  <b>"experimental"</b>,
  ...
],
</pre>
  </li>
  <li>
    Enable the experimental API in your browser.
    You can do this in either of two ways:
    <ul>
      <li> Go to <b>chrome://flags</b>,
        find "Experimental Extension APIs",
        click its "Enable" link,
        and restart Chrome.
        From now on,
        unless you return to that page and disable experimental APIs,
        you'll be able to run extensions that use experimental APIs.
      </li>
      <li> Specify the <b>--enable-experimental-extension-apis</b> flag
        each time you launch the browser.
        On Windows, you can do this by modifying
        the properties of the shortcut that you use to launch Google Chrome.
        For example:

<pre>
<em>path_to_chrome.exe</em> <b>--enable-experimental-extension-apis</b></pre>
      </li>
    </ul>
  </li>

  <li>
    <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/topics">Give us feedback!</a>
    Your comments and suggestions help us
    improve the APIs and decide
    which ones should move from experimental to supported.
  </li>
</ol>

<h2 id="other">More APIs</h2>

<p>
For information on the standard APIs that extensions can use, see
<a href="api_index.html">chrome.* APIs</a> and
<a href="api_other.html">Other APIs</a>.
</p>