diff options
34 files changed, 599 insertions, 2 deletions
diff --git a/chrome/common/extensions/docs/api_index.html b/chrome/common/extensions/docs/api_index.html index b567524..5b17488 100644 --- a/chrome/common/extensions/docs/api_index.html +++ b/chrome/common/extensions/docs/api_index.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/api_other.html b/chrome/common/extensions/docs/api_other.html index f0c6590..b9acaec 100644 --- a/chrome/common/extensions/docs/api_other.html +++ b/chrome/common/extensions/docs/api_other.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/autoupdate.html b/chrome/common/extensions/docs/autoupdate.html index 8464ea8..71a37cd 100644 --- a/chrome/common/extensions/docs/autoupdate.html +++ b/chrome/common/extensions/docs/autoupdate.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/background_pages.html b/chrome/common/extensions/docs/background_pages.html index 2c639e3..a42ea95 100644 --- a/chrome/common/extensions/docs/background_pages.html +++ b/chrome/common/extensions/docs/background_pages.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html index b0eb13a..f1da8bf 100644 --- a/chrome/common/extensions/docs/bookmarks.html +++ b/chrome/common/extensions/docs/bookmarks.html @@ -112,6 +112,7 @@ <ul> <li class="leftNavSelected">Bookmarks</li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/browserAction.html b/chrome/common/extensions/docs/browserAction.html index afe35f6..983b118 100644 --- a/chrome/common/extensions/docs/browserAction.html +++ b/chrome/common/extensions/docs/browserAction.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/content_scripts.html b/chrome/common/extensions/docs/content_scripts.html index 780d7a8..c620afb 100644 --- a/chrome/common/extensions/docs/content_scripts.html +++ b/chrome/common/extensions/docs/content_scripts.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html index 8ba4537..9e15895 100644 --- a/chrome/common/extensions/docs/devguide.html +++ b/chrome/common/extensions/docs/devguide.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/devtools.html b/chrome/common/extensions/docs/devtools.html index 07331a98..b98155e 100644 --- a/chrome/common/extensions/docs/devtools.html +++ b/chrome/common/extensions/docs/devtools.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/events.html b/chrome/common/extensions/docs/events.html index 0741069..11a0f9e 100644 --- a/chrome/common/extensions/docs/events.html +++ b/chrome/common/extensions/docs/events.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li class="leftNavSelected">Events</li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/extension.html index ee22b4b..514c710 100644 --- a/chrome/common/extensions/docs/extension.html +++ b/chrome/common/extensions/docs/extension.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/getstarted.html b/chrome/common/extensions/docs/getstarted.html index 766ed62..bd234a5 100644 --- a/chrome/common/extensions/docs/getstarted.html +++ b/chrome/common/extensions/docs/getstarted.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/hosting.html b/chrome/common/extensions/docs/hosting.html index 0d3bab7..4af3190 100644 --- a/chrome/common/extensions/docs/hosting.html +++ b/chrome/common/extensions/docs/hosting.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/i18n.html b/chrome/common/extensions/docs/i18n.html index adf3fc7..3a86e17 100644 --- a/chrome/common/extensions/docs/i18n.html +++ b/chrome/common/extensions/docs/i18n.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html index 4348100..8b18dc5 100644 --- a/chrome/common/extensions/docs/index.html +++ b/chrome/common/extensions/docs/index.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html index 0100e3b..2bb46a2 100644 --- a/chrome/common/extensions/docs/manifest.html +++ b/chrome/common/extensions/docs/manifest.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> @@ -261,7 +262,8 @@ are <b>name</b> and <b>version</b>. "<a href="#permissions">permissions</a>": [...], "<a href="npapi.html">plugins</a>": [...], "<a href="themes.html">theme</a>": {...}, - "<a href="toolstrip.html">toolstrips</a>": [...] + "<a href="toolstrip.html">toolstrips</a>": [...], + "<a href="options.html">options_page</a>": "<em>aFile</em>.html", } </pre> diff --git a/chrome/common/extensions/docs/match_patterns.html b/chrome/common/extensions/docs/match_patterns.html index 93f3795..a82b86d 100644 --- a/chrome/common/extensions/docs/match_patterns.html +++ b/chrome/common/extensions/docs/match_patterns.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/npapi.html b/chrome/common/extensions/docs/npapi.html index 0c39ded..86acf93 100644 --- a/chrome/common/extensions/docs/npapi.html +++ b/chrome/common/extensions/docs/npapi.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/ntp.html b/chrome/common/extensions/docs/ntp.html index 0a7d213..0789dd7 100644 --- a/chrome/common/extensions/docs/ntp.html +++ b/chrome/common/extensions/docs/ntp.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/options.html b/chrome/common/extensions/docs/options.html new file mode 100644 index 0000000..2caeed6 --- /dev/null +++ b/chrome/common/extensions/docs/options.html @@ -0,0 +1,487 @@ +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: + 1) The <head> information in this page is significant, should be uniform + across api docs and should be edited only with knowledge of the + templating mechanism. + 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a + browser, it will be re-generated from the template, json schema and + authored overview content. + 4) The <body>.innerHTML is also generated by an offline step so that this + page may easily be indexed by search engines. +--><html xmlns="http://www.w3.org/1999/xhtml"><head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> + <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> + <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> + <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js"> + </script> + <script type="text/javascript" src="js/api_page_generator.js"></script> + <script type="text/javascript" src="js/bootstrap.js"></script> + <title>Options</title></head><body> <div id="container"> + <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> + <!-- In particular, sub-templates that recurse, must be used by allowing + jstemplate to make a copy of the template in this section which + are not operated on by way of the jsskip="true" --> + <div style="display:none"> + + <!-- VALUE --> + <div id="valueTemplate"> + <dt> + <var>paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span id="typeTemplate"> + <span> + <a> Type</a> + </span> + <span> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd> + Description of this parameter from the json schema. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + </div> <!-- /VALUE --> + + </div> <!-- /SUBTEMPLATES --> + + <a name="top"> </a> + <!-- API HEADER --> + <div id="pageHeader"> + <div id="searchbox"> + <form action="http://www.google.com/cse" id="cse-search-box"> + <div> + <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> + <input type="hidden" name="ie" value="UTF-8"> + <input type="text" name="q" size="31"> + <input type="submit" name="sa" value="Search"> + </div> + </form> + + <script type="text/javascript" src="http://www.google.com/jsapi"></script> + <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> + <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script> + <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script> + </div> + <div id="pageTitle"> + <h1>Options</h1> + </div> + </div> <!-- /pageHeader --> + + <div id="pageContent"> + <!-- SIDENAV --> + <div id="leftNav"> + <ul> + <li> <a href="index.html">Home</a></li> + <li> <a href="getstarted.html">Getting Started</a></li> + <li> <a href="overview.html">Overview</a></li> + <li> <a href="devguide.html"><div>Developer's Guide</div></a> + <ul> + <li> UI Surfaces + <ul> + <li><a href="browserAction.html">Browser Actions</a></li> + <li><a href="ntp.html">New Tab Pages</a></li> + <li><a href="pageAction.html">Page Actions</a></li> + <li><a href="themes.html">Themes</a></li> + </ul> + </li> + <li> More Interaction + <ul> + <li><a href="bookmarks.html">Bookmarks</a></li> + <li><a href="events.html">Events</a></li> + <li class="leftNavSelected">Options Page</li> + <li><a href="tabs.html">Tabs</a></li> + <li><a href="windows.html">Windows</a></li> + </ul> + </li> + <li> Implementation + <ul> + <li><a href="background_pages.html">Background Pages</a></li> + <li><a href="content_scripts.html">Content Scripts</a></li> + <li><a href="xhr.html">Cross-Origin XHR</a></li> + <li><a href="npapi.html">NPAPI Plugins</a></li> + </ul> + </li> + <li> Finishing + <ul> + <li><a href="autoupdate.html">Autoupdating</a></li> + <li><a href="packaging.html">Packaging</a></li> + </ul> + </li> + </ul> + </li> + <li><a href="tutorials.html"><div>Tutorials</div></a> + <ul> + <li><a href="tut_debugging.html">Debugging</a></li> + </ul> + </li> + <li>Reference + <ul> + <li> Formats + <ul> + <li><a href="manifest.html">Manifest Files</a></li> + <li><a href="match_patterns.html">Match Patterns</a></li> + <!-- <li>Packages (.crx)</li> --> + </ul> + </li> + <li> <a href="api_index.html">chrome.* APIs</a> </li> + <li> <a href="api_other.html">Other APIs</a> </li> + </ul> + </li> + <li><a href="http://dev.chromium.org/developers/design-documents/extensions/samples">Samples</a></li> + </ul> + </div> + + <div id="mainColumn"> + <!-- TABLE OF CONTENTS --> + <div id="toc"> + <p>Contents</p> + <ol> + <li jsinstance="0"> + <a href="#H2-0">Step 1: Declare your options page in the manifest</a> + <ol> + <li jsinstance="*0" style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li><li jsinstance="1"> + <a href="#H2-1">Step 2: Write your options page</a> + <ol> + <li jsinstance="*0" style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li><li jsinstance="*2"> + <a href="#H2-2">Important Notes</a> + <ol> + <li jsinstance="*0" style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li> + <div style="display: none; "> + <li> + <a href="#apiReference">API reference</a> + <ol> + <li> + <a href="#properties">Properties</a> + <ol> + <li> + <a href="#property-anchor">propertyName</a> + </li> + </ol> + </li> + <li> + <a href="#methods">Methods</a> + <ol> + <li> + <a href="#method-anchor">methodName</a> + </li> + </ol> + </li> + <li> + <a href="#events">Events</a> + <ol> + <li> + <a href="#event-anchor">eventName</a> + </li> + </ol> + </li> + <li> + <a href="#types">Types</a> + <ol> + <li> + <a href="#id-anchor">id</a> + </li> + </ol> + </li> + </ol> + </li> + </div> + </ol> + </div> + <!-- /TABLE OF CONTENTS --> + + <!-- STATIC CONTENT PLACEHOLDER --> + <div id="static"><div id="pageData-title" class="pageData">Options</div> +<div id="pageData-showTOC" class="pageData">true</div> +<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 on this link will open a new tab pointing at your options page. + +</p><a name="H2-0"></a><h2>Step 1: Declare your options page in the manifest</h2> + +<pre>{ + "name": "Test Extension", + "version": "1.0", + "description": "This is a test", + <b>"options_page": "options.html"</b> +} +</pre> + + +<a name="H2-1"></a><h2>Step 2: Write your options page</h2> + +Here is an example options page: + +<pre><html> +<head><title>My Test Extension Options</title></head> +<script type="text/javascript"> + +// Saves options to localStorage. +function save_options() { + var select = document.getElementById("color"); + var color = select.children[select.selectedIndex].value; + localStorage["favorite_color"] = color; + + // Update status to let user know options were saved. + var status = document.getElementById("status"); + status.innerHTML = "Options Saved."; + setTimeout(function() { + status.innerHTML = ""; + }, 750); +} + +// Restores select box state to saved value from localStorage. +function restore_options() { + var favorite = localStorage["favorite_color"]; + if (!favorite) { + return; + } + var select = document.getElementById("color"); + for (var i = 0; i < select.children.length; i++) { + var child = select.children[i]; + if (child.value == favorite) { + child.selected = "true"; + break; + } + } +} + +</script> + +<body onload="restore_options()"> + +Favorite Color: +<select id="color"> + <option value="red">red</option> + <option value="green">green</option> + <option value="blue">blue</option> + <option value="yellow">yellow</option> +</select> + +<br> +<button onclick="save_options()">Save</button> +</body> +</html> +</pre> + +<a name="H2-2"></a><h2>Important Notes</h2> +<ul> +<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> +<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> +</ul> +</div> + + <!-- API PAGE --> + <div class="apiPage" style="display: none; "> + <a name="apiReference"></a> + <h2>API reference: chrome.apiname </h2> + + <!-- PROPERTIES --> + <div class="apiGroup"> + <a name="properties"></a> + <h3 id="properties">Properties</h3> + + <div> + <a></a> + <h4>getLastError</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.extension</span><span>lastError</span> + </div> + <div> + </div> + </div> + + </div> <!-- /apiGroup --> + + <!-- METHODS --> + <div class="apiGroup" id="methods"> + <a name="methods"></a> + <h3>Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a></a> <!-- method-anchor --> + <h4>method name</h4> + + <div class="summary"><span>void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.module.methodName</span>(<span><span>, </span><span></span> + <var><span></span></var></span>)</div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the function goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4>Returns</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + If you specify the <em>callback</em> parameter, + it should specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + </div> + + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div class="apiGroup"> + <a name="events"></a> + <h3 id="events">Events</h3> + + <!-- iterates over all events --> + <div class="apiItem"> + <a></a> + <h4>event name</h4> + + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <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>); + </div> + + <div class="description"> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the event goes here. + </p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + + </div> <!-- /decription --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- TYPES --> + <div class="apiGroup"> + <a name="types.sort(sortByName)"></a> + <h3 id="types">Types</h3> + + <!-- iterates over all types --> + <div class="apiItem"> + <a></a> + <h4>type name</h4> + + <div> + </div> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + </div> <!-- /apiPage --> + </div> <!-- /mainColumn --> + </div> <!-- /pageContent --> + <div id="pageFooter" --=""> + <p> + Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, + the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons + Attribution 3.0 License</a>, and code samples are licensed under the + <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. + </p> + <p> + ©2009 Google + </p> + +<!-- begin analytics --> +<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> +<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> + +<script type="text/javascript"> + // chrome doc tracking + try { + var engdocs = _gat._getTracker("YT-10763712-2"); + engdocs._trackPageview(); + } catch(err) {} + + // code.google.com site-wide tracking + try { + _uacct="UA-18071-1"; + _uanchor=1; + _uff=0; + urchinTracker(); + } + catch(e) {/* urchinTracker not available. */} +</script> +<!-- end analytics --> + + </div> <!-- /pageFooter --> + </div> <!-- /container --> +</body></html> + diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html index 13044c8..506c6f9 100644 --- a/chrome/common/extensions/docs/overview.html +++ b/chrome/common/extensions/docs/overview.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/packaging.html b/chrome/common/extensions/docs/packaging.html index 561db61..777d6fb 100644 --- a/chrome/common/extensions/docs/packaging.html +++ b/chrome/common/extensions/docs/packaging.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/pageAction.html b/chrome/common/extensions/docs/pageAction.html index 9f03942..38d0133 100644 --- a/chrome/common/extensions/docs/pageAction.html +++ b/chrome/common/extensions/docs/pageAction.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/static/manifest.html b/chrome/common/extensions/docs/static/manifest.html index 5da0125..dfb5619 100644 --- a/chrome/common/extensions/docs/static/manifest.html +++ b/chrome/common/extensions/docs/static/manifest.html @@ -34,7 +34,8 @@ are <b>name</b> and <b>version</b>. "<a href="#permissions">permissions</a>": [...], "<a href="npapi.html">plugins</a>": [...], "<a href="themes.html">theme</a>": {...}, - "<a href="toolstrip.html">toolstrips</a>": [...] + "<a href="toolstrip.html">toolstrips</a>": [...], + "<a href="options.html">options_page</a>": "<em>aFile</em>.html", } </pre> diff --git a/chrome/common/extensions/docs/static/options.html b/chrome/common/extensions/docs/static/options.html new file mode 100644 index 0000000..1c355d6 --- /dev/null +++ b/chrome/common/extensions/docs/static/options.html @@ -0,0 +1,77 @@ +<div id="pageData-title" class="pageData">Options</div> +<div id="pageData-showTOC" class="pageData">true</div> +<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 on this link will open a new tab pointing at your options page. + +<h2>Step 1: Declare your options page in the manifest</h2> + +<pre>{ + "name": "Test Extension", + "version": "1.0", + "description": "This is a test", + <b>"options_page": "options.html"</b> +} +</pre> + + +<h2>Step 2: Write your options page</h2> + +Here is an example options page: + +<pre> +<html> +<head><title>My Test Extension Options</title></head> +<script type="text/javascript"> + +// Saves options to localStorage. +function save_options() { + var select = document.getElementById("color"); + var color = select.children[select.selectedIndex].value; + localStorage["favorite_color"] = color; + + // Update status to let user know options were saved. + var status = document.getElementById("status"); + status.innerHTML = "Options Saved."; + setTimeout(function() { + status.innerHTML = ""; + }, 750); +} + +// Restores select box state to saved value from localStorage. +function restore_options() { + var favorite = localStorage["favorite_color"]; + if (!favorite) { + return; + } + var select = document.getElementById("color"); + for (var i = 0; i < select.children.length; i++) { + var child = select.children[i]; + if (child.value == favorite) { + child.selected = "true"; + break; + } + } +} + +</script> + +<body onload="restore_options()"> + +Favorite Color: +<select id="color"> + <option value="red">red</option> + <option value="green">green</option> + <option value="blue">blue</option> + <option value="yellow">yellow</option> +</select> + +<br> +<button onclick="save_options()">Save</button> +</body> +</html> +</pre> + +<h2>Important Notes</h2> +<ul> +<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> +<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> +</ul> diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index f750203..eb765ae 100644 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li class="leftNavSelected">Tabs</li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index e132446..c86c577 100644 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -96,6 +96,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/test.html b/chrome/common/extensions/docs/test.html index 33dad38..06321c7 100644 --- a/chrome/common/extensions/docs/test.html +++ b/chrome/common/extensions/docs/test.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/themes.html b/chrome/common/extensions/docs/themes.html index 6bb0258..8a5bb9d 100644 --- a/chrome/common/extensions/docs/themes.html +++ b/chrome/common/extensions/docs/themes.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/toolstrip.html b/chrome/common/extensions/docs/toolstrip.html index b44ae0b..bafa12f 100644 --- a/chrome/common/extensions/docs/toolstrip.html +++ b/chrome/common/extensions/docs/toolstrip.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/tut_debugging.html b/chrome/common/extensions/docs/tut_debugging.html index fcde9e9..c63e829 100644 --- a/chrome/common/extensions/docs/tut_debugging.html +++ b/chrome/common/extensions/docs/tut_debugging.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/tutorials.html b/chrome/common/extensions/docs/tutorials.html index ef3dcac..779a46b 100644 --- a/chrome/common/extensions/docs/tutorials.html +++ b/chrome/common/extensions/docs/tutorials.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> diff --git a/chrome/common/extensions/docs/windows.html b/chrome/common/extensions/docs/windows.html index 99b676c..a6f4793 100644 --- a/chrome/common/extensions/docs/windows.html +++ b/chrome/common/extensions/docs/windows.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li class="leftNavSelected">Windows</li> </ul> diff --git a/chrome/common/extensions/docs/xhr.html b/chrome/common/extensions/docs/xhr.html index 583bef9..0dda814 100644 --- a/chrome/common/extensions/docs/xhr.html +++ b/chrome/common/extensions/docs/xhr.html @@ -112,6 +112,7 @@ <ul> <li><a href="bookmarks.html">Bookmarks</a></li> <li><a href="events.html">Events</a></li> + <li><a href="options.html">Options Page</a></li> <li><a href="tabs.html">Tabs</a></li> <li><a href="windows.html">Windows</a></li> </ul> |