| OLD | NEW |
|---|
| (Empty) |
| 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/jstempla
te_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 <title>New Tab Pages</title></head><body> <div id="container"> | |
| 19 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> | |
| 20 <!-- In particular, sub-templates that recurse, must be used by allowing | |
| 21 jstemplate to make a copy of the template in this section which | |
| 22 are not operated on by way of the jsskip="true" --> | |
| 23 <div style="display:none"> | |
| 24 | |
| 25 <!-- VALUE --> | |
| 26 <div id="valueTemplate"> | |
| 27 <dt> | |
| 28 <var>paramName</var> | |
| 29 <em> | |
| 30 | |
| 31 <!-- TYPE --> | |
| 32 <div style="display:inline"> | |
| 33 ( | |
| 34 <span class="optional">optional</span> | |
| 35 <span id="typeTemplate"> | |
| 36 <span> | |
| 37 <a> Type</a> | |
| 38 </span> | |
| 39 <span> | |
| 40 <span> | |
| 41 array of <span><span></span></span> | |
| 42 </span> | |
| 43 <span>paramType</span> | |
| 44 </span> | |
| 45 </span> | |
| 46 ) | |
| 47 </div> | |
| 48 | |
| 49 </em> | |
| 50 </dt> | |
| 51 <dd class="todo"> | |
| 52 Undocumented. | |
| 53 </dd> | |
| 54 <dd> | |
| 55 Description of this parameter from the json schema. | |
| 56 </dd> | |
| 57 | |
| 58 <!-- OBJECT PROPERTIES --> | |
| 59 <dd> | |
| 60 <dl> | |
| 61 <div> | |
| 62 <div> | |
| 63 </div> | |
| 64 </div> | |
| 65 </dl> | |
| 66 </dd> | |
| 67 </div> <!-- /VALUE --> | |
| 68 | |
| 69 </div> <!-- /SUBTEMPLATES --> | |
| 70 | |
| 71 <a name="top"> </a> | |
| 72 <!-- API HEADER --> | |
| 73 <div id="pageHeader"> | |
| 74 <div id="searchbox"> | |
| 75 <form action="http://www.google.com/cse" id="cse-search-box"> | |
| 76 <div> | |
| 77 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq
tno"> | |
| 78 <input type="hidden" name="ie" value="UTF-8"> | |
| 79 <input type="text" name="q" size="31"> | |
| 80 <input type="submit" name="sa" value="Search"> | |
| 81 </div> | |
| 82 </form> | |
| 83 | |
| 84 <script type="text/javascript" src="http://www.google.com/jsapi"></scrip
t> | |
| 85 <script type="text/javascript">google.load("elements", "1", {packages: "
transliteration"});</script> | |
| 86 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?
form=cse-search-box&t13n_langs=en"></script> | |
| 87 <script type="text/javascript" src="http://www.google.com/coop/cse/brand
?form=cse-search-box&lang=en"></script> | |
| 88 </div> | |
| 89 <div id="pageTitle"> | |
| 90 <h1>New Tab Pages</h1> | |
| 91 </div> | |
| 92 </div> <!-- /pageHeader --> | |
| 93 | |
| 94 <div id="pageContent"> | |
| 95 <!-- SIDENAV --> | |
| 96 <div id="leftNav"> | |
| 97 <ul> | |
| 98 <li> <a href="index.html">Home</a></li> | |
| 99 <li> <a href="getstarted.html">Getting Started</a></li> | |
| 100 <li> <a href="overview.html">Overview</a></li> | |
| 101 <li> <a href="devguide.html"><div>Developer's Guide</div></a> | |
| 102 <ul> | |
| 103 <li> Browser UI | |
| 104 <ul> | |
| 105 <li><a href="browserAction.html">Browser Actions</a></li> | |
| 106 <li class="leftNavSelected">New Tab Pages</li> | |
| 107 <li><a href="options.html">Options Pages</a></li> | |
| 108 <li><a href="pageAction.html">Page Actions</a></li> | |
| 109 <li><a href="themes.html">Themes</a></li> | |
| 110 </ul> | |
| 111 </li> | |
| 112 <li> Browser Interaction | |
| 113 <ul> | |
| 114 <li><a href="bookmarks.html">Bookmarks</a></li> | |
| 115 <li><a href="events.html">Events</a></li> | |
| 116 <li><a href="tabs.html">Tabs</a></li> | |
| 117 <li><a href="windows.html">Windows</a></li> | |
| 118 </ul> | |
| 119 </li> | |
| 120 <li> Implementation | |
| 121 <ul> | |
| 122 <li><a href="background_pages.html">Background Pages</a></li> | |
| 123 <li><a href="content_scripts.html">Content Scripts</a></li> | |
| 124 <li><a href="xhr.html">Cross-Origin XHR</a></li> | |
| 125 <li><a href="npapi.html">NPAPI Plugins</a></li> | |
| 126 </ul> | |
| 127 </li> | |
| 128 <li> Finishing | |
| 129 <ul> | |
| 130 <li><a href="autoupdate.html">Autoupdating</a></li> | |
| 131 <li><a href="packaging.html">Packaging</a></li> | |
| 132 </ul> | |
| 133 </li> | |
| 134 </ul> | |
| 135 </li> | |
| 136 <li><a href="tutorials.html"><div>Tutorials</div></a> | |
| 137 <ul> | |
| 138 <li><a href="tut_debugging.html">Debugging</a></li> | |
| 139 </ul> | |
| 140 </li> | |
| 141 <li>Reference | |
| 142 <ul> | |
| 143 <li> Formats | |
| 144 <ul> | |
| 145 <li><a href="manifest.html">Manifest Files</a></li> | |
| 146 <li><a href="match_patterns.html">Match Patterns</a></li> | |
| 147 <!-- <li>Packages (.crx)</li> --> | |
| 148 </ul> | |
| 149 </li> | |
| 150 <li> <a href="api_index.html">chrome.* APIs</a> </li> | |
| 151 <li> <a href="api_other.html">Other APIs</a> </li> | |
| 152 </ul> | |
| 153 </li> | |
| 154 <li><a href="http://dev.chromium.org/developers/design-documents/extens
ions/samples">Samples</a></li> | |
| 155 </ul> | |
| 156 </div> | |
| 157 | |
| 158 <div id="mainColumn"> | |
| 159 <!-- TABLE OF CONTENTS --> | |
| 160 <div id="toc" style="display: none; "> | |
| 161 <p>Contents</p> | |
| 162 <ol> | |
| 163 <li> | |
| 164 <a>h2Name</a> | |
| 165 <ol> | |
| 166 <li> | |
| 167 <a>h3Name</a> | |
| 168 </li> | |
| 169 </ol> | |
| 170 </li> | |
| 171 <div> | |
| 172 <li> | |
| 173 <a href="#apiReference">API reference</a> | |
| 174 <ol> | |
| 175 <li> | |
| 176 <a href="#properties">Properties</a> | |
| 177 <ol> | |
| 178 <li> | |
| 179 <a href="#property-anchor">propertyName</a> | |
| 180 </li> | |
| 181 </ol> | |
| 182 </li> | |
| 183 <li> | |
| 184 <a href="#methods">Methods</a> | |
| 185 <ol> | |
| 186 <li> | |
| 187 <a href="#method-anchor">methodName</a> | |
| 188 </li> | |
| 189 </ol> | |
| 190 </li> | |
| 191 <li> | |
| 192 <a href="#events">Events</a> | |
| 193 <ol> | |
| 194 <li> | |
| 195 <a href="#event-anchor">eventName</a> | |
| 196 </li> | |
| 197 </ol> | |
| 198 </li> | |
| 199 <li> | |
| 200 <a href="#types">Types</a> | |
| 201 <ol> | |
| 202 <li> | |
| 203 <a href="#id-anchor">id</a> | |
| 204 </li> | |
| 205 </ol> | |
| 206 </li> | |
| 207 </ol> | |
| 208 </li> | |
| 209 </div> | |
| 210 </ol> | |
| 211 </div> | |
| 212 <!-- /TABLE OF CONTENTS --> | |
| 213 | |
| 214 <!-- STATIC CONTENT PLACEHOLDER --> | |
| 215 <div id="static"><div id="pageData-title" class="pageData">New Tab Pages
</div> | |
| 216 | |
| 217 <p> | |
| 218 The New Tab Page is the page that appears | |
| 219 when the user creates a new tab or window. | |
| 220 You can override the default New Tab Page, | |
| 221 providing an HTML file to be used instead. | |
| 222 This HTML file usually has CSS and JavaScript code, | |
| 223 as well as HTML. | |
| 224 </p> | |
| 225 | |
| 226 <p class="comment"> | |
| 227 [PENDING: Show a screenshot here, featuring both the + and the NTP.] | |
| 228 </p> | |
| 229 | |
| 230 <h2 id="manifest">Manifest</h2> | |
| 231 | |
| 232 <p> | |
| 233 Register your New Tab Page in the | |
| 234 <a href="manifest.html">extension manifest</a> | |
| 235 like this: | |
| 236 </p> | |
| 237 | |
| 238 <pre>"chrome_url_overrides": { | |
| 239 "newtab": "newtab.html" | |
| 240 } | |
| 241 </pre> | |
| 242 | |
| 243 | |
| 244 <h2 id="examples">Examples</h2> | |
| 245 | |
| 246 <p> | |
| 247 For an example of specifying a very simple New Tab Page, | |
| 248 see the | |
| 249 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/test/data/extens
ions/samples/override_igoogle/">override_igoogle</a> example. | |
| 250 That example uses a 3-line file named <code>redirect.html</code> | |
| 251 to implement the New Tab Page. | |
| 252 </p> | |
| 253 | |
| 254 <div class="comment"> | |
| 255 | |
| 256 <p class="tbd"> | |
| 257 [PENDING: Could have Tips section with a <b>Do</b>, <b>Do not</b> list | |
| 258 similar to browser actions. | |
| 259 </p> | |
| 260 | |
| 261 <p class="tbd"> | |
| 262 [PENDING: Maybe have a gallery of NTPs?] | |
| 263 </p> | |
| 264 | |
| 265 </div> | |
| 266 </div> | |
| 267 | |
| 268 <!-- API PAGE --> | |
| 269 <div class="apiPage" style="display: none; "> | |
| 270 <a name="apiReference"></a> | |
| 271 <h2>API reference: chrome.apiname </h2> | |
| 272 | |
| 273 <!-- PROPERTIES --> | |
| 274 <div class="apiGroup"> | |
| 275 <a name="properties"></a> | |
| 276 <h3 id="properties">Properties</h3> | |
| 277 | |
| 278 <div> | |
| 279 <a></a> | |
| 280 <h4>getLastError</h4> | |
| 281 <div class="summary"> | |
| 282 <!-- Note: intentionally longer 80 columns --> | |
| 283 <span>chrome.extension</span><span>lastError</span> | |
| 284 </div> | |
| 285 <div> | |
| 286 </div> | |
| 287 </div> | |
| 288 | |
| 289 </div> <!-- /apiGroup --> | |
| 290 | |
| 291 <!-- METHODS --> | |
| 292 <div class="apiGroup" id="methods"> | |
| 293 <a name="methods"></a> | |
| 294 <h3>Methods</h3> | |
| 295 | |
| 296 <!-- iterates over all functions --> | |
| 297 <div class="apiItem"> | |
| 298 <a></a> <!-- method-anchor --> | |
| 299 <h4>method name</h4> | |
| 300 | |
| 301 <div class="summary"><span>void</span> | |
| 302 <!-- Note: intentionally longer 80 columns --> | |
| 303 <span>chrome.module.methodName</span>(<span><span>, </span><sp
an></span> | |
| 304 <var><span></span></var></span>)</div> | |
| 305 | |
| 306 <div class="description"> | |
| 307 <p class="todo">Undocumented.</p> | |
| 308 <p> | |
| 309 A description from the json schema def of the function goes he
re. | |
| 310 </p> | |
| 311 | |
| 312 <!-- PARAMETERS --> | |
| 313 <h4>Parameters</h4> | |
| 314 <dl> | |
| 315 <div> | |
| 316 <div> | |
| 317 </div> | |
| 318 </div> | |
| 319 </dl> | |
| 320 | |
| 321 <!-- RETURNS --> | |
| 322 <h4>Returns</h4> | |
| 323 <dl> | |
| 324 <div> | |
| 325 <div> | |
| 326 </div> | |
| 327 </div> | |
| 328 </dl> | |
| 329 | |
| 330 <!-- CALLBACK --> | |
| 331 <div> | |
| 332 <div> | |
| 333 <h4>Callback function</h4> | |
| 334 <p> | |
| 335 If you specify the <em>callback</em> parameter, | |
| 336 it should specify a function that looks like this: | |
| 337 </p> | |
| 338 | |
| 339 <!-- Note: intentionally longer 80 columns --> | |
| 340 <pre>function(<span>Type param1, Type param2</span>) <span cla
ss="subdued">{...}</span>);</pre> | |
| 341 <dl> | |
| 342 <div> | |
| 343 <div> | |
| 344 </div> | |
| 345 </div> | |
| 346 </dl> | |
| 347 </div> | |
| 348 </div> | |
| 349 | |
| 350 </div> <!-- /description --> | |
| 351 | |
| 352 </div> <!-- /apiItem --> | |
| 353 | |
| 354 </div> <!-- /apiGroup --> | |
| 355 | |
| 356 <!-- EVENTS --> | |
| 357 <div class="apiGroup"> | |
| 358 <a name="events"></a> | |
| 359 <h3 id="events">Events</h3> | |
| 360 | |
| 361 <!-- iterates over all events --> | |
| 362 <div class="apiItem"> | |
| 363 <a></a> | |
| 364 <h4>event name</h4> | |
| 365 | |
| 366 <div class="summary"> | |
| 367 <!-- Note: intentionally longer 80 columns --> | |
| 368 <span class="subdued">chrome.bookmarks</span><span>onEvent</span
><span class="subdued">.addListener</span>(function(<span>Type param1, Type para
m2</span>) <span class="subdued">{...}</span>); | |
| 369 </div> | |
| 370 | |
| 371 <div class="description"> | |
| 372 <p class="todo">Undocumented.</p> | |
| 373 <p> | |
| 374 A description from the json schema def of the event goes here. | |
| 375 </p> | |
| 376 | |
| 377 <!-- PARAMETERS --> | |
| 378 <h4>Parameters</h4> | |
| 379 <dl> | |
| 380 <div> | |
| 381 <div> | |
| 382 </div> | |
| 383 </div> | |
| 384 </dl> | |
| 385 | |
| 386 </div> <!-- /decription --> | |
| 387 | |
| 388 </div> <!-- /apiItem --> | |
| 389 | |
| 390 </div> <!-- /apiGroup --> | |
| 391 | |
| 392 <!-- TYPES --> | |
| 393 <div class="apiGroup"> | |
| 394 <a name="types.sort(sortByName)"></a> | |
| 395 <h3 id="types">Types</h3> | |
| 396 | |
| 397 <!-- iterates over all types --> | |
| 398 <div class="apiItem"> | |
| 399 <a></a> | |
| 400 <h4>type name</h4> | |
| 401 | |
| 402 <div> | |
| 403 </div> | |
| 404 | |
| 405 </div> <!-- /apiItem --> | |
| 406 | |
| 407 </div> <!-- /apiGroup --> | |
| 408 | |
| 409 </div> <!-- /apiPage --> | |
| 410 </div> <!-- /mainColumn --> | |
| 411 </div> <!-- /pageContent --> | |
| 412 <div id="pageFooter" --=""> | |
| 413 <p> | |
| 414 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
| 415 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
| 416 Attribution 3.0 License</a>, and code samples are licensed under the | |
| 417 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
| 418 </p> | |
| 419 <p> | |
| 420 ©2009 Google | |
| 421 </p> | |
| 422 | |
| 423 <!-- begin analytics --> | |
| 424 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"><
/script> | |
| 425 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr
ipt> | |
| 426 | |
| 427 <script type="text/javascript"> | |
| 428 // chrome doc tracking | |
| 429 try { | |
| 430 var engdocs = _gat._getTracker("YT-10763712-2"); | |
| 431 engdocs._trackPageview(); | |
| 432 } catch(err) {} | |
| 433 | |
| 434 // code.google.com site-wide tracking | |
| 435 try { | |
| 436 _uacct="UA-18071-1"; | |
| 437 _uanchor=1; | |
| 438 _uff=0; | |
| 439 urchinTracker(); | |
| 440 } | |
| 441 catch(e) {/* urchinTracker not available. */} | |
| 442 </script> | |
| 443 <!-- end analytics --> | |
| 444 | |
| 445 </div> <!-- /pageFooter --> | |
| 446 </div> <!-- /container --> | |
| 447 </body></html> | |
| 448 | |
| OLD | NEW |
|---|
Chromium Code Reviews
