• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<p>
2<img src="{{static}}/images/omnibox.png" width="300" height="150"
3  alt="A screenshot showing suggestions related to the keyword 'Chromium Search'"/>
4</p>
5
6<p>
7When the user enters your extension's
8keyword, the user starts
9interacting solely with your extension.
10Each keystroke is sent to your
11extension, and you can provide suggestions
12in response.
13</p>
14
15<p>
16The suggestions can be richly formatted
17in a variety of ways.
18
19When the user accepts
20a suggestion, your extension is notified
21and can take action.
22</p>
23
24<h2 id="manifest">Manifest</h2>
25
26<p>
27You must include an <code>omnibox</code> <code>keyword</code> field
28in the <a href="manifest.html">manifest</a>
29to use the omnibox API.
30You should also
31specify a 16x16-pixel icon, which will be
32displayed in the address bar when suggesting that users
33enter keyword mode.
34</p>
35
36<p>
37For example:
38</p>
39
40<pre data-filename="manifest.json">
41{
42  "name": "Aaron's omnibox extension",
43  "version": "1.0",
44  <b>"omnibox": { "keyword" : "aaron" },</b>
45  <b>"icons": {</b>
46    <b>"16": "16-full-color.png"</b>
47  <b>},</b>
48  "background": {
49    "persistent": false,
50    "scripts": ["background.js"]
51  }
52}
53</pre>
54
55<p class="note">
56<strong>Note:</strong>
57Chrome automatically creates a grayscale version of
58your 16x16-pixel icon. You should provide
59a full-color version so that it can also be
60used in other situations that require color.
61For example, the <a href="contextMenus.html"
62>context menus API</a> also uses a 16x16-pixel
63icon, but it is displayed in color.
64</p>
65
66
67<h2 id="examples">Examples</h2>
68
69<p>
70You can find samples of this API on the
71<a href="samples.html#omnibox">sample page</a>.
72