| OLD | NEW |
|---|
| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: |
| 2 1) The <head> information in this page is significant, should be uniform | 2 1) The <head> information in this page is significant, should be uniform |
| 3 across api docs and should be edited only with knowledge of the | 3 across api docs and should be edited only with knowledge of the |
| 4 templating mechanism. | 4 templating mechanism. |
| 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
| 6 browser, it will be re-generated from the template, json schema and | 6 browser, it will be re-generated from the template, json schema and |
| 7 authored overview content. | 7 authored overview content. |
| 8 4) The <body>.innerHTML is also generated by an offline step so that this | 8 4) The <body>.innerHTML is also generated by an offline step so that this |
| 9 page may easily be indexed by search engines. | 9 page may easily be indexed by search engines. |
| 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> |
| (...skipping 292 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 303 </div> | 303 </div> |
| 304 <!-- /TABLE OF CONTENTS --> | 304 <!-- /TABLE OF CONTENTS --> |
| 305 | 305 |
| 306 <!-- Standard content lead-in for experimental API pages --> | 306 <!-- Standard content lead-in for experimental API pages --> |
| 307 <p id="classSummary"> | 307 <p id="classSummary"> |
| 308 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. | 308 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. |
| 309 </p> | 309 </p> |
| 310 | 310 |
| 311 <!-- STATIC CONTENT PLACEHOLDER --> | 311 <!-- STATIC CONTENT PLACEHOLDER --> |
| 312 <div id="static"><!-- BEGIN AUTHORED CONTENT --> | 312 <div id="static"><!-- BEGIN AUTHORED CONTENT --> |
| 313 <p>The omnibox API allows you to register a | 313 <p> |
| 314 keyword with Google Chrome's omnibox. | 314 The omnibox API allows you to register a |
| 315 keyword with Google Chrome's address bar, |
| 316 which is also known as the omnibox. |
| 317 </p> |
| 315 | 318 |
| 316 </p><p><img src="omnibox.png" width="480" height="300"> | 319 <p> |
| 320 <img src="images/omnibox.png" width="480" height="300" alt="A screenshot showing
suggestions related to the keyword 'Chromium Search'"> |
| 321 </p> |
| 317 | 322 |
| 318 </p><p>When the user enters your extension's | 323 <p> |
| 319 keyword, they enter a mode where they are | 324 When the user enters your extension's |
| 325 keyword, the user starts |
| 320 interacting solely with your extension. | 326 interacting solely with your extension. |
| 321 Each of their keystrokes is sent to your | 327 Each keystroke is sent to your |
| 322 extension, and you can provide suggestions | 328 extension, and you can provide suggestions |
| 323 in response. | 329 in response. |
| 330 </p> |
| 324 | 331 |
| 325 </p><p>The suggestions can be richly formatted | 332 <p> |
| 326 in a variety of ways. When the user accepts | 333 The suggestions can be richly formatted |
| 334 in a variety of ways. |
| 335 <!-- PENDING: for example? (include a mention of method name, maybe show a code
snippet) --> |
| 336 When the user accepts |
| 327 a suggestion, your extension is notified | 337 a suggestion, your extension is notified |
| 328 and can take action. | 338 and can take action. |
| 339 </p> |
| 329 | 340 |
| 330 </p><h2 id="manifest">Manifest</h2> | 341 <h2 id="manifest">Manifest</h2> |
| 331 | 342 |
| 332 <p>To use the Omnibox API, your manifest must | 343 <p> |
| 344 To use the omnibox API, your manifest must |
| 333 declare the "experimental" permission and | 345 declare the "experimental" permission and |
| 334 register an omnibox keyword. You should also | 346 specify an <code>omnibox_keyword</code> field. You should also |
| 335 specify a 16x16-pixel icon. This will get | 347 specify a 16x16-pixel icon, which will be |
| 336 displayed in the omnibox when suggesting users | 348 displayed in the omnibox when suggesting users |
| 337 enter keyword mode. | 349 enter keyword mode. |
| 350 </p> |
| 338 | 351 |
| 339 </p><p>For example: | 352 <p> |
| 353 For example: |
| 354 </p> |
| 340 | 355 |
| 341 </p><pre>{ | 356 <pre>{ |
| 342 "name": "Aaron's omnibox extension", | 357 "name": "Aaron's omnibox extension", |
| 343 "version": "1.0", | 358 "version": "1.0", |
| 344 <b>"permissions": ["experimental"],</b> | 359 <b>"permissions": ["experimental"],</b> |
| 345 <b>"omnibox_keyword": "aaron",</b> | 360 <b>"omnibox_keyword": "aaron",</b> |
| 346 <b>"icons": {</b> | 361 <b>"icons": {</b> |
| 347 <b>"16": "16-full-color.png"</b> | 362 <b>"16": "16-full-color.png"</b> |
| 348 <b>},</b> | 363 <b>},</b> |
| 349 "background_page": "background.html" | 364 "background_page": "background.html" |
| 350 | |
| 351 }</pre> | 365 }</pre> |
| 352 | 366 |
| 353 <p><b class="note">Note:</b> Google Chrome | 367 <p><b class="note">Note:</b> Google Chrome |
| 354 automatically creates a greyscale version of | 368 automatically creates a greyscale version of |
| 355 your 16x16-pixel icon. You should provide | 369 your 16x16-pixel icon. You should provide |
| 356 a full-color version so that it can also be | 370 a full-color version so that it can also be |
| 357 used in other situations that require color. | 371 used in other situations that require color. |
| 358 For example, the <a href="contextMenus.html">Context Menus API</a> also uses a 1
6x16-pixel | 372 For example, the <a href="contextMenus.html">context menus API</a> also uses a 1
6x16-pixel |
| 359 icon, but it is displayed in color. | 373 icon, but it is displayed in color. |
| 360 | 374 |
| 375 |
| 361 </p><h2 id="examples">Examples</h2> | 376 </p><h2 id="examples">Examples</h2> |
| 362 | 377 |
| 363 <p> | 378 <p> |
| 364 You can find samples of this API on the | 379 You can find samples of this API on the |
| 365 <a href="samples.html#omnibox">sample page</a>. | 380 <a href="samples.html#omnibox">sample page</a>. |
| 366 | 381 |
| 367 <!-- END AUTHORED CONTENT --> | 382 <!-- END AUTHORED CONTENT --> |
| 368 </p></div> | 383 </p></div> |
| 369 | 384 |
| 370 <!-- API PAGE --> | 385 <!-- API PAGE --> |
| (...skipping 1281 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 1652 _uff=0; | 1667 _uff=0; |
| 1653 urchinTracker(); | 1668 urchinTracker(); |
| 1654 } | 1669 } |
| 1655 catch(e) {/* urchinTracker not available. */} | 1670 catch(e) {/* urchinTracker not available. */} |
| 1656 </script> | 1671 </script> |
| 1657 <!-- end analytics --> | 1672 <!-- end analytics --> |
| 1658 </div> | 1673 </div> |
| 1659 </div> <!-- /gc-footer --> | 1674 </div> <!-- /gc-footer --> |
| 1660 </div> <!-- /gc-container --> | 1675 </div> <!-- /gc-container --> |
| 1661 </body></html> | 1676 </body></html> |
| OLD | NEW |
|---|
Chromium Code Reviews
