Date: Tue, 11 Aug 2009 03:01:43 +0000 Subject: pull over wiki content wiki changes Review URL: http://codereview.chromium.org/164302 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@23005 0039d316-1c4b-4281-b951-d872f2087c98 --- chrome/common/extensions/docs/api_index.html | 2 +- .../common/extensions/docs/background_pages.html | 1 + chrome/common/extensions/docs/bookmarks.html | 2 +- chrome/common/extensions/docs/content_scripts.html | 2 +- chrome/common/extensions/docs/devguide.html | 2 +- chrome/common/extensions/docs/getstarted.html | 2 +- .../extensions/docs/images/create-package.png | Bin 0 -> 50659 bytes .../extensions/docs/images/package-success.png | Bin 0 -> 45290 bytes .../docs/images/pageaction-omnibar-icons.png | Bin 0 -> 112885 bytes chrome/common/extensions/docs/index.html | 2 +- .../extensions/docs/js/api_page_generator.js | 13 +++--- chrome/common/extensions/docs/manifest.html | 2 +- chrome/common/extensions/docs/overview.html | 2 +- chrome/common/extensions/docs/packaging.html | 1 + chrome/common/extensions/docs/pageActions.html | 2 +- chrome/common/extensions/docs/self.html | 2 +- .../extensions/docs/static/background_pages.html | 40 +++++++++++++++++++ chrome/common/extensions/docs/static/overview.html | 2 +- .../common/extensions/docs/static/packaging.html | 44 +++++++++++++++++++++ .../common/extensions/docs/static/pageActions.html | 27 ++++++++++++- .../common/extensions/docs/static/tool_strips.html | 44 +++++++++++++++++++++ chrome/common/extensions/docs/static/xhr.html | 16 ++++++++ chrome/common/extensions/docs/tabs.html | 2 +- .../extensions/docs/template/api_template.html | 3 +- chrome/common/extensions/docs/tool_strips.html | 1 + chrome/common/extensions/docs/toolstrip.html | 2 +- chrome/common/extensions/docs/windows.html | 2 +- chrome/common/extensions/docs/xhr.html | 1 + 28 files changed, 197 insertions(+), 22 deletions(-) create mode 100755 chrome/common/extensions/docs/background_pages.html create mode 100755 chrome/common/extensions/docs/images/create-package.png create mode 100755 chrome/common/extensions/docs/images/package-success.png create mode 100755 chrome/common/extensions/docs/images/pageaction-omnibar-icons.png create mode 100755 chrome/common/extensions/docs/packaging.html create mode 100755 chrome/common/extensions/docs/static/background_pages.html create mode 100755 chrome/common/extensions/docs/static/packaging.html create mode 100755 chrome/common/extensions/docs/static/tool_strips.html create mode 100755 chrome/common/extensions/docs/static/xhr.html create mode 100755 chrome/common/extensions/docs/tool_strips.html create mode 100755 chrome/common/extensions/docs/xhr.html (limited to 'chrome/common') diff --git a/chrome/common/extensions/docs/api_index.html b/chrome/common/extensions/docs/api_index.html index c3fbe53..7b09cce 100755 --- a/chrome/common/extensions/docs/api_index.html +++ b/chrome/common/extensions/docs/api_index.html @@ -1 +1 @@ - Api_index

Google Chrome Extensions > Reference > chrome.* APIs > Api_index

Api_index

[PENDING: links to reference doc — for example, chrome.* APIs — go here.]

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar.

Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui.

+ Api_index

Google Chrome Extensions > Reference > chrome.* APIs > Api_index

Api_index

[PENDING: links to reference doc — for example, chrome.* APIs — go here.]

diff --git a/chrome/common/extensions/docs/background_pages.html b/chrome/common/extensions/docs/background_pages.html new file mode 100755 index 0000000..5d7b6f0 --- /dev/null +++ b/chrome/common/extensions/docs/background_pages.html @@ -0,0 +1 @@ + Background_pages

Google Chrome Extensions > Reference > chrome.* APIs > Background_pages

Background_pages

A common need for extensions is to have a single long-running script to manage some task or state. Toolstrips don't quite fit this need, because there can be multiple toolstrips active at any one time (one per browser window). Background pages to the rescue.

The background page is similar to a toolstrip, in that it is an HTML page that runs in the extension process. The difference is that the background page exists for the lifetime of your extension, and there is only one instance of it active at a time.

Status

Implemented.

Details

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "background_page": "background.html", "toolstrips": ["toolstrip.html"] }

Your toolstrip will likely contain only the necessary code to display the toolstrip UI, with all your extension logic contained in the background page. You can communicate between your various pages using direct script calls, similar to how frames can communicate. The chrome.self.getViews() function returns a list of window objects for every active page belonging to your extension.

Example

background_page.html (snippet): function updateUI(checked) { var views = chrome.self.getViews(); for (var i in views) { if (views[i].enableCheckbox) views[i].enableCheckbox(checked); } } toolstrip.html (snippet): function enableCheckbox(checked) { var elm = document.getElementById('checkbox'); elm.checked = checked; }

diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html index 0fc99bb..143ef20 100755 --- a/chrome/common/extensions/docs/bookmarks.html +++ b/chrome/common/extensions/docs/bookmarks.html @@ -1 +1 @@ - Bookmarks

Google Chrome Extensions > Reference > chrome.* APIs > Bookmarks

Bookmarks

Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks.

Description

[PENDING: intro goes here...]

Bookmark objects are an important part of the chrome.bookmarks API. Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure.

Properties

Objects that represent bookmarks can have the following properties:

id: An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; the ID for a particular bookmark might change the next time the browser is started.
title: The name of the bookmark. This is the user-visible string that describes the URL or group.
parentId (omitted for the root group): The ID of the group that this bookmark is in.
index (optional; omitted for the root group): The 0-based integer position of the bookmark within its group.
url (omitted for groups): The URL of the page that the bookmark points to.

Examples

The following code creates a bookmark group with the title "Chromium bookmarks". The last argument defines a function to be executed after the folder is created.

chrome.bookmarks.create({'parentId': bookmarkBar.id, 'title': 'Chromium bookmarks'}, function(newFolder) {...});

The next snippet creates a bookmark pointing to the Chromium developer doc. Since nothing too bad will happen if creating the bookmark fails, this snippet doesn't bother to define a callback function.

chrome.bookmarks.create({'parentId': chromiumBookmarks.id, 'title': 'dev doc', 'url': 'http://dev.chromium.org'});

Say you have bookmark hierarchy that looks like this:

Bookmarks

Google

Apps

Google homepage

Example

Here's how those bookmarks might be represented with bookmark objects:

Here's some code you could use to create that hierarchy:

...code goes here...

Full source code | Install extension

+ chrome.bookmarks API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.bookmarks

chrome.bookmarks

Contents

Description
1. Properties
2. Examples
Methods
Events
TODO: Structs

[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?]

Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks.

Description

[PENDING: intro goes here...]

Bookmark objects are an important part of the chrome.bookmarks API. Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure.

Properties

Objects that represent bookmarks can have the following properties:

id: An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; the ID for a particular bookmark might change the next time the browser is started.
title: The name of the bookmark. This is the user-visible string that describes the URL or group.
parentId (omitted for the root group): The ID of the group that this bookmark is in.
index (optional; omitted for the root group): The 0-based integer position of the bookmark within its group.
url (omitted for groups): The URL of the page that the bookmark points to.

Examples

The following code creates a bookmark group with the title "Chromium bookmarks". The last argument defines a function to be executed after the folder is created.

chrome.bookmarks.create({'parentId': bookmarkBar.id, 'title': 'Chromium bookmarks'}, function(newFolder) {...});

chrome.bookmarks.create({'parentId': chromiumBookmarks.id, 'title': 'dev doc', 'url': 'http://dev.chromium.org'});

Say you have bookmark hierarchy that looks like this:

Bookmarks

Google

Apps

Google homepage

Example

Here's how those bookmarks might be represented with bookmark objects:

Here's some code you could use to create that hierarchy:

...code goes here...

Full source code | Install extension

Methods

get

chrome.bookmarks.get(string or array of string idOrIdList, function callback)

Retrieves the specified BookmarkTreeNode(s).

Parameters

idOrIdList (optional string or array of string)

A single string-valued id, or an array of string-valued ids

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object results) {...});

results (array of object)

Undocumented.

getChildren

chrome.bookmarks.getChildren(string id, function callback)

Retrieves the children of the specified BookmarkTreeNode id.

Parameters

id (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object results) {...});

results (array of object)

Undocumented.

getTree

chrome.bookmarks.getTree(function callback)

Retrieves the entire Bookmarks hierarchy.

Parameters

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object results) {...});

results (array of object)

Undocumented.

search

chrome.bookmarks.search(string query, function callback)

Seaches for BookmarkTreeNodes matching the given query.

Parameters

query (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object results) {...});

results (array of object)

Undocumented.

create

chrome.bookmarks.create(object bookmark, function callback)

Undocumented.

Parameters

bookmark (optional object)

Undocumented.

parentId (optional string): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object result) {...});

result (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

move

chrome.bookmarks.move(string id, object destination, function callback)

Moves the specified BookmarkTreeNode to the provided location.

Parameters

id (optional string)

Undocumented.

destination (optional object)

Undocumented.

parentId (optional string): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

update

chrome.bookmarks.update(string id, object changes, function callback)

Undocumented.

Parameters

id (optional string)

Undocumented.

changes (optional object)

Undocumented.

title (optional string): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object result) {...});

result (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

remove

chrome.bookmarks.remove(string id, function callback)

Undocumented.

Parameters

id (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

removeTree

chrome.bookmarks.removeTree(string id, function callback)

Undocumented.

Parameters

id (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

onAdded

chrome.bookmarks.onAdded.addListener(function(string id, object bookmark) {...});

Undocumented.

Parameters

id (string)

Undocumented.

bookmark (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

onRemoved

chrome.bookmarks.onRemoved.addListener(function(string id, object RemoveInfo) {...});

Undocumented.

Parameters

id (string)

Undocumented.

RemoveInfo (object)

Undocumented.

parentId (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.

onChanged

chrome.bookmarks.onChanged.addListener(function(string id, object ChangeInfo) {...});

Undocumented.

Parameters

id (string)

Undocumented.

ChangeInfo (object)

Undocumented.

onMoved

chrome.bookmarks.onMoved.addListener(function(string id, object MoveInfo) {...});

Undocumented.

Parameters

id (string)

Undocumented.

MoveInfo (object)

Undocumented.

parentId (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
oldParentId (optional integer): Undocumented.; Description of this parameter from the json schema.
oldIndex (optional integer): Undocumented.; Description of this parameter from the json schema.

onChildrenReordered

chrome.bookmarks.onChildrenReordered.addListener(function(string id, arary childIds) {...});

Undocumented.

Parameters

id (string)

Undocumented.

childIds (arary)

Undocumented.

diff --git a/chrome/common/extensions/docs/content_scripts.html b/chrome/common/extensions/docs/content_scripts.html index 43b1d61..92647722 100755 --- a/chrome/common/extensions/docs/content_scripts.html +++ b/chrome/common/extensions/docs/content_scripts.html @@ -1 +1 @@ - Content_scripts

Google Chrome Extensions > Reference > chrome.* APIs > Content_scripts

Content_scripts

Content Scripts are JavaScript files that run in the context of web pages. By using the standard Document Object Model (DOM), they can read details of the web pages the browser visits, or make changes to them.

Some examples of things that content scripts can do include:

Find unlinked URLs in web pages and convert them into hyperlinks
Increase the font size to make text more legible
Find and process microformat data in the DOM

Registration

Content scripts are registered in an extension's manifest.json file, like so:

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.",  "content_scripts": [ { "matches": ["http://www.google.com/*"], "css": ["mystyles.css"], "js": ["jquery.js", "myscript.js"] } ] }

An extension can contain any number of content scripts, and a content script can consist of any number of JavaScript or CSS files. The value of the matches property controls when the content script will run.

Each content script registered in the manifest can specify the following properties:

Name	Type	Description
matches	array of strings	Required. Controls the pages this content script will be injected into. See Match Patterns for more details on the syntax of these strins.
js	array of strings	Optional. The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.
css	array of strings	Optional. The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.
run_at	string	Optional. Controls when the files in `js` are injected. Can be `"document_start"` or `"document_end"`. Defaults to `"document_end"`. In the case of `"document_start"`, the files are injected after any files from `"css"`, but before any other DOM is constructed or any other script is run. In the case of `"document_end"`, the files are injected after the DOM is complete, but before subresources like images and frames have necessarily loaded.

Match Patterns

TODO

Execution Environment

Content scripts execute in a special environment called an isolated world. They have access to the DOM of the page they are injected into, but not to any JavaScript variables or functions created by the page. It looks to each content script as if there is no other JavaScript executing on the page it is running on. The same is true in reverse: JavaScript running on the page cannot call any functions or access any variables defined by content scripts.

For example, consider this simple page:

hello.html =========== <html> <button id="button">click me</button> <script> var greeting = "hello!"; function sayGreeting() { alert(greeting); } document.getElementById("button").onclick = sayGreeting; </script> </html>

Now, suppose this content script was injected into hello.html:

contentscript.js ================== console.log(greeting); // undefined console.log(sayGreeting); // undefined console.log(document.getElementById("button").onclick); // still undefined document.getElementById("button").onclick = function() { alert("hola!"); }

Now, if the button is pressed, you will see both greetings.

Isolated worlds allow each content script to make changes to its JavaScript environment without worrying about conflicting with the page or with other contnet scripts. For example, a content script could include JQuery v1 and the page could include JQuery v2, and they wouldn't conflict with each other.

Another important benefit of isolated worlds is that they completely separate the JavaScript on the page from the JavaScript in extensions. This allows us to offer extra functionality to content scripts that should not be accessible from web pages without worrying about web pages accessing it.

Messaging

Content scripts can communicate with their parent extension using message passing. The content script opens a channel to the extension using the chrome.extension.connect() method and then sends messages back and forth to it. The messages can contain any valid JSON object (null, boolean, number, string, array, or object).

The parent extension can also open a channel to a content script in a given tab by calling chrome.tabs.connect(tabId).

When a channel is opened from a content script to an extension, the onConnect event is fired in all views in the extension. Any view can receive the event. The event contains a Port object, which can be used by the extension view to communicate back to the content script.

[TODO: Complete this]

Communication with the embedding page

Although the execution environments of content scripts and the pages that host them are isolated from each other, they share access to the page's DOM. If the page wishes to communicate with the content script (or with the extension via the content script), it must do so through the shared DOM.

An example can be accomplished using custom DOM events and storing data in a known location. Consider:

http://foo.com/example.html ================================ var customEvent = document.createEvent('Event'); customEvent.initEvent('myCustomEvent', true, true); function fireCustomEvent(data) { hidenDiv = document.getElementById('myCustomEventDiv'); hidenDiv.innerHTML = data hidenDiv.dispatchEvent(customEvent); }

contentscript.js ===================== var port = chrome.extension.connect(); document.getElementById('myCustomEventDiv').addEventListener('myCustomEvent', function() { var eventData = document.getElementById('myCustomEventDiv').innerHTML; port.postMessage({message: "myCustomEvent", values: eventData}); });

In the above example, example.html (which is not a part of the extension) creates a custom event and then can decide to fire the event by setting the event data to a known location in the DOM and then dispatching the custom event. The content script listens for the name of the custom event on the known element and handles the event by inspecting the data of the element, and turning around to post the message to the extension process. In this way the page establishes a line of communication to the extension. The reverse is possible through similar means.

+ Content_scripts

Google Chrome Extensions > Reference > chrome.* APIs > Content_scripts

Content_scripts

Some examples of things that content scripts can do include:

Find unlinked URLs in web pages and convert them into hyperlinks
Increase the font size to make text more legible
Find and process microformat data in the DOM

Registration

Content scripts are registered in an extension's manifest.json file, like so:

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.",  "content_scripts": [ { "matches": ["http://www.google.com/*"], "css": ["mystyles.css"], "js": ["jquery.js", "myscript.js"] } ] }

Each content script registered in the manifest can specify the following properties:

Name	Type	Description
matches	array of strings	Required. Controls the pages this content script will be injected into. See Match Patterns for more details on the syntax of these strins.
js	array of strings	Optional. The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.
css	array of strings	Optional. The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.
run_at	string	Optional. Controls when the files in `js` are injected. Can be `"document_start"` or `"document_end"`. Defaults to `"document_end"`. In the case of `"document_start"`, the files are injected after any files from `"css"`, but before any other DOM is constructed or any other script is run. In the case of `"document_end"`, the files are injected after the DOM is complete, but before subresources like images and frames have necessarily loaded.

Match Patterns

TODO

Execution Environment

For example, consider this simple page:

hello.html =========== <html> <button id="button">click me</button> <script> var greeting = "hello!"; function sayGreeting() { alert(greeting); } document.getElementById("button").onclick = sayGreeting; </script> </html>

Now, suppose this content script was injected into hello.html:

contentscript.js ================== console.log(greeting); // undefined console.log(sayGreeting); // undefined console.log(document.getElementById("button").onclick); // still undefined document.getElementById("button").onclick = function() { alert("hola!"); }

Now, if the button is pressed, you will see both greetings.

Messaging

The parent extension can also open a channel to a content script in a given tab by calling chrome.tabs.connect(tabId).

[TODO: Complete this]

Communication with the embedding page

An example can be accomplished using custom DOM events and storing data in a known location. Consider:

http://foo.com/example.html ================================ var customEvent = document.createEvent('Event'); customEvent.initEvent('myCustomEvent', true, true); function fireCustomEvent(data) { hidenDiv = document.getElementById('myCustomEventDiv'); hidenDiv.innerHTML = data hidenDiv.dispatchEvent(customEvent); }

contentscript.js ===================== var port = chrome.extension.connect(); document.getElementById('myCustomEventDiv').addEventListener('myCustomEvent', function() { var eventData = document.getElementById('myCustomEventDiv').innerHTML; port.postMessage({message: "myCustomEvent", values: eventData}); });

diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html index 0de4b6d..2b16f7a 100755 --- a/chrome/common/extensions/docs/devguide.html +++ b/chrome/common/extensions/docs/devguide.html @@ -1 +1 @@ - Devguide

Google Chrome Extensions > Reference > chrome.* APIs > Devguide

Devguide

[PENDING: intro to the guide goes here. say where to go. lots o' links.]

+ Devguide

Google Chrome Extensions > Reference > chrome.* APIs > Devguide

Devguide

[PENDING: intro to the guide goes here. say where to go. lots o' links.]

diff --git a/chrome/common/extensions/docs/getstarted.html b/chrome/common/extensions/docs/getstarted.html index b54c365..d24e6bd 100755 --- a/chrome/common/extensions/docs/getstarted.html +++ b/chrome/common/extensions/docs/getstarted.html @@ -1 +1 @@ - Getstarted

Google Chrome Extensions > Reference > chrome.* APIs > Getstarted

Getstarted

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.

Get your browser ready

To develop extensions for Google Chrome, you need to set up your browser:

Subscribe to the Dev channel of Google Chrome for Windows.
Create a separate profile for testing (optional but highly recommended). 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.

Create and load an extension

In this section, you'll write a toolstrip — an extension that puts a bit of UI into the toolbar at the bottom of the Google Chrome window.

Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at c:\myext, but it can be anywhere.

Inside your extension's folder, create a text file called manifest.json, and put this in it:

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }

In the same folder, create a text file called my_toolstrip.html, and put this in it:
```
<div class="toolstrip-button"> <span>Hello, World!</span> </div>
```
Load the extension:
1. Change the shortcut that you use to start the browser (or create a new one) so that it has the --enable-extensions and --load-extension flags. For example, if your extension is at c:\myext, your shortcut might look something like this:
```
chrome.exe --enable-extensions --load-extension="c:\myext"
```
2. Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile.
3. Double-click the shortcut to start the browser.
Note: For details on changing shortcut properties, see Creating and Using Profiles.

You should see the UI for your extension at the bottom left of the browser, looking something like this:

default appearance	initial onhover appearance	final onhover appearance

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.

[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?]

Add code to the extension

In this step, you'll make your extension do something besides just look good.

Inside your extension's folder, create a text file called hello_world.html, and add the following code to it:

CSS and JavaScript code for hello_world

Edit my_toolstrip.html, so that it has the following code:

<div class="toolstrip-button" onclick="window.open('hello_world.html')"> <span>Hello, World!</span> </div>

Restart the browser to load the new version of the extension.
Click the button. A window should come up that displays hello_world.html.

It should look something like this:

a window with a grid of images related to HELLO WORLD

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!

Debug the extension

You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension.

Edit my_toolstrip.html, so that it has the following code:

<script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script> <div class="toolstrip-button" onclick="helloWorld();"> <span>Hello, World!</span> </div>

The relocated code still has the same effect, but now it has some debugging output, thanks to the call to console.log().

Restart the browser, so that it loads your new version of the extension.
Right-click the Hello, World! 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:
Click the Scripts button. If necessary, choose my_toolstrip.html from the list of scripts. The result should be something like this:
Set a debugging breakpoint at the window.open() statement by clicking 5 in the left column:
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.
Back in the main browser window, click the Hello, World! button, so that the extension begins executing. You should see the output of console.log() along with the line number, and execution should stop just before the call to window.open().

The Call Stack area at the right of the tools window shows that the helloWorld() method was called by an anonymous function that was called by onclick. 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.
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 hwFile is a local variable that has the value "hello_world.html".
Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to window.open() returns, the main browser window should open a new tab that displays the contents of hello_world.html.

You now know how to load and debug an extension!

Summary

[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.]

+ Getstarted

Google Chrome Extensions > Reference > chrome.* APIs > Getstarted

Getstarted

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.

Get your browser ready

To develop extensions for Google Chrome, you need to set up your browser:

Subscribe to the Dev channel of Google Chrome for Windows.
Create a separate profile for testing (optional but highly recommended). 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.

Create and load an extension

In this section, you'll write a toolstrip — an extension that puts a bit of UI into the toolbar at the bottom of the Google Chrome window.

Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at c:\myext, but it can be anywhere.

Inside your extension's folder, create a text file called manifest.json, and put this in it:

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }

In the same folder, create a text file called my_toolstrip.html, and put this in it:
```
<div class="toolstrip-button"> <span>Hello, World!</span> </div>
```
Load the extension:
1. Change the shortcut that you use to start the browser (or create a new one) so that it has the --enable-extensions and --load-extension flags. For example, if your extension is at c:\myext, your shortcut might look something like this:
```
chrome.exe --enable-extensions --load-extension="c:\myext"
```
2. Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile.
3. Double-click the shortcut to start the browser.
Note: For details on changing shortcut properties, see Creating and Using Profiles.

You should see the UI for your extension at the bottom left of the browser, looking something like this:

default appearance	initial onhover appearance	final onhover appearance

[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?]

Add code to the extension

In this step, you'll make your extension do something besides just look good.

Inside your extension's folder, create a text file called hello_world.html, and add the following code to it:

CSS and JavaScript code for hello_world

Edit my_toolstrip.html, so that it has the following code:

<div class="toolstrip-button" onclick="window.open('hello_world.html')"> <span>Hello, World!</span> </div>

Restart the browser to load the new version of the extension.
Click the button. A window should come up that displays hello_world.html.

It should look something like this:

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!

Debug the extension

You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension.

Edit my_toolstrip.html, so that it has the following code:

<script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script> <div class="toolstrip-button" onclick="helloWorld();"> <span>Hello, World!</span> </div>

The relocated code still has the same effect, but now it has some debugging output, thanks to the call to console.log().

Restart the browser, so that it loads your new version of the extension.
Right-click the Hello, World! 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:
Click the Scripts button. If necessary, choose my_toolstrip.html from the list of scripts. The result should be something like this:
Set a debugging breakpoint at the window.open() statement by clicking 5 in the left column:
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.
Back in the main browser window, click the Hello, World! button, so that the extension begins executing. You should see the output of console.log() along with the line number, and execution should stop just before the call to window.open().

The Call Stack area at the right of the tools window shows that the helloWorld() method was called by an anonymous function that was called by onclick. 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.
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 hwFile is a local variable that has the value "hello_world.html".
Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to window.open() returns, the main browser window should open a new tab that displays the contents of hello_world.html.

You now know how to load and debug an extension!

Summary

[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.]

diff --git a/chrome/common/extensions/docs/images/create-package.png b/chrome/common/extensions/docs/images/create-package.png new file mode 100755 index 0000000..2079a6f Binary files /dev/null and b/chrome/common/extensions/docs/images/create-package.png differ diff --git a/chrome/common/extensions/docs/images/package-success.png b/chrome/common/extensions/docs/images/package-success.png new file mode 100755 index 0000000..17f671e Binary files /dev/null and b/chrome/common/extensions/docs/images/package-success.png differ diff --git a/chrome/common/extensions/docs/images/pageaction-omnibar-icons.png b/chrome/common/extensions/docs/images/pageaction-omnibar-icons.png new file mode 100755 index 0000000..a2f27c2 Binary files /dev/null and b/chrome/common/extensions/docs/images/pageaction-omnibar-icons.png differ diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html index 6de05ee..30e9ef4 100755 --- a/chrome/common/extensions/docs/index.html +++ b/chrome/common/extensions/docs/index.html @@ -1 +1 @@ - Index

Google Chrome Extensions > Reference > chrome.* APIs > Index

Index

If you want to customize Google Chrome, you've come to the right place. An extension is a bundle of web code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. Examples of extensions include a mail checker, a newsfeed subscriber, and a status monitor.

[Maybe add some nice enticing pictures of toolstrips and moles (when we have them)]

If you just want to dive in, try Get Started. Otherwise, if you'd prefer to start with the high level overview, try Overview.

+ Index

Google Chrome Extensions > Reference > chrome.* APIs > Index

Index

[Maybe add some nice enticing pictures of toolstrips and moles (when we have them)]

If you just want to dive in, try Get Started. Otherwise, if you'd prefer to start with the high level overview, try Overview.

diff --git a/chrome/common/extensions/docs/js/api_page_generator.js b/chrome/common/extensions/docs/js/api_page_generator.js index 7e93aeb..adee3db 100755 --- a/chrome/common/extensions/docs/js/api_page_generator.js +++ b/chrome/common/extensions/docs/js/api_page_generator.js @@ -21,6 +21,9 @@ var REQUEST_TIMEOUT = 2000; function staticResource(name) { return "static/" + name + ".html"; } // Base name of this page. (i.e. "tabs", "overview", etc...). +var pageBase; + +// The name of this page that will be shown on the page in various places. var pageName; // Data to feed as context into the template. @@ -52,13 +55,13 @@ function extend(obj, obj2) { */ function renderPage() { var pathParts = document.location.href.split(/\/|\./); - pageName = pathParts[pathParts.length - 2]; - if (!pageName) { + pageBase = pathParts[pathParts.length - 2]; + if (!pageBase) { alert("Empty page name for: " + document.location.href); return; } - pageName = pageName.replace(/([A-Z])/g, " $1"); + pageName = pageBase.replace(/([A-Z])/g, " $1"); pageName = pageName.substring(0, 1).toUpperCase() + pageName.substring(1); // Fetch the api template and insert into the . @@ -72,7 +75,7 @@ function renderPage() { function fetchStatic() { // Fetch the static content and insert into the "static"

. - fetchContent(staticResource(pageName), function(overviewContent) { + fetchContent(staticResource(pageBase), function(overviewContent) { document.getElementById("static").innerHTML = overviewContent; fetchSchema(); @@ -153,7 +156,7 @@ function renderTemplate(schemaContent) { }); schema.each(function(module) { - if (module.namespace == pageName) { + if (module.namespace == pageBase) { // This page is an api page. Setup types and apiDefinition. pageData.apiDefinition = module; preprocessApi(pageData, schema); diff --git a/chrome/common/extensions/docs/manifest.html b/chrome/common/extensions/docs/manifest.html index 25f8290..85610ba 100755 --- a/chrome/common/extensions/docs/manifest.html +++ b/chrome/common/extensions/docs/manifest.html @@ -1 +1 @@ - Manifest

Google Chrome Extensions > Reference > chrome.* APIs > Manifest

Manifest

This page should go into detail about all the parts of the manifest. In cases where there's not too much to say about something (icons, cross-origin XHR), we can just document it inline. Otherwise (content scripts), we can link off to a separate page.

+ Manifest

Google Chrome Extensions > Reference > chrome.* APIs > Manifest

Manifest

diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html index 66d6687..88afa62 100755 --- a/chrome/common/extensions/docs/overview.html +++ b/chrome/common/extensions/docs/overview.html @@ -1 +1 @@ - Overview

Google Chrome Extensions > Reference > chrome.* APIs > Overview

Overview

This page should perhaps be renamed from "overview" to "concepts". In any case, what I'd like to cover here is the conceptual underpinning of extensions, such as:

Zip file of web pages
All resources accessible with a URL scheme
How IDs are generated
The manifest
The background page, how extensions are typically structured
Process model
Content scripts (lightweight, link off to other page for details)
Asynchronous APIs
Extension IDs, how they are generated
How packaging works at a high level (lightweight, link off to other page for details)

+ Overview

Google Chrome Extensions > Reference > chrome.* APIs > Overview

Overview

This page should perhaps be renamed from "overview" to "concepts". In any case, what I'd like to cover here is the conceptual underpinning of extensions, such as:

Zip file of web pages
All resources accessible with a URL scheme
How IDs are generated
The manifest
The background page, how extensions are typically structured
Process model
Content scripts (lightweight, link off to other page for details)
Asynchronous APIs
Extension IDs, how they are generated
How packaging works at a high level (lightweight, link off to other page for details)

diff --git a/chrome/common/extensions/docs/packaging.html b/chrome/common/extensions/docs/packaging.html new file mode 100755 index 0000000..d7a1d7ab --- /dev/null +++ b/chrome/common/extensions/docs/packaging.html @@ -0,0 +1 @@ + Packaging

Google Chrome Extensions > Reference > chrome.* APIs > Packaging

Packaging

Extensions are packaged as signed zip files with the file extension "crx" (eg myextension.crx). Each extension has its own unique key pair. The public key is used as the unique identifier for the extension and the private key is kept private and used to sign each version of the extension.

Packaging an Extension

To package an extension:

Close all your Chrome windows

Open a command line and type:

<path-to-chrome>\chrome.exe --pack-extension=<path\to\extension\folder>

Note

In Windows XP, you can find by right-clicking on your Google Chrome shortcut and selecting Properties -> Shortcut and then pressing Find Target.
In Vista, you can do the same by right-clicking your Google Chrome shortcut and selecting Open File Location.

The packager creates two files: a crx file (myextension.crx), which is the actual extension that can be installed, and a private key (myextension.pem). You should keep the private key secret and in a safe place.

IMPORTANT: Do not lose the private key. You will need it later for two things

If you want to create a new version of the extension, you'll need the original private key (see below).
In the future, Google will implement a gallery service for extensions. You'll need your private key if you want to import an existing extension into that gallery.

Updating an Extension

To create an updated version of your extension:

Increase the version number in manifest.json
Close all your Chrome windows
Run \chrome.exe --pack-extension= --pack-extension-key=, specifying the private key file you created earlier for the second parameter.

If the updated extension is successfully packaged, you'll see a dialog like this

Tips and Tricks

In build 3.0.195 and later, you can use the --no-message-box command line flag to suppress the dialog. This is useful if you're packing extensions in non-interactive scripts.

diff --git a/chrome/common/extensions/docs/pageActions.html b/chrome/common/extensions/docs/pageActions.html index bec392e..c03139f 100755 --- a/chrome/common/extensions/docs/pageActions.html +++ b/chrome/common/extensions/docs/pageActions.html @@ -1 +1 @@ - Page Actions

Google Chrome Extensions > Reference > chrome.* APIs > Page Actions

Page Actions

Google Chrome Extensions > Reference > chrome.* APIs > Page Actions

Page Actions

+ chrome.pageActions API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.pageActions

chrome.pageActions

Contents

Description
1. Properties
2. Examples
Methods
1. enableForTab
2. disableForTab
Events
1. eventName
TODO: Structs

[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?]

Page actions are a simple way to represent actions that can be taken on a page ("Email this page", "Share with Facebook", etc).

Status

First version implemented.

User interface

Page actions are displayed in the right side of the Omnibox. New actions get added to the left of the star:

A maximum of 8 (?) actions can appear at the top level, any additional ones overflow into a drop-down menu:

Manifest

Developers can include page actions in the manifest using the following syntax:

"page_actions": [ { "id": "myaction", // chosen by developer, and should be unique within their extension "name": "Do action", "icons": ["favicon.png", "favicon2.png"] } ]

Supported icon image formats include for example png, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit.

Methods

enableForTab

chrome.pageActions.enableForTab(string pageActionId, object action)

Undocumented.

Parameters

pageActionId (optional string)

Undocumented.

action (optional object)

Undocumented.

tabId (optional integer): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
iconId (optional integer): Undocumented.; Description of this parameter from the json schema.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(Type param1, Type param2) {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

disableForTab

chrome.pageActions.disableForTab(string pageActionId, object action)

Undocumented.

Parameters

pageActionId (optional string)

Undocumented.

action (optional object)

Undocumented.

tabId (optional integer): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(Type param1, Type param2) {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

diff --git a/chrome/common/extensions/docs/self.html b/chrome/common/extensions/docs/self.html index 2c419dd..2d39890 100755 --- a/chrome/common/extensions/docs/self.html +++ b/chrome/common/extensions/docs/self.html @@ -1 +1 @@ - Self

Google Chrome Extensions > Reference > chrome.* APIs > Self

Self

[PENDING: API Module Overview Goes Here]

+ chrome.self API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.self

chrome.self

Contents

Description
1. Properties
2. Examples
Methods
1. getViews
Events
1. eventName
TODO: Structs

[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?]

[PENDING: API Module Overview Goes Here]

Methods

getViews

array of object chrome.self.getViews()

Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.

Parameters

paramName (optional paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Returns

--> (array of object)

Array of HTMLWindow objects

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(Type param1, Type param2) {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

diff --git a/chrome/common/extensions/docs/static/background_pages.html b/chrome/common/extensions/docs/static/background_pages.html new file mode 100755 index 0000000..1d6d094 --- /dev/null +++ b/chrome/common/extensions/docs/static/background_pages.html @@ -0,0 +1,40 @@ + +

+ +

Status

+ +

Implemented.

+ +

Details

+ +

{
+  "name": "My First Extension",
+  "version": "1.0",
+  "description": "The first extension that I made.",
+  "background_page": "background.html",
+  "toolstrips": ["toolstrip.html"]
+}

+ +

Example

+ +

background_page.html (snippet):
+  function updateUI(checked) {
+    var views = chrome.self.getViews();
+    for (var i in views) {
+      if (views[i].enableCheckbox)
+        views[i].enableCheckbox(checked);
+    }
+  }
+
+toolstrip.html (snippet):
+  function enableCheckbox(checked) {
+    var elm = document.getElementById('checkbox');
+    elm.checked = checked;
+  }

+ diff --git a/chrome/common/extensions/docs/static/overview.html b/chrome/common/extensions/docs/static/overview.html index 6e59349..b15603c 100755 --- a/chrome/common/extensions/docs/static/overview.html +++ b/chrome/common/extensions/docs/static/overview.html @@ -12,4 +12,4 @@ This page should perhaps be renamed from "overview" to "concepts". In any case,

Asynchronous APIs

Extension IDs, how they are generated

How packaging works at a high level (lightweight, link off to other page for details) - + \ No newline at end of file diff --git a/chrome/common/extensions/docs/static/packaging.html b/chrome/common/extensions/docs/static/packaging.html new file mode 100755 index 0000000..09b2aca --- /dev/null +++ b/chrome/common/extensions/docs/static/packaging.html @@ -0,0 +1,44 @@ +

+ +

Packaging an Extension

+ +

To package an extension:

Close all your Chrome windows

Open a command line and type:

<path-to-chrome>\chrome.exe --pack-extension=<path\to\extension\folder>

+ +

Note

In Windows XP, you can find by right-clicking on your Google Chrome shortcut and selecting Properties -> Shortcut and then pressing Find Target.
In Vista, you can do the same by right-clicking your Google Chrome shortcut and selecting Open File Location.

+ +

IMPORTANT: Do not lose the private key. You will need it later for two things

If you want to create a new version of the extension, you'll need the original private key (see below).
+
In the future, Google will implement a gallery service for extensions. You'll need your private key if you want to import an existing extension into that gallery.

+ +

Updating an Extension

+ +

To create an updated version of your extension:

Increase the version number in manifest.json
Close all your Chrome windows
Run \chrome.exe --pack-extension= --pack-extension-key=, specifying the private key file you created earlier for the second parameter.

+ +

If the updated extension is successfully packaged, you'll see a dialog like this

+ +

Tips and Tricks

+ +

In build 3.0.195 and later, you can use the --no-message-box command line flag to suppress the dialog. This is useful if you're packing extensions in non-interactive scripts.

\ No newline at end of file diff --git a/chrome/common/extensions/docs/static/pageActions.html b/chrome/common/extensions/docs/static/pageActions.html index 997b579..3d3ebf2 100755 --- a/chrome/common/extensions/docs/static/pageActions.html +++ b/chrome/common/extensions/docs/static/pageActions.html @@ -1,5 +1,28 @@ -

-[PENDING: API Module Overview Goes Here] +

Page actions are a simple way to represent actions that can be taken on a page ("Email this page", "Share with Facebook", etc).

+ +

Status

First version implemented.

+ +

User interface

Page actions are displayed in the right side of the Omnibox. New actions get added to the left of the star:

+ +

A maximum of 8 (?) actions can appear at the top level, any additional ones overflow into a drop-down menu:

+ +

Manifest

+ +

Developers can include page actions in the manifest using the following syntax:

+ +

"page_actions": [
+    {
+      "id": "myaction",  // chosen by developer, and should be unique within their extension
+      "name": "Do action",
+      "icons": ["favicon.png", "favicon2.png"]
+    }
+  ]

+ +

Supported icon image formats include for example png, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit.

diff --git a/chrome/common/extensions/docs/static/tool_strips.html b/chrome/common/extensions/docs/static/tool_strips.html new file mode 100755 index 0000000..fbf2248 --- /dev/null +++ b/chrome/common/extensions/docs/static/tool_strips.html @@ -0,0 +1,44 @@ + +

Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pages, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips.

+ +

Status

Implementation in progress.

+ +

Details

+ +

{
+  "name": "My First Extension",
+  "version": "1.0",
+  "description": "The first extension that I made.",
+  "toolstrips": [
+    "one_toolstrip.html",
+    "two_toolstrip.html"
+  ]
+}

+ +

You can create buttons that look like the bookmark bar buttons using this template:

+ +

<div class="toolstrip-button">
+  <!-- Image is optional and should be a 16x16 icon. -->
+  <img src="path/to/some_icon.png">
+  <span>My Button</span>
+</div>

+ +

Debugging Tips

+ +

You can right click on a toolstrip to get a web inspector.
alert(), prompt(), and confirm() don't work yet. Sorry about that.
You can run toolstrips in the main content area by loading their URL, which would be something like chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html

+ +

Design Tips

+ +

Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.
The toolbar automatically detects how much space a toolstrip needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.
If you need to do more extensive UI, use the tab contents area or a pop up window.
Remember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running application logic, try Background Pages.

+ diff --git a/chrome/common/extensions/docs/static/xhr.html b/chrome/common/extensions/docs/static/xhr.html new file mode 100755 index 0000000..43be3bcc --- /dev/null +++ b/chrome/common/extensions/docs/static/xhr.html @@ -0,0 +1,16 @@ + +

The standard XMLHttpRequest object can be used to communicate with multiple origins (ie domains) from an extension. You must pre-register the domains you want to talk to in the manifest, like so:

+ +

{
+  "name": "My First Extension",
+  "version": "1.0",
+  "description": "The first extension that I made.",
+  "permissions": [
+    "http://www.blogger.com",
+    "http://*.google.com"
+  ]
+}

+ +

Status

Implemented, but we don't yet enforce the permissions; all origins are allowed for now.

+ diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index 514c8f9..aae6da5 100755 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -1 +1 @@ - Tabs

Google Chrome Extensions > Reference > chrome.* APIs > Tabs

Tabs

[PENDING: API Module Overview Goes Here]

+ chrome.tabs API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.tabs

chrome.tabs

Contents

Description
1. Properties
2. Examples
Methods
Events
TODO: Structs

[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?]

[PENDING: API Module Overview Goes Here]

Methods

get

chrome.tabs.get(integer tabId, function callback)

Undocumented.

Parameters

tabId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object tab) {...});

tab (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

connect

object chrome.tabs.connect(integer tabId, string name)

Undocumented.

Parameters

tabId (optional integer)

Undocumented.

name (optional string)

Undocumented.

Returns

Port (object)

Undocumented.

name (optional string): Undocumented.; Description of this parameter from the json schema.
onDisconnect (optional object): Undocumented.; Description of this parameter from the json schema.
onMessage (optional object): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(Type param1, Type param2) {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

getSelected

chrome.tabs.getSelected(integer windowId, function callback)

Undocumented.

Parameters

windowId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object tab) {...});

tab (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

getAllInWindow

chrome.tabs.getAllInWindow(integer windowId, function callback)

Undocumented.

Parameters

windowId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object tabs) {...});

tabs (array of object)

Undocumented.

create

chrome.tabs.create(object CreateProperties, function callback)

Undocumented.

Parameters

CreateProperties (optional object)

Undocumented.

windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object tab) {...});

tab (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

update

chrome.tabs.update(integer tabId, object UpdateProperties, function callback)

Undocumented.

Parameters

tabId (optional integer)

Undocumented.

UpdateProperties (optional object)

Undocumented.

url (optional string): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

move

chrome.tabs.move(integer tabId, object MoveProperties, function callback)

Undocumented.

Parameters

tabId (optional integer)

Undocumented.

MoveProperties (optional object)

Undocumented.

windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

remove

chrome.tabs.remove(integer tabId, function callback)

Undocumented.

Parameters

tabId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

detectLanguage

chrome.tabs.detectLanguage(integer tabId, function callback)

detect language of tab.

Parameters

tabId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(string language) {...});

language (string)

Undocumented.

Events

onCreated

chrome.bookmarks.onCreated.addListener(function(object tab) {...});

Undocumented.

Parameters

tab (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
index (optional integer): Undocumented.; Description of this parameter from the json schema.
windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
selected (optional boolean): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.
title (optional string): Undocumented.; Description of this parameter from the json schema.
favIconUrl (optional string): Undocumented.; Description of this parameter from the json schema.

onUpdated

chrome.bookmarks.onUpdated.addListener(function(integer tabId, object ChangedProps) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

ChangedProps (object)

Undocumented.

tabId (optional integer): Undocumented.; Description of this parameter from the json schema.
status (optional string): Undocumented.; Description of this parameter from the json schema.
url (optional string): Undocumented.; Description of this parameter from the json schema.

onMoved

chrome.bookmarks.onMoved.addListener(function(integer tabId, object MoveInfo) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

MoveInfo (object)

Undocumented.

windowId (optional integer): Undocumented.; Description of this parameter from the json schema.
fromIndex (optional integer): Undocumented.; Description of this parameter from the json schema.
toIndex (optional integer): Undocumented.; Description of this parameter from the json schema.

onSelectionChanged

chrome.bookmarks.onSelectionChanged.addListener(function(integer tabId, object SelectInfo) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

SelectInfo (object)

Undocumented.

windowId (optional integer): Undocumented.; Description of this parameter from the json schema.

onAttached

chrome.bookmarks.onAttached.addListener(function(integer tabId, object AttachInfo) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

AttachInfo (object)

Undocumented.

newWindowId (optional integer): Undocumented.; Description of this parameter from the json schema.
newPosition (optional integer): Undocumented.; Description of this parameter from the json schema.

onDetached

chrome.bookmarks.onDetached.addListener(function(integer tabId, object DetachInfo) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

DetachInfo (object)

Undocumented.

oldWindowId (optional integer): Undocumented.; Description of this parameter from the json schema.
oldPosition (optional integer): Undocumented.; Description of this parameter from the json schema.

onRemoved

chrome.bookmarks.onRemoved.addListener(function(integer tabId) {...});

Undocumented.

Parameters

tabId (integer)

Undocumented.

diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index 8836e1d..ca95974 100755 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -41,7 +41,7 @@

Reference

Samples diff --git a/chrome/common/extensions/docs/tool_strips.html b/chrome/common/extensions/docs/tool_strips.html new file mode 100755 index 0000000..027c67b --- /dev/null +++ b/chrome/common/extensions/docs/tool_strips.html @@ -0,0 +1 @@ + Tool_strips

Google Chrome Extensions > Reference > chrome.* APIs > Tool_strips

Tool_strips

Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pages, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips.

Status

Implementation in progress.

Details

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }

You can create buttons that look like the bookmark bar buttons using this template:

<div class="toolstrip-button"> <!-- Image is optional and should be a 16x16 icon. --> <img src="path/to/some_icon.png"> <span>My Button</span> </div>

Debugging Tips

You can right click on a toolstrip to get a web inspector.
alert(), prompt(), and confirm() don't work yet. Sorry about that.
You can run toolstrips in the main content area by loading their URL, which would be something like chrome-extension://0000000000000000000000000000000000000000/my_toolstrip.html

Design Tips

Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.
The toolbar automatically detects how much space a toolstrip needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.
If you need to do more extensive UI, use the tab contents area or a pop up window.
Remember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running application logic, try Background Pages.

diff --git a/chrome/common/extensions/docs/toolstrip.html b/chrome/common/extensions/docs/toolstrip.html index 08b55e2..2e41a2d 100755 --- a/chrome/common/extensions/docs/toolstrip.html +++ b/chrome/common/extensions/docs/toolstrip.html @@ -1 +1 @@ - Toolstrip

Google Chrome Extensions > Reference > chrome.* APIs > Toolstrip

Toolstrip

Google Chrome Extensions > Reference > chrome.* APIs > Toolstrip

Toolstrip

+ chrome.toolstrip API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.toolstrip

chrome.toolstrip

Contents

Description
1. Properties
2. Examples
Methods
1. expand
2. collapse
Events
1. eventName
TODO: Structs

[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?]

Methods

expand

chrome.toolstrip.expand(integer height, string url, function callback)

Undocumented.

Parameters

height (optional integer)

Undocumented.

url (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

collapse

chrome.toolstrip.collapse(string url, function callback)

Undocumented.

Parameters

url (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

chrome.toolstrip API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.toolstrip

chrome.toolstrip

Contents

Description
1. Properties
2. Examples
Methods
1. expand
2. collapse
Events
1. eventName
TODO: Structs

[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?]

Methods

expand

chrome.toolstrip.expand(integer height, string url, function callback)

Undocumented.

Parameters

height (optional integer)

Undocumented.

url (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

collapse

chrome.toolstrip.collapse(string url, function callback)

Undocumented.

Parameters

url (optional string)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

diff --git a/chrome/common/extensions/docs/windows.html b/chrome/common/extensions/docs/windows.html index b96c916..956dd93 100755 --- a/chrome/common/extensions/docs/windows.html +++ b/chrome/common/extensions/docs/windows.html @@ -1 +1 @@ - Windows

Google Chrome Extensions > Reference > chrome.* APIs > Windows

Windows

[PENDING: API Module Overview Goes Here]

+ chrome.windows API Reference

Google Chrome Extensions > Reference > chrome.* APIs > chrome.windows

chrome.windows

Contents

Description
1. Properties
2. Examples
Methods
Events
TODO: Structs

[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?]

[PENDING: API Module Overview Goes Here]

Methods

get

chrome.windows.get(integer windowId, function callback)

Get window with given id.

Parameters

windowId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object window) {...});

window (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
focused (optional boolean): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
bottom (optional integer): Undocumented.; Description of this parameter from the json schema.
right (optional integer): Undocumented.; Description of this parameter from the json schema.
tabs (optional array of object): Undocumented.; Description of this parameter from the json schema.

getCurrent

chrome.windows.getCurrent(function callback)

Get the window that is the container for the caller. i.e. the window containing the ToolStrip that makes the call.

Parameters

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object window) {...});

window (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
focused (optional boolean): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
bottom (optional integer): Undocumented.; Description of this parameter from the json schema.
right (optional integer): Undocumented.; Description of this parameter from the json schema.
tabs (optional array of object): Undocumented.; Description of this parameter from the json schema.

getLastFocused

chrome.windows.getLastFocused(function callback)

Get the window that was most recenly focused -- typically the window 'on top'.

Parameters

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object window) {...});

window (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
focused (optional boolean): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
bottom (optional integer): Undocumented.; Description of this parameter from the json schema.
right (optional integer): Undocumented.; Description of this parameter from the json schema.
tabs (optional array of object): Undocumented.; Description of this parameter from the json schema.

getAll

chrome.windows.getAll(boolean populate, function callback)

Get all windows. If populate is true, each window object will have a tabs property that contains a list of the Tab objects for that window.

Parameters

populate (optional boolean)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(array of object windows) {...});

windows (array of object)

Undocumented.

create

chrome.windows.create(object CreateData, function callback)

Create (open) a new browser with any optional sizing, position or default url provided.

Parameters

CreateData (optional object)

Undocumented.

url (optional string): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
width (optional integer): Undocumented.; Description of this parameter from the json schema.
height (optional integer): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object window) {...});

window (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
focused (optional boolean): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
bottom (optional integer): Undocumented.; Description of this parameter from the json schema.
right (optional integer): Undocumented.; Description of this parameter from the json schema.
tabs (optional array of object): Undocumented.; Description of this parameter from the json schema.

update

chrome.windows.update(integer windowId, object UpdateInfo, function callback)

Undocumented.

Parameters

windowId (optional integer)

Undocumented.

UpdateInfo (optional object)

Undocumented.

left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
width (optional integer): Undocumented.; Description of this parameter from the json schema.
height (optional integer): Undocumented.; Description of this parameter from the json schema.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function(object window) {...});

window (object)

Undocumented.

id (optional integer): Undocumented.; Description of this parameter from the json schema.
focused (optional boolean): Undocumented.; Description of this parameter from the json schema.
left (optional integer): Undocumented.; Description of this parameter from the json schema.
top (optional integer): Undocumented.; Description of this parameter from the json schema.
bottom (optional integer): Undocumented.; Description of this parameter from the json schema.
right (optional integer): Undocumented.; Description of this parameter from the json schema.
tabs (optional array of object): Undocumented.; Description of this parameter from the json schema.

remove

chrome.windows.remove(integer windowId, function callback)

Undocumented.

Parameters

windowId (optional integer)

Undocumented.

callback (optional function)

Undocumented.

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Callback function

If you specify the callback parameter, it should specify a function that looks like this:

function() {...});

paramName (paramType)

Undocumented.

Description of this parameter from the json schema.

paramName (optional paramType): Undocumented.; Description of this parameter from the json schema.

Events

onCreated

chrome.bookmarks.onCreated.addListener(function(integer windowId) {...});

Undocumented.

Parameters

windowId (integer)

Undocumented.

onRemoved

chrome.bookmarks.onRemoved.addListener(function(integer windowId) {...});

Undocumented.

Parameters

windowId (integer)

Undocumented.

onFocusChanged

chrome.bookmarks.onFocusChanged.addListener(function(integer windowId) {...});

Undocumented.

Parameters

windowId (integer)

Undocumented.

diff --git a/chrome/common/extensions/docs/xhr.html b/chrome/common/extensions/docs/xhr.html new file mode 100755 index 0000000..763b689 --- /dev/null +++ b/chrome/common/extensions/docs/xhr.html @@ -0,0 +1 @@ + Xhr

Google Chrome Extensions > Reference > chrome.* APIs > Xhr

Xhr

The standard XMLHttpRequest object can be used to communicate with multiple origins (ie domains) from an extension. You must pre-register the domains you want to talk to in the manifest, like so:

{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "permissions": [ "http://www.blogger.com", "http://*.google.com" ] }

Status

Implemented, but we don't yet enforce the permissions; all origins are allowed for now.

-- cgit v1.1

Api_index

Methods

method name

Parameters

Returns

Callback function

Events

event name

Parameters

Api_index

Methods

method name

Parameters

Returns

Callback function

Events

event name

Parameters

Background_pages

Status

Details

Example

Methods

method name

Parameters

Returns

Callback function

Events

event name

Parameters

Bookmarks

Description

Properties

Examples

Methods

method name

Parameters

Returns

Callback function

Events

event name

Parameters

chrome.bookmarks

Description

Properties

Examples

Methods

get

Parameters

Returns

Callback function

getChildren

Parameters

Returns

Callback function

getTree

Parameters

Returns

Callback function

search

Parameters

Returns

Callback function

create

Parameters

Returns

Callback function

move

Parameters

Returns

Callback function

update

Parameters

Returns

Callback function

remove

Parameters

Returns

Callback function

removeTree