options.html revision 201ade2fbba22bfb27ae029f4d23fca6ded109a0
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 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 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 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10--><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="/third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>Options - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="omnibox.html">Omnibox</a></li> 170 <li class="leftNavSelected">Options Pages</li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li><a href="api_index.html">chrome.* APIs</a></li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">Options</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li> 251 <a href="#H2-0">Step 1: Declare your options page in the manifest</a> 252 <ol> 253 <li style="display: none; "> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li><li> 258 <a href="#H2-1">Step 2: Write your options page</a> 259 <ol> 260 <li style="display: none; "> 261 <a>h3Name</a> 262 </li> 263 </ol> 264 </li><li> 265 <a href="#H2-2">Important notes</a> 266 <ol> 267 <li style="display: none; "> 268 <a>h3Name</a> 269 </li> 270 </ol> 271 </li> 272 <li style="display: none; "> 273 <a href="#apiReference">API reference</a> 274 <ol> 275 <li> 276 <a href="#properties">Properties</a> 277 <ol> 278 <li> 279 <a href="#property-anchor">propertyName</a> 280 </li> 281 </ol> 282 </li> 283 <li> 284 <a href="#methods">Methods</a> 285 <ol> 286 <li> 287 <a href="#method-anchor">methodName</a> 288 </li> 289 </ol> 290 </li> 291 <li> 292 <a href="#events">Events</a> 293 <ol> 294 <li> 295 <a href="#event-anchor">eventName</a> 296 </li> 297 </ol> 298 </li> 299 <li> 300 <a href="#types">Types</a> 301 <ol> 302 <li> 303 <a href="#id-anchor">id</a> 304 </li> 305 </ol> 306 </li> 307 </ol> 308 </li> 309 </ol> 310 </div> 311 <!-- /TABLE OF CONTENTS --> 312 313 <!-- Standard content lead-in for experimental API pages --> 314 <p id="classSummary" style="display: none; "> 315 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 316 </p> 317 318 <!-- STATIC CONTENT PLACEHOLDER --> 319 <div id="static"><div id="pageData-name" class="pageData">Options</div> 320<div id="pageData-showTOC" class="pageData">true</div> 321<p>To allow users to customize the behavior of your extension, you may wish to provide an options page. If you do, a link to it will be provided from the extensions management page at chrome://extensions. Clicking the Options link opens a new tab pointing at your options page. 322 323</p><a name="H2-0"></a><h2>Step 1: Declare your options page in the manifest</h2> 324 325<pre>{ 326 "name": "My extension", 327 ... 328 <b>"options_page": "options.html"</b>, 329 ... 330}</pre> 331 332 333<a name="H2-1"></a><h2>Step 2: Write your options page</h2> 334 335Here is an example options page: 336 337<pre><html> 338<head><title>My Test Extension Options</title></head> 339<script type="text/javascript"> 340 341// Saves options to localStorage. 342function save_options() { 343 var select = document.getElementById("color"); 344 var color = select.children[select.selectedIndex].value; 345 localStorage["favorite_color"] = color; 346 347 // Update status to let user know options were saved. 348 var status = document.getElementById("status"); 349 status.innerHTML = "Options Saved."; 350 setTimeout(function() { 351 status.innerHTML = ""; 352 }, 750); 353} 354 355// Restores select box state to saved value from localStorage. 356function restore_options() { 357 var favorite = localStorage["favorite_color"]; 358 if (!favorite) { 359 return; 360 } 361 var select = document.getElementById("color"); 362 for (var i = 0; i < select.children.length; i++) { 363 var child = select.children[i]; 364 if (child.value == favorite) { 365 child.selected = "true"; 366 break; 367 } 368 } 369} 370 371</script> 372 373<body onload="restore_options()"> 374 375Favorite Color: 376<select id="color"> 377 <option value="red">red</option> 378 <option value="green">green</option> 379 <option value="blue">blue</option> 380 <option value="yellow">yellow</option> 381</select> 382 383<br> 384<button onclick="save_options()">Save</button> 385</body> 386</html> 387</pre> 388 389<a name="H2-2"></a><h2>Important notes</h2> 390<ul> 391<li>This feature is checked in to the trunk and should land in official builds sometime <b>after</b> version 4.0.222.x.</li> 392<li>We plan on providing some default css styles to encourage a consistent look across different extensions' options pages. You can star <a href="http://crbug.com/25317">crbug.com/25317</a> to be notified of updates.</li> 393</ul> 394</div> 395 396 <!-- API PAGE --> 397 <div class="apiPage" style="display: none; "> 398 <a name="apiReference"></a> 399 <h2>API reference: chrome.apiname </h2> 400 401 <!-- PROPERTIES --> 402 <div class="apiGroup"> 403 <a name="properties"></a> 404 <h3 id="properties">Properties</h3> 405 406 <div> 407 <a></a> 408 <h4>getLastError</h4> 409 <div class="summary"> 410 <!-- Note: intentionally longer 80 columns --> 411 <span>chrome.extension</span><span>lastError</span> 412 </div> 413 <div> 414 </div> 415 </div> 416 417 </div> <!-- /apiGroup --> 418 419 <!-- METHODS --> 420 <div class="apiGroup" id="methods"> 421 <a name="methods"></a> 422 <h3>Methods</h3> 423 424 <!-- iterates over all functions --> 425 <div class="apiItem"> 426 <a></a> <!-- method-anchor --> 427 <h4>method name</h4> 428 429 <div class="summary"><span>void</span> 430 <!-- Note: intentionally longer 80 columns --> 431 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 432 <var><span></span></var></span>)</div> 433 434 <div class="description"> 435 <p class="todo">Undocumented.</p> 436 <p> 437 A description from the json schema def of the function goes here. 438 </p> 439 440 <!-- PARAMETERS --> 441 <h4>Parameters</h4> 442 <dl> 443 <div> 444 <div> 445 </div> 446 </div> 447 </dl> 448 449 <!-- RETURNS --> 450 <h4>Returns</h4> 451 <dl> 452 <div> 453 <div> 454 </div> 455 </div> 456 </dl> 457 458 <!-- CALLBACK --> 459 <div> 460 <div> 461 <h4>Callback function</h4> 462 <p> 463 The callback <em>parameter</em> should specify a function 464 that looks like this: 465 </p> 466 <p> 467 If you specify the <em>callback</em> parameter, it should 468 specify a function that looks like this: 469 </p> 470 471 <!-- Note: intentionally longer 80 columns --> 472 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 473 <dl> 474 <div> 475 <div> 476 </div> 477 </div> 478 </dl> 479 </div> 480 </div> 481 482 <!-- MIN_VERSION --> 483 <p> 484 This function was added in version <b><span></span></b>. 485 If you require this function, the manifest key 486 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 487 can ensure that your extension won't be run in an earlier browser version. 488 </p> 489 </div> <!-- /description --> 490 491 </div> <!-- /apiItem --> 492 493 </div> <!-- /apiGroup --> 494 495 <!-- EVENTS --> 496 <div class="apiGroup"> 497 <a name="events"></a> 498 <h3 id="events">Events</h3> 499 500 <!-- iterates over all events --> 501 <div class="apiItem"> 502 <a></a> 503 <h4>event name</h4> 504 505 <div class="summary"> 506 <!-- Note: intentionally longer 80 columns --> 507 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 508 </div> 509 510 <div class="description"> 511 <p class="todo">Undocumented.</p> 512 <p> 513 A description from the json schema def of the event goes here. 514 </p> 515 516 <!-- PARAMETERS --> 517 <h4>Parameters</h4> 518 <dl> 519 <div> 520 <div> 521 </div> 522 </div> 523 </dl> 524 525 </div> <!-- /decription --> 526 527 </div> <!-- /apiItem --> 528 529 </div> <!-- /apiGroup --> 530 531 <!-- TYPES --> 532 <div class="apiGroup"> 533 <a name="types"></a> 534 <h3 id="types">Types</h3> 535 536 <!-- iterates over all types --> 537 <div class="apiItem"> 538 <a></a> 539 <h4>type name</h4> 540 541 <div> 542 </div> 543 544 </div> <!-- /apiItem --> 545 546 </div> <!-- /apiGroup --> 547 548 </div> <!-- /apiPage --> 549 </div> <!-- /gc-pagecontent --> 550 </div> <!-- /g-section --> 551 </div> <!-- /codesiteContent --> 552 <div id="gc-footer" --=""> 553 <div class="text"> 554 <p> 555 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 556 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 557 Attribution 3.0 License</a>, and code samples are licensed under the 558 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 559 </p> 560 <p> 561 ©2010 Google 562 </p> 563 564<!-- begin analytics --> 565<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 566<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 567 568<script type="text/javascript"> 569 // chrome doc tracking 570 try { 571 var engdocs = _gat._getTracker("YT-10763712-2"); 572 engdocs._trackPageview(); 573 } catch(err) {} 574 575 // code.google.com site-wide tracking 576 try { 577 _uacct="UA-18071-1"; 578 _uanchor=1; 579 _uff=0; 580 urchinTracker(); 581 } 582 catch(e) {/* urchinTracker not available. */} 583</script> 584<!-- end analytics --> 585 </div> 586 </div> <!-- /gc-footer --> 587 </div> <!-- /gc-container --> 588</body></html> 589
