| OLD | NEW |
|---|
| 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 mecha
nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener
eated 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>.innerHTM
L is also generated by an offline step so that this page may easily be indexed b
y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t
he single version of page template shell and the "instance" pages (bookmarks.htm
l, etc...) can be generated with a build step. --><!-- <html> must retain id="te
mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da
ta 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="getPageTitle()" jstcache="1">Google Chrome Extensions: Dev
eloper Documentation</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 t
ype="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="searc
hbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box"
jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="00296767
0403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="U
TF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input t
ype="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type=
"text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <scri
pt type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "
transliteration"});</script> <script type="text/javascript" src="http://www.goog
le.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></scrip
t> <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" j
stcache="0"> <h1 jscontent="getPageTitle()" jstcache="1">Google Chrome Extension
s: Developer Documentation</h1> </div> </div> <!-- /pageHeader --> <div id="page
Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc
ache="0"> <li jstcache="0" class="leftNavSelected">Home </li> <li jstcache="0">
<a href="getstarted.html" jstcache="0">Getting Started</a></li> <li jstcache="0"
> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a hr
ef="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a> <u
l jstcache="0"> <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrip
s</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">Backgrou
nd Pages</a></li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">C
ontent Scripts</a></li> <li jstcache="0">Events</li> <li jstcache="0"><a href="t
abs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="windows.html" jst
cache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.html" jstcache="0
">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache="0"><a href="npap
i.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a href="packaging.
html" jstcache="0">Packaging</a></li> <li jstcache="0">Autoupdate</li> </ul> </l
i> <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tuto
rials</div></a> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html"
jstcache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstca
che="0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="m
anifest.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">Match Patter
ns</li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a h
ref="api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0"> <a h
ref="api_other.html" jstcache="0">Other APIs</a> </li> </ul> </li> <li jstcache=
"0"><a href="http://dev.chromium.org/developers/design-documents/extensions/samp
les" jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0
"> <!-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcache="
2" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li j
sselect="getStaticTOC()" jstcache="9"> <a jscontent="name" jsvalues=".href:'#' +
href" jstcache="14">h2Name</a> <ol jstcache="0"> <li jsselect="$this.children"
jstcache="22"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3N
ame</a> </li> </ol> </li> <div jsselect="apiDefinition" jstcache="3"> <li jstcac
he="0"> <a href="#apiReference" jscontent="'API reference: ' + getModuleName()"
jstcache="4">API reference</a> <ol jstcache="0"> <li jsdisplay="$this.properties
" jstcache="5"> <a href="#properties" jstcache="0">Properties</a> <ol jstcache="
0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jscontent=
"name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="41
">propertyName</a> </li> </ol> </li> <li jsdisplay="functions && functio
ns.length > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol
jstcache="0"> <li jsselect="functions" jstcache="11"> <a jscontent="name" jsvalu
es=".href:'#method-' + name" href="#method-anchor" jstcache="42">methodName</a>
</li> </ol> </li> <li jsdisplay="events && events.length > 0" jstcach
e="7"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect=
"events" jstcache="12"> <a jscontent="name" jsvalues=".href:'#event-' + name" hr
ef="#event-anchor" jstcache="43">eventName</a> </li> </ol> </li> <li jsdisplay="
types && types.length > 0" jstcache="8"> <a href="#types" jstcache="0
">Types</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="
id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li>
</ol> </li> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STA
TIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><style jstcache="0"> #
pics { margin:2em 1em 1.5em; } #pics td { text-align:center; width:33%!important
; border:none; padding:1em; font-size:90%; } #pics img { width:180px; height:85p
x; border:1px solid black; } </style> <div id="pageData-title" class="pageData"
jstcache="0">Google Chrome Extensions: Developer Documentation</div> <h3 jstcach
e="0">Hello There!</h3> <p jstcache="0"> <em jstcache="0">Extensions</em> are sm
all software programs that can modify and enhance the functionality of Google Ch
rome. </p> <p jstcache="0"> You write them using web technologies like HTML, Jav
aScript, and CSS. So if you know how to write web pages, you already know most o
f what you need to know to write extensions. </p> <p jstcache="0"> Here are some
examples of what you can build with extensions: </p> <table id="pics" jstcache=
"0"> <tbody jstcache="0"><tr jstcache="0"> <td valign="top" jstcache="0"> <b jst
cache="0">Toolstrips</b><br jstcache="0"> <img src="images/index/toolstrip.png"
jstcache="0"><br jstcache="0"> Display small toolbars in Google Chrome's chrome.
</td> <td valign="top" jstcache="0"> <b jstcache="0">Page actions</b><br jstcac
he="0"> <img src="images/index/page_action.png" jstcache="0"><br jstcache="0"> A
dd buttons to the Omnibox that get displayed for specific pages. </td> <td valig
n="top" jstcache="0"> <b jstcache="0">Content scripts</b><br jstcache="0"> <img
src="images/index/content_script.png" jstcache="0"><br jstcache="0"> Modify the
look and behavior of web pages. </td> </tr> </tbody></table> <p jstcache="0"> Th
is website contains all the information you need to build extensions. Start with
one of these sections: </p> <ul jstcache="0"> <li jstcache="0"> <a href="getsta
rted.html" jstcache="0">Getting Started</a>: Build a simple "Hello, World" exten
sion in about 5 minutes. </li> <li jstcache="0"> <a href="overview.html" jstcach
e="0">Overview</a>: Learn about the fundamental design points of Google Chrome's
extension system. </li> <li jstcache="0"> <a href="devguide.html" jstcache="0">
Developer's Guide</a>: Get detailed information on using each feature and API. <
/li> </ul> <p jstcache="0"> Also check out the discussion group: <a href="http:/
/groups.google.com/group/chromium-extensions" jstcache="0">chromium-extensions</
a>. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" j
stcache="3" style="display: none; "> <a name="apiReference" jstcache="0"></a> <h
2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: ch
rome.apiname </h2> <!-- PROPERTIES --> <div jsdisplay="$this.properties" class="
apiGroup" jstcache="5"> <a name="properties" jstcache="0"></a> <h3 id="propertie
s" jstcache="0">Properties</h3> <div jsselect="getPropertyListFromObject($this)"
jstcache="10"> <a jsvalues=".name:'property-' + name" jstcache="15"></a> <h4 js
content="name" jstcache="16">getLastError</h4> <div class="summary" jstcache="0"
> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName(
) + '.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstca
che="24">lastError</span> </div> <div transclude="valueTemplate" jstcache="17">
</div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functio
ns && functions.length > 0" class="apiGroup" id="methods" jstcache="6
"> <a name="methods" jstcache="0"></a> <h3 jstcache="0">Methods</h3> <!-- iterat
es over all functions --> <div class="apiItem" jsselect="functions" jstcache="11
"> <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- method-anchor --
> <h4 jscontent="name" jstcache="16">method name</h4> <div class="summary" jstca
che="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25"
>void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="get
FullyQualifiedFunctionName($this)" jstcache="26">chrome.module.methodName</span>
(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcach
e="27"><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeN
ame($this)" jstcache="34"></span> <var jstcache="0"><span jscontent="name" jstca
che="16"></span></var></span>)</div> <div class="description" jstcache="0"> <p c
lass="todo" jsdisplay="!description" jstcache="28">Undocumented.</p> <p jsdispla
y="description" jsvalues=".innerHTML:description" jstcache="29"> A description f
rom the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4
jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcac
he="35"> <!-- VALUE: This is a subtemplate that is used elsewhere via jsTemplate
*transclude* --> <div id="valueTemplate" jstcache="0"> <dt jstcache="0"> <var j
sdisplay="$this.name" jscontent="$this.name" jstcache="45">paramName</var> <em j
stcache="0"> <!-- TYPE --> <div style="display:inline" jstcache="0"> ( <span cla
ss="optional" jsdisplay="optional" jstcache="46">optional</span> <span id="typeT
emplate" jstcache="0"> <span jsdisplay="getTypeRef($this)" jstcache="47"> <a jsv
alues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="g
etTypeRef($this)" jstcache="49"> Type</a> </span> <span jsdisplay="!getTypeRef($
this)" jstcache="48"> <span jsdisplay="isArray($this)" jstcache="50"> array of <
span jsselect="items" jstcache="52"><span transclude="typeTemplate" jstcache="53
"></span></span> </span> <span jsdisplay="!isArray($this)" jscontent="getTypeNam
e($this)" jstcache="51">paramType</span> </span> </span> ) </div> </em> </dt> <d
d class="todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd>
<dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstca
che="39"> Description of this parameter from the json schema. </dd> <!-- OBJECT
PROPERTIES --> <dd jsdisplay="shouldExpandObject($this)" jstcache="40"> <dl jstc
ache="0"> <div jsselect="getPropertyListFromObject($this)" jstcache="10"> <div t
ransclude="valueTemplate" jstcache="17"> </div> </div> </dl> </dd> </div> <!-- /
VALUE --> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="30">Re
turns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="36"> <div transcl
ude="valueTemplate" jstcache="17"> </div> </div> </dl> <!-- CALLBACK -->
<div jsdisplay="hasCallback(parameters)" jstcache="31"> <div jsselect="getCallb
ackParameters(parameters)" jstcache="37"> <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="getSignatureS
tring(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="s
ubdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="param
eters" jstcache="35"> <div transclude="valueTemplate" jstcache="17"> </div> </di
v> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </d
iv> <!-- /apiGroup --> <!-- EVENTS --> <div jsdisplay="events && events.
length > 0" class="apiGroup" jstcache="7"> <a name="events" jstcache="0"></a>
<h3 id="events" jstcache="0">Events</h3> <!-- iterates over all events --> <div
jsselect="events" class="apiItem" jstcache="12"> <a jsvalues=".name:'event-' +
name" jstcache="19"></a> <h4 jscontent="name" jstcache="16">event name</h4> <div
class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <s
pan jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.bookm
arks</span><span jscontent="name" jstcache="16">onEvent</span><span class="subdu
ed" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureStrin
g(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdu
ed" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p
class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p> <p jsdisp
lay="description" jsvalues=".innerHTML:description" jstcache="29"> A description
from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 j
stcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcach
e="35"> <div transclude="valueTemplate" jstcache="17"> </div> </div> </dl> </div
> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- T
YPES --> <div jsdisplay="types && types.length > 0" class="apiGroup"
jstcache="8"> <a name="types" jstcache="0"></a> <h3 id="types" jstcache="0">Type
s</h3> <!-- iterates over all types --> <div jsselect="types" class="apiItem" js
tcache="13"> <a jsvalues=".name:'type-' + id" jstcache="20"></a> <h4 jscontent="
id" jstcache="21">type name</h4> <div transclude="valueTemplate" jstcache="17">
</div> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage -
-> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter"
--="" jstcache="0"> <p jstcache="0"> Except as otherwise <a href="http://code.g
oogle.com/policies.html#restrictions" jstcache="0">noted</a>, the content of thi
s page is licensed under the <a rel="license" href="http://creativecommons.org/l
icenses/by/3.0/" jstcache="0">Creative Commons Attribution 3.0 License</a>, and
code samples are licensed under the <a rel="license" href="http://code.google.co
m/google_bsd_license.html" jstcache="0">BSD License</a>. </p> <p jstcache="0"> ©
2009 Google </p> </div> <!-- /pageFooter --> </div> <!-- /container --> </body><
/html> | 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 2) The <body> tag *must* retain id="body" |
| 6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
| 7 browser, it will be re-generated from the template, json schema and |
| 8 authored overview content. |
| 9 4) The <body>.innerHTML is also generated by an offline step so that this |
| 10 page may easily be indexed by search engines. |
| 11 |
| 12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single |
| 13 version of page template shell and the "instance" pages (bookmarks.html, |
| 14 etc...) can be generated with a build step. |
| 15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x
html" jstcache="0"><!-- <head> data is significant and loads the needed librarie
s and styles --><head jstcache="0"> |
| 16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=
"0"> |
| 17 <title jscontent="getPageTitle()" jstcache="1">Google Chrome Extensions: Dev
eloper Documentation</title> |
| 18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache=
"0"> |
| 19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js" jstcache="0"> |
| 20 </script> |
| 21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"><
/script> |
| 22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> |
| 23 </head><!-- <body> content is completely generated. Do not edit, as it will be |
| 24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> |
| 25 <a name="top" jstcache="0"> </a> |
| 26 <!-- API HEADER --> |
| 27 <div id="pageHeader" jstcache="0"> |
| 28 <div id="searchbox" jstcache="0"> |
| 29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0
"> |
| 30 <div jstcache="0"> |
| 31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq
tno" jstcache="0"> |
| 32 <input type="hidden" name="ie" value="UTF-8" jstcache="0"> |
| 33 <input type="text" name="q" size="31" jstcache="0"> |
| 34 <input type="submit" name="sa" value="Search" jstcache="0"> |
| 35 </div> |
| 36 </form> |
| 37 |
| 38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach
e="0"></script> |
| 39 <script type="text/javascript" jstcache="0">google.load("elements", "1",
{packages: "transliteration"});</script> |
| 40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?
form=cse-search-box&t13n_langs=en" jstcache="0"></script> |
| 41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand
?form=cse-search-box&lang=en" jstcache="0"></script> |
| 42 </div> |
| 43 <div id="pageTitle" jstcache="0"> |
| 44 <h1 jscontent="getPageTitle()" jstcache="1">Google Chrome Extensions: De
veloper Documentation</h1> |
| 45 </div> |
| 46 </div> <!-- /pageHeader --> |
| 47 |
| 48 <div id="pageContent" jstcache="0"> |
| 49 <!-- SIDENAV --> |
| 50 <div id="leftNav" jstcache="0"> |
| 51 <ul jstcache="0"> |
| 52 <li jstcache="0" class="leftNavSelected">Home </li> |
| 53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start
ed</a></li> |
| 54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l
i> |
| 55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="
0">Developer's Guide</div></a> |
| 56 <ul jstcache="0"> |
| 57 <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips<
/a></li> |
| 58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti
ons</a></li> |
| 59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back
ground Pages</a></li> |
| 60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte
nt Scripts</a></li> |
| 61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li
> |
| 62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li> |
| 63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></
li> |
| 64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</
a></li> |
| 65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li
> |
| 66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</
a></li> |
| 67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</
a></li> |
| 68 <li jstcache="0">Autoupdate</li> |
| 69 </ul> |
| 70 </li> |
| 71 <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="
0">Tutorials</div></a> |
| 72 <ul jstcache="0"> |
| 73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi
ng</a></li> |
| 74 </ul> |
| 75 </li> |
| 76 <li jstcache="0">Reference |
| 77 <ul jstcache="0"> |
| 78 <li jstcache="0"> Formats |
| 79 <ul jstcache="0"> |
| 80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest
Files</a></li> |
| 81 <li jstcache="0"><a href="match_patterns.html" jstcache="0">Ma
tch Patterns</a></li> |
| 82 <li jstcache="0">Packages (.crx)</li> |
| 83 </ul> |
| 84 </li> |
| 85 <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* A
PIs</a> </li> |
| 86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs
</a> </li> |
| 87 </ul> |
| 88 </li> |
| 89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc
uments/extensions/samples" jstcache="0">Samples</a></li> |
| 90 </ul> |
| 91 </div> |
| 92 |
| 93 <div id="mainColumn" jstcache="0"> |
| 94 <!-- TABLE OF CONTENTS --> |
| 95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: non
e; "> |
| 96 <p jstcache="0">Contents</p> |
| 97 <ol jstcache="0"> |
| 98 <li jsselect="getStaticTOC()" jstcache="9"> |
| 99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Na
me</a> |
| 100 <ol jstcache="0"> |
| 101 <li jsselect="$this.children" jstcache="22"> |
| 102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">
h3Name</a> |
| 103 </li> |
| 104 </ol> |
| 105 </li> |
| 106 <div jsselect="apiDefinition" jstcache="3"> |
| 107 <li jstcache="0"> |
| 108 <a href="#apiReference" jscontent="'API reference: ' + getModule
Name()" jstcache="4">API reference</a> |
| 109 <ol jstcache="0"> |
| 110 <li jsdisplay="$this.properties" jstcache="5"> |
| 111 <a href="#properties" jstcache="0">Properties</a> |
| 112 <ol jstcache="0"> |
| 113 <li jsselect="getPropertyListFromObject($this)" jstcache="
10"> |
| 114 <a jscontent="name" jsvalues=".href:'#property-' + name"
href="#property-anchor" jstcache="42">propertyName</a> |
| 115 </li> |
| 116 </ol> |
| 117 </li> |
| 118 <li jsdisplay="functions && functions.length > 0" j
stcache="6"> |
| 119 <a href="#methods" jstcache="0">Methods</a> |
| 120 <ol jstcache="0"> |
| 121 <li jsselect="functions.sort(sortByName)" jstcache="11"> |
| 122 <a jscontent="name" jsvalues=".href:'#method-' + name" h
ref="#method-anchor" jstcache="43">methodName</a> |
| 123 </li> |
| 124 </ol> |
| 125 </li> |
| 126 <li jsdisplay="events && events.length > 0" jstcach
e="7"> |
| 127 <a href="#events" jstcache="0">Events</a> |
| 128 <ol jstcache="0"> |
| 129 <li jsselect="events.sort(sortByName)" jstcache="12"> |
| 130 <a jscontent="name" jsvalues=".href:'#event-' + name" hr
ef="#event-anchor" jstcache="44">eventName</a> |
| 131 </li> |
| 132 </ol> |
| 133 </li> |
| 134 <li jsdisplay="types && types.length > 0" jstcache=
"8"> |
| 135 <a href="#types" jstcache="0">Types</a> |
| 136 <ol jstcache="0"> |
| 137 <li jsselect="types.sort(sortByName)" jstcache="38"> |
| 138 <a jscontent="id" jsvalues=".href:'#type-' + id" href="#
id-anchor" jstcache="45">id</a> |
| 139 </li> |
| 140 </ol> |
| 141 </li> |
| 142 </ol> |
| 143 </li> |
| 144 </div> |
| 145 </ol> |
| 146 </div> |
| 147 <!-- /TABLE OF CONTENTS --> |
| 148 |
| 149 <!-- STATIC CONTENT PLACEHOLDER --> |
| 150 <div id="static" jstcache="0"><style jstcache="0"> |
| 151 #pics { |
| 152 margin:2em 1em 1.5em; |
| 153 } |
| 154 |
| 155 #pics td { |
| 156 text-align:center; |
| 157 width:33%!important; |
| 158 border:none; |
| 159 padding:1em; |
| 160 font-size:90%; |
| 161 } |
| 162 |
| 163 #pics img { |
| 164 width:180px; |
| 165 height:85px; |
| 166 border:1px solid black; |
| 167 } |
| 168 </style> |
| 169 |
| 170 <div id="pageData-title" class="pageData" jstcache="0">Google Chrome Extensions:
Developer Documentation</div> |
| 171 |
| 172 <h3 jstcache="0">Hello There!</h3> |
| 173 |
| 174 <p jstcache="0"> |
| 175 <em jstcache="0">Extensions</em> are small software programs |
| 176 that can modify and enhance the functionality of Google Chrome. |
| 177 </p> |
| 178 |
| 179 <p jstcache="0"> |
| 180 You write them using web technologies like |
| 181 HTML, JavaScript, and CSS. |
| 182 So if you know how to write web pages, |
| 183 you already know most of what |
| 184 you need to know to write extensions. |
| 185 </p> |
| 186 |
| 187 <p jstcache="0"> |
| 188 Here are some examples of what you can build with extensions: |
| 189 </p> |
| 190 |
| 191 <table id="pics" jstcache="0"> |
| 192 <tbody jstcache="0"><tr jstcache="0"> |
| 193 <td valign="top" jstcache="0"> |
| 194 <b jstcache="0">Toolstrips</b><br jstcache="0"> |
| 195 <a href="toolstrip.html" jstcache="0"><img src="images/index/toolstrip.png
" jstcache="0"></a> |
| 196 <br jstcache="0"> |
| 197 Display small toolbars in Google Chrome's chrome |
| 198 </td> |
| 199 <td valign="top" jstcache="0"> |
| 200 <b jstcache="0">Page actions</b><br jstcache="0"> |
| 201 <a href="pageActions.html" jstcache="0"><img src="images/index/page_action
.png" jstcache="0"></a> |
| 202 <br jstcache="0"> |
| 203 Add buttons to the Omnibox that get displayed for specific pages |
| 204 </td> |
| 205 <td valign="top" jstcache="0"> |
| 206 <b jstcache="0">Content scripts</b><br jstcache="0"> |
| 207 <a href="content_scripts.html" jstcache="0"><img src="images/index/content
_script.png" jstcache="0"></a> |
| 208 <br jstcache="0"> |
| 209 Modify the look and behavior of web pages |
| 210 </td> |
| 211 </tr> |
| 212 </tbody></table> |
| 213 |
| 214 <p jstcache="0"> |
| 215 This website contains all the information |
| 216 you need to build extensions. |
| 217 Start with one of these sections: |
| 218 </p> |
| 219 |
| 220 <ul jstcache="0"> |
| 221 <li jstcache="0"> |
| 222 <a href="getstarted.html" jstcache="0">Getting Started</a>: |
| 223 Build a simple "Hello, World" extension in about 5 minutes |
| 224 </li> |
| 225 <li jstcache="0"> |
| 226 <a href="overview.html" jstcache="0">Overview</a>: |
| 227 Learn about the fundamental design points of |
| 228 Google Chrome's extension system |
| 229 </li> |
| 230 <li jstcache="0"> |
| 231 <a href="devguide.html" jstcache="0">Developer's Guide</a>: |
| 232 Get detailed information on using each feature and API |
| 233 </li> |
| 234 </ul> |
| 235 |
| 236 <p jstcache="0"> |
| 237 Also check out the discussion group: |
| 238 <a href="http://groups.google.com/group/chromium-extensions" jstcache="0">chromi
um-extensions</a> |
| 239 </p></div> |
| 240 |
| 241 <!-- API PAGE --> |
| 242 <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="displa
y: none; "> |
| 243 <a name="apiReference" jstcache="0"></a> |
| 244 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref
erence: chrome.apiname </h2> |
| 245 |
| 246 <!-- PROPERTIES --> |
| 247 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5"> |
| 248 <a name="properties" jstcache="0"></a> |
| 249 <h3 id="properties" jstcache="0">Properties</h3> |
| 250 |
| 251 <div jsselect="getPropertyListFromObject($this)" jstcache="10"> |
| 252 <a jsvalues=".name:'property-' + name" jstcache="15"></a> |
| 253 <h4 jscontent="name" jstcache="16">getLastError</h4> |
| 254 <div class="summary" jstcache="0"> |
| 255 <!-- Note: intentionally longer 80 columns --> |
| 256 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext
ension</span><span jscontent="$this.name" jstcache="24">lastError</span> |
| 257 </div> |
| 258 <div transclude="valueTemplate" jstcache="17"> |
| 259 </div> |
| 260 </div> |
| 261 |
| 262 </div> <!-- /apiGroup --> |
| 263 |
| 264 <!-- METHODS --> |
| 265 <div jsdisplay="functions && functions.length > 0" class="a
piGroup" id="methods" jstcache="6"> |
| 266 <a name="methods" jstcache="0"></a> |
| 267 <h3 jstcache="0">Methods</h3> |
| 268 |
| 269 <!-- iterates over all functions --> |
| 270 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache=
"11"> |
| 271 <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- metho
d-anchor --> |
| 272 <h4 jscontent="name" jstcache="16">method name</h4> |
| 273 |
| 274 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont
ent="getTypeName(returns)" jstcache="25">void</span> |
| 275 <!-- Note: intentionally longer 80 columns --> |
| 276 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach
e="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="cla
ss:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache="
33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span> |
| 277 <var jstcache="0"><span jscontent="name" jstcache="16"></s
pan></var></span>)</div> |
| 278 |
| 279 <div class="description" jstcache="0"> |
| 280 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen
ted.</p> |
| 281 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29"> |
| 282 A description from the json schema def of the function goes he
re. |
| 283 </p> |
| 284 |
| 285 <!-- PARAMETERS --> |
| 286 <h4 jstcache="0">Parameters</h4> |
| 287 <dl jstcache="0"> |
| 288 <div jsselect="parameters" jstcache="35"> |
| 289 |
| 290 <!-- VALUE: This is a subtemplate that is used elsewhere |
| 291 via jsTemplate *transclude* --> |
| 292 <div id="valueTemplate" jstcache="0"> |
| 293 <dt jstcache="0"> |
| 294 <var jsdisplay="$this.name" jscontent="$this.name" jstca
che="46">paramName</var> |
| 295 <em jstcache="0"> |
| 296 |
| 297 <!-- TYPE --> |
| 298 <div style="display:inline" jstcache="0"> |
| 299 ( |
| 300 <span class="optional" jsdisplay="optional" jstc
ache="47">optional</span> |
| 301 <span id="typeTemplate" jstcache="0"> |
| 302 <span jsdisplay="getTypeRef($this)" jstcache="
48"> |
| 303 <a jsvalues=".href: getTypeRefPage($this) +
'#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type<
/a> |
| 304 </span> |
| 305 <span jsdisplay="!getTypeRef($this)" jstcache=
"49"> |
| 306 <span jsdisplay="isArray($this)" jstcache="5
1"> |
| 307 array of <span jsselect="items" jstcache="
53"><span transclude="typeTemplate" jstcache="54"></span></span> |
| 308 </span> |
| 309 <span jsdisplay="!isArray($this)" jscontent=
"getTypeName($this)" jstcache="52">paramType</span> |
| 310 </span> |
| 311 </span> |
| 312 ) |
| 313 </div> |
| 314 |
| 315 </em> |
| 316 </dt> |
| 317 <dd class="todo" jsdisplay="!$this.description" jstcache="
39"> |
| 318 Undocumented. |
| 319 </dd> |
| 320 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th
is.description" jstcache="40"> |
| 321 Description of this parameter from the json schema. |
| 322 </dd> |
| 323 |
| 324 <!-- OBJECT PROPERTIES --> |
| 325 <dd jsdisplay="shouldExpandObject($this)" jstcache="41"> |
| 326 <dl jstcache="0"> |
| 327 <div jsselect="getPropertyListFromObject($this)" jstca
che="10"> |
| 328 <div transclude="valueTemplate" jstcache="17"> |
| 329 </div> |
| 330 </div> |
| 331 </dl> |
| 332 </dd> |
| 333 </div> <!-- /VALUE --> |
| 334 |
| 335 </div> |
| 336 </dl> |
| 337 |
| 338 <!-- RETURNS --> |
| 339 <h4 jsdisplay="returns" jstcache="30">Returns</h4> |
| 340 <dl jstcache="0"> |
| 341 <div jsselect="returns" jstcache="36"> |
| 342 <div transclude="valueTemplate" jstcache="17"> |
| 343 </div> |
| 344 </div> |
| 345 </dl> |
| 346 |
| 347 <!-- CALLBACK --> |
| 348 <div jsdisplay="hasCallback(parameters)" jstcache="31"> |
| 349 <div jsselect="getCallbackParameters(parameters)" jstcache="37
"> |
| 350 <h4 jstcache="0">Callback function</h4> |
| 351 <p jstcache="0"> |
| 352 If you specify the <em jstcache="0">callback</em> parameter, |
| 353 it should specify a function that looks like this: |
| 354 </p> |
| 355 |
| 356 <!-- Note: intentionally longer 80 columns --> |
| 357 <pre jstcache="0">function(<span jscontent="getSignatureString
(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue
d" jstcache="0">{...}</span>);</pre> |
| 358 <dl jstcache="0"> |
| 359 <div jsselect="parameters" jstcache="35"> |
| 360 <div transclude="valueTemplate" jstcache="17"> |
| 361 </div> |
| 362 </div> |
| 363 </dl> |
| 364 </div> |
| 365 </div> |
| 366 |
| 367 </div> <!-- /description --> |
| 368 |
| 369 </div> <!-- /apiItem --> |
| 370 |
| 371 </div> <!-- /apiGroup --> |
| 372 |
| 373 <!-- EVENTS --> |
| 374 <div jsdisplay="events && events.length > 0" class="apiGrou
p" jstcache="7"> |
| 375 <a name="events" jstcache="0"></a> |
| 376 <h3 id="events" jstcache="0">Events</h3> |
| 377 |
| 378 <!-- iterates over all events --> |
| 379 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12
"> |
| 380 <a jsvalues=".name:'event-' + name" jstcache="19"></a> |
| 381 <h4 jscontent="name" jstcache="16">event name</h4> |
| 382 |
| 383 <div class="summary" jstcache="0"> |
| 384 <!-- Note: intentionally longer 80 columns --> |
| 385 <span jscontent="getModuleName() + '.'" class="subdued" jstcache
="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span>
<span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent=
"getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>)
<span class="subdued" jstcache="0">{...}</span>); |
| 386 </div> |
| 387 |
| 388 <div class="description" jstcache="0"> |
| 389 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen
ted.</p> |
| 390 <p jsdisplay="description" jsvalues=".innerHTML:description" jst
cache="29"> |
| 391 A description from the json schema def of the event goes here. |
| 392 </p> |
| 393 |
| 394 <!-- PARAMETERS --> |
| 395 <h4 jstcache="0">Parameters</h4> |
| 396 <dl jstcache="0"> |
| 397 <div jsselect="parameters" jstcache="35"> |
| 398 <div transclude="valueTemplate" jstcache="17"> |
| 399 </div> |
| 400 </div> |
| 401 </dl> |
| 402 |
| 403 </div> <!-- /decription --> |
| 404 |
| 405 </div> <!-- /apiItem --> |
| 406 |
| 407 </div> <!-- /apiGroup --> |
| 408 |
| 409 <!-- TYPES --> |
| 410 <div jsdisplay="types && types.length > 0" class="apiGroup"
jstcache="8"> |
| 411 <a name="types.sort(sortByName)" jstcache="0"></a> |
| 412 <h3 id="types" jstcache="0">Types</h3> |
| 413 |
| 414 <!-- iterates over all types --> |
| 415 <div jsselect="types" class="apiItem" jstcache="13"> |
| 416 <a jsvalues=".name:'type-' + id" jstcache="20"></a> |
| 417 <h4 jscontent="id" jstcache="21">type name</h4> |
| 418 |
| 419 <div transclude="valueTemplate" jstcache="17"> |
| 420 </div> |
| 421 |
| 422 </div> <!-- /apiItem --> |
| 423 |
| 424 </div> <!-- /apiGroup --> |
| 425 |
| 426 </div> <!-- /apiPage --> |
| 427 </div> <!-- /mainColumn --> |
| 428 </div> <!-- /pageContent --> |
| 429 <div id="pageFooter" --="" jstcache="0"> |
| 430 <p jstcache="0"> |
| 431 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
" jstcache="0">noted</a>, |
| 432 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons |
| 433 Attribution 3.0 License</a>, and code samples are licensed under the |
| 434 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach
e="0">BSD License</a>. |
| 435 </p> |
| 436 <p jstcache="0"> |
| 437 ©2009 Google |
| 438 </p> |
| 439 </div> <!-- /pageFooter --> |
| 440 </div> <!-- /container --> |
| 441 </body></html> |
| 442 #EOF |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 179068:
Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)
