1
|
<!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. 2) The <body> tag *must* retain id="body" 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. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">Getting Started</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">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" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="pageTitle" jstcache="1">Getting Started</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a></li> <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li> <li jstcache="0"><a href="pageActions.html" jstcache="0">Page actions</a></li> <li jstcache="0"><a href="background_pages.html" jstcache="0">Background pages</a></li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a></li> <li jstcache="0"><a href="extension.html" jstcache="0">Extension</a></li> <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="self.html" jstcache="0">Self</a></li> <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0"><a href="autoupdate.html" jstcache="0">Autoupdate</a></li> </ul> </li> <li jstcache="0">Samples <ul jstcache="0"> <li jstcache="0">[sample 1]</li> <li jstcache="0">[sample 2]</li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="2" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="18">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="19">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Getting Started</div> <p jstcache="0"> This tutorial walks you through creating a simple extension. To complete this tutorial, you must have Windows; Linux and Mac don't yet support extensions. </p> <h2 id="browser" jstcache="0">Get your browser ready</h2> <p jstcache="0"> To develop extensions for Google Chrome, you need to set up your browser: </p> <ol jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/getting-involved/dev-channel" jstcache="0">Subscribe to the Dev channel</a> of Google Chrome for Windows. </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Create a separate profile</a> for testing <em jstcache="0">(optional but highly recommended)</em>. Having a testing profile means that you can use Google Chrome (with your default profile) for everyday browsing, even if your extension has horrible bugs.</li> </ol> <h2 id="load" jstcache="0">Create and load an extension</h2> <p jstcache="0"> In this section, you'll write a <em jstcache="0">toolstrip</em> — an extension that puts a bit of UI into the <em jstcache="0">toolbar</em> at the bottom of the Google Chrome window. </p> <ol jstcache="0"> <li jstcache="0"> Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at <strong jstcache="0"><code jstcache="0">c:\myext</code></strong>, but it can be anywhere. </li> <li jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">manifest.json</code></strong>, and put this in it: <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }</pre> </li> <li jstcache="0"> In the same folder, create a text file called <strong jstcache="0"><code jstcache="0">my_toolstrip.html</code></strong>, and put this in it: <pre jstcache="0"><div class="toolstrip-button"> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Load the extension: <ol type="a" jstcache="0"> <li jstcache="0"> Change the shortcut that you use to start the browser (or create a new one) so that it has the <code jstcache="0">--enable-extensions</code> and <code jstcache="0">--load-extension</code> flags. For example, if your extension is at <code jstcache="0">c:\myext</code>, your shortcut might look something like this: <pre jstcache="0">chrome.exe <span class="newCode" jstcache="0">--enable-extensions --load-extension="c:\myext"</span></pre> </li> <li jstcache="0">Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile. </li> <li jstcache="0">Double-click the shortcut to start the browser.</li> </ol> <p jstcache="0"> <b jstcache="0">Note:</b> For details on changing shortcut properties, see <a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Creating and Using Profiles</a>.</p> </li> </ol> <p jstcache="0"> You should see the UI for your extension at the bottom left of the browser, looking something like this: </p> <table jstcache="0"> <tbody jstcache="0"> <tr jstcache="0"> <td align="center" width="33%" jstcache="0"><img src="images/hw-1.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-2.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-3.gif" alt="" jstcache="0"></td> </tr> <tr jstcache="0"> <th align="center" width="33%" jstcache="0"> default appearance</th> <th align="center" width="33%" jstcache="0"> initial onhover appearance</th> <th align="center" width="33%" jstcache="0"> final onhover appearance</th> </tr> </tbody> </table> <p jstcache="0"> Your extension's button is automatically styled to look like it belongs in the browser. If you put the cursor over the button, the button gets a nice, rounded edge, just like the buttons in the bookmark bar. After a while, a tooltip comes up, identifying the extension. </p> <p jstcache="0"> [PENDING: troubleshooting info should go here. what are symptoms of common typos, including misnamed files? what are the symptoms if you don't have the dev channel?] </p> <h2 id="code" jstcache="0">Add code to the extension</h2> <p jstcache="0"> In this step, you'll make your extension <em jstcache="0">do</em> something besides just look good. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">hello_world.html</code></strong>, and add the following code to it:</p> <blockquote jstcache="0"> <a href="samples/hello_world.txt" jstcache="0">CSS and JavaScript code for hello_world</a></blockquote> </li> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><div class="toolstrip-button"<span class="newCode" jstcache="0"> onclick="window.open('hello_world.html')"</span>> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Restart the browser to load the new version of the extension.</li> <li jstcache="0">Click the button. A window should come up that displays <code jstcache="0">hello_world.html</code>. </li> </ol> <p jstcache="0"> It should look something like this:</p> <img src="images/hello_world-page.gif" alt="a window with a grid of images related to HELLO WORLD" jstcache="0"> <p jstcache="0"> If you don't see that page, try the instructions again, following them exactly. Don't try loading an HTML file that isn't in the extension's folder — it won't work! </p> <h2 id="debug" jstcache="0">Debug the extension</h2> <p jstcache="0"> You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><span class="newCode" jstcache="0"><script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script></span> <div class="toolstrip-button" onclick="<span class="newCode" jstcache="0">helloWorld();</span>"> <span>Hello, World!</span> </div></pre> <p jstcache="0"> The relocated code still has the same effect, but now it has some debugging output, thanks to the call to <code jstcache="0">console.log()</code>.</p> </li> <li jstcache="0"> Restart the browser, so that it loads your new version of the extension. <!-- This might be confusing. Maybe we should instead cover location.reload() later, after we've shown the console. <div class="note"> <b>Tip:</b> If you don't want to restart your browser, you can get an updated version of the extension by opening a new window. The new window will contain the updated extension; old windows will contain the old version. </div> --> </li> <li jstcache="0"> Right-click the <strong jstcache="0">Hello, World!</strong> button (at the bottom left) to bring up the Developer Tools window for this instance of your toolstrip. The window should look something like this: <p jstcache="0"> <img src="images/devtools-1.gif" alt="" jstcache="0"> </p> <!-- Possibly we should recommend starting the Dev Tools using chrome://extensions, rather than right-click. However, that adds some stuff (such as id) that might be confusing. --> </li> <li jstcache="0"> Click the <strong jstcache="0">Scripts</strong> button. If necessary, choose <strong jstcache="0">my_toolstrip.html</strong> from the list of scripts. The result should be something like this: <p jstcache="0"> <img src="images/devtools-2.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Set a debugging breakpoint at the <code jstcache="0">window.open()</code> statement by clicking <strong jstcache="0">5</strong> in the left column: <p jstcache="0"> <img src="images/devtools-3.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the Console button (second from left, at the bottom of the Developer Tools window) so that you can see both the code and the console. <p jstcache="0"> <img src="images/devtools-4.gif" alt="" jstcache="0"></p> </li> <li jstcache="0"> Back in the main browser window, click the <strong jstcache="0">Hello, World!</strong> button, so that the extension begins executing. You should see the output of <code jstcache="0">console.log()</code> along with the line number, and execution should stop just before the call to <code jstcache="0">window.open()</code>. <p jstcache="0"> <img src="images/devtools-5.gif" alt="" jstcache="0"> </p> <p jstcache="0"> The Call Stack area at the right of the tools window shows that the <code jstcache="0">helloWorld()</code> method was called by an anonymous function that was called by <code jstcache="0">onclick</code>. Anywhere in the Call Stack or console that you see a file and line number (for example, "my_toolstrip.html:4"), you can click that text to see the relevant line of code. </p> </li> <li jstcache="0"> In the upper right part of the tools window, scroll down (if necessary) until you can see the local scope variables. This section shows the current values of all variables in the current scope. For example, you can see that <code jstcache="0">hwFile</code> is a local variable that has the value "hello_world.html". <p jstcache="0"> <img src="images/devtools-6.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to <code jstcache="0">window.open()</code> returns, the main browser window should open a new tab that displays the contents of <code jstcache="0">hello_world.html</code>.</li> </ol> <p jstcache="0"> You now know how to load and debug an extension!</p> <h2 id="summary" jstcache="0">Summary</h2> <p jstcache="0"> [PENDING: Summarize what we did, what it means, what else we would've done if this were a real extension (e.g. package it), and where to find more information. Suggest where to go next.]</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="2" style="display: none; "> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="3"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="20">, </span><span jscontent="typeName" jstcache="21"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="29">optional </span><span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="26"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="29">optional </span><span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="26"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="29">optional </span><span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="27">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="28"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="26"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="29">optional </span><span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.length > 0" class="apiGroup" id="events" jstcache="4"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="22"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="26"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="29">optional </span><span jscontent="typeName" jstcache="21">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="24"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="25"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
|
