Google Chrome Extensions (Labs)

Getting Started
Overview
What's New?
Developer's Guide
- Browser UI
- Browser Interaction
  - Bookmarks
  - Cookies
  - Events
  - History
  - Management
  - Tabs
  - Windows
- Implementation
- Finishing
  - Hosting
  - Other Deployment Options
Packaged Apps
Tutorials
Reference
- Formats
  - Manifest Files
  - Match Patterns
- Permission Warnings
- chrome.* APIs
- Other APIs
Samples

Tabs

Manifest
1. h3Name
Examples
1. h3Name
API reference: chrome.tabs

Tabs

Use the chrome.tabs module to interact with the browser's tab system. You can use this module to create, modify, and rearrange tabs in the browser.

Manifest

Almost all chrome.tabs methods require you to declare the "tabs" permission in the extension manifest. For example:

{
  "name": "My extension",
  ...
  "permissions": [
    "tabs"
  ],
  ...
}

Three methods (create, update and remove) and one event (onRemoved) don't require the "tabs" permission.

Examples

You can find simple examples of using the tabs module in the examples/api/tabs directory. For other examples and for help in viewing the source code, see Samples.

API reference: chrome.tabs

Methods

captureVisibleTab

chrome.tabs.captureVisibleTab(integer windowId, object options, function callback)

Captures the visible area of the currently active tab in the specified window. You must have host permission for the URL displayed by the tab.

Parameters

windowId ( optional enumerated integer ): Undocumented.; The target window. Defaults to the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
options ( optional enumerated object ): Undocumented.; Set parameters of image capture, such as the format of the resulting image.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; format
( optional enumerated string ["jpeg", "png"] )

Undocumented.

The format of the resulting image. Default is jpeg.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

quality
( optional enumerated integer )

Undocumented.

When format is 'jpeg', controls the quality of the resulting image. This value is ignored for PNG images. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(string dataUrl) {...};

dataUrl ( optional enumerated string ): Undocumented.; A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

connect

Port chrome.tabs.connect(integer tabId, object connectInfo)

Connects to the content script(s) in the specified tab. The chrome.extension.onConnect event is fired in each content script running in the specified tab for the current extension. For more details, see Content Script Messaging.

Parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
connectInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; name
( optional enumerated string )

Undocumented.

Will be passed into onConnect for content scripts that are listening for the connection event.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Returns

paramName ( optional enumerated Port ): Undocumented.; A port that can be used to communicate with the content scripts running in the specified tab. The port's onDisconnect event is fired if the tab closes or does not exist.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

create

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

Creates a new tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.

Parameters

createProperties ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

The window to create the new tab in. Defaults to the current window.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

index
( optional enumerated integer )

Undocumented.

The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

url
( optional enumerated string )

Undocumented.

The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

active
( optional enumerated boolean )

Undocumented.

Whether the tab should become the active tab in the window. Defaults to true

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

pinned
( optional enumerated boolean )

Undocumented.

Whether the tab should be pinned. Defaults to false

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function(Tab tab) {...};

tab ( optional enumerated Tab ): Undocumented.; Details about the created tab. Will contain the ID of the new tab.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

detectLanguage

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

Detects the primary language of the content in a tab.

Parameters

tabId ( optional enumerated integer ): Undocumented.; Defaults to the active tab of the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(string language) {...};

language ( optional enumerated string ): Undocumented.; An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, und will be returned.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

executeScript

chrome.tabs.executeScript(integer tabId, object details, function callback)

Injects JavaScript code into a page. For details, see the programmatic injection section of the content scripts doc.

Parameters

tabId ( optional enumerated integer ): Undocumented.; The ID of the tab in which to run the script; defaults to the active tab of the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
details ( optional enumerated object ): Undocumented.; Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; code
( optional enumerated string )

Undocumented.

JavaScript code to execute.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

file
( optional enumerated string )

Undocumented.

JavaScript file to execute.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

allFrames
( optional enumerated boolean )

Undocumented.

If allFrames is true, this function injects script into all frames of current page. By default, it's false and script is injected only into the top main frame.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Called after all the JavaScript has been executed.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function() {...};

get

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

Retrieves details about the specified tab.

Parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(Tab tab) {...};

tab ( optional enumerated Tab ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

getCurrent

chrome.tabs.getCurrent(function callback)

Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view).

Parameters

callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(Tab tab) {...};

tab ( optional enumerated Tab ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

highlight

chrome.tabs.highlight(object highlightInfo, function callback)

Highlights the given tabs.

Parameters

highlightInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

The window that contains the tabs.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

tabs
( optional enumerated array of integer or integer )

Undocumented.

One or more tab indices to highlight.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(Window window) {...};

window ( optional enumerated Window ): Undocumented.; Contains details about the window whose tabs were highlighted.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

insertCSS

chrome.tabs.insertCSS(integer tabId, object details, function callback)

Injects CSS into a page. For details, see the programmatic injection section of the content scripts doc.

Parameters

tabId ( optional enumerated integer ): Undocumented.; The ID of the tab in which to insert the CSS; defaults to the active tab of the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
details ( optional enumerated object ): Undocumented.; Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; code
( optional enumerated string )

Undocumented.

CSS code to be injected.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

file
( optional enumerated string )

Undocumented.

CSS file to be injected.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

allFrames
( optional enumerated boolean )

Undocumented.

If allFrames is true, this function injects CSS text into all frames of current page. By default, it's false and CSS is injected only into the top main frame.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Called when all the CSS has been inserted.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function() {...};

move

chrome.tabs.move(integer or array of integer tabIds, object moveProperties, function callback)

Moves one or more tabs to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === "normal") windows.

Parameters

tabIds ( optional enumerated integer or array of integer ): Undocumented.; The tab or list of tabs to move.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
moveProperties ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

Defaults to the window the tab is currently in.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

index
( optional enumerated integer )

Undocumented.

The position to move the window to. The provided value will be clamped to between zero and the number of tabs in the window.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function(Tab or array of Tab tabs) {...};

tabs ( optional enumerated Tab or array of Tab ): Undocumented.; Details about the moved tabs.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

query

chrome.tabs.query(object queryInfo, function callback)

Gets all tabs that have the specified properties, or all tabs if no properties are specified.

Parameters

queryInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; active
( optional enumerated boolean )

Undocumented.

Whether the tabs are active in their windows.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

pinned
( optional enumerated boolean )

Undocumented.

Whether the tabs are pinned.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

highlighted
( optional enumerated boolean )

Undocumented.

Whether the tabs are highlighted.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

status
( optional enumerated string ["loading", "complete"] )

Undocumented.

Whether the tabs have completed loading.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

title
( optional enumerated string )

Undocumented.

Match page titles against a pattern.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

url
( optional enumerated string )

Undocumented.

Match tabs against a URL pattern.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

windowId
( optional enumerated integer )

Undocumented.

The ID of the parent window.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

windowType
( optional enumerated string ["normal", "popup", "panel", "app"] )

Undocumented.

The type of window the tabs are in.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

The callback parameter should specify a function that looks like this:

function(array of Tab undefined) {...};

paramName ( optional enumerated array of Tab paramType ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

reload

chrome.tabs.reload(integer tabId, object reloadProperties, function callback)

Reload a tab.

Parameters

tabId ( optional enumerated integer ): Undocumented.; The ID of the tab to reload; defaults to the selected tab of the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
reloadProperties ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; bypassCache
( optional enumerated boolean )

Undocumented.

Whether using any local cache. Default is false.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function() {...};

remove

chrome.tabs.remove(integer or array of integer tabIds, function callback)

Closes one or more tabs. Note: This function can be used without requesting the 'tabs' permission in the manifest.

Parameters

tabIds ( optional enumerated integer or array of integer ): Undocumented.; The tab or list of tabs to close.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function() {...};

sendRequest

chrome.tabs.sendRequest(integer tabId, any request, function responseCallback)

Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The chrome.extension.onRequest event is fired in each content script running in the specified tab for the current extension.

Parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
request ( optional enumerated any ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
responseCallback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; Parameters

response
( optional enumerated any )

Undocumented.

The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function(any response) {...};

response ( optional enumerated any ): Undocumented.; The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and chrome.extension.lastError will be set to the error message.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

update

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

Modifies the properties of a tab. Properties that are not specified in updateProperties are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.

Parameters

tabId ( optional enumerated integer ): Undocumented.; Defaults to the selected tab of the current window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
updateProperties ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; url
( optional enumerated undefined )

Undocumented.

A URL to navigate the tab to.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

active
( optional enumerated boolean )

Undocumented.

Whether the tab should be active.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

highlighted
( optional enumerated boolean )

Undocumented.

Adds or removes the tab from the current selection.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

pinned
( optional enumerated boolean )

Undocumented.

Whether the tab should be pinned.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
callback ( optional enumerated function ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Callback function

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

function(Tab tab) {...};

tab ( optional enumerated Tab ): Undocumented.; Details about the updated tab, or null if the 'tabs' permission has not been requested.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Events

onActiveChanged

chrome.tabs.onActiveChanged.addListener(function(integer tabId, object selectInfo) {...});

Fires when the selected tab in a window changes.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; The ID of the tab that has become active.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
selectInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

The ID of the window the selected tab changed inside of.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onAttached

chrome.tabs.onAttached.addListener(function(integer tabId, object attachInfo) {...});

Fired when a tab is attached to a window, for example because it was moved between windows.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
attachInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; newWindowId
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

newPosition
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onCreated

chrome.tabs.onCreated.addListener(function(Tab tab) {...});

Fired when a tab is created. Note that the tab's URL may not be set at the time this event fired, but you can listen to onUpdated events to be notified when a URL is set.

Listener parameters

tab ( optional enumerated Tab ): Undocumented.; Details of the tab that was created.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onDetached

chrome.tabs.onDetached.addListener(function(integer tabId, object detachInfo) {...});

Fired when a tab is detached from a window, for example because it is being moved between windows.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
detachInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; oldWindowId
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

oldPosition
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onHighlightChanged

chrome.tabs.onHighlightChanged.addListener(function(object selectInfo) {...});

Fired when the highlighted or selected tabs in a window changes.

Listener parameters

selectInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

The window whose tabs changed.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

tabIds
( optional enumerated array of integer paramType )

Undocumented.

All highlighted tabs in the window.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onMoved

chrome.tabs.onMoved.addListener(function(integer tabId, object moveInfo) {...});

Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see onDetached.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
moveInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; windowId
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

fromIndex
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

toIndex
( optional enumerated integer )

Undocumented.

Description of this parameter from the json schema.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onRemoved

chrome.tabs.onRemoved.addListener(function(integer tabId, object removeInfo) {...});

Fired when a tab is closed. Note: A listener can be registered for this event without requesting the 'tabs' permission in the manifest.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
removeInfo ( optional enumerated object ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; isWindowClosing
( optional enumerated boolean )

Undocumented.

True when the tab is being closed because its window is being closed.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

onUpdated

chrome.tabs.onUpdated.addListener(function(integer tabId, object changeInfo, Tab tab) {...});

Fired when a tab is updated.

Listener parameters

tabId ( optional enumerated integer ): Undocumented.; Description of this parameter from the json schema.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
changeInfo ( optional enumerated object ): Undocumented.; Lists the changes to the state of the tab that was updated.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.; status
( optional enumerated string )

Undocumented.

The status of the tab. Can be either loading or complete.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

url
( optional enumerated string )

Undocumented.

The tab's URL if it has changed.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

pinned
( optional enumerated boolean )

Undocumented.

The tab's new pinned state.

This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
tab ( optional enumerated Tab ): Undocumented.; Gives the state of the tab that was updated.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Types

Tab

( optional enumerated object )

Undocumented.

id ( optional enumerated integer ): Undocumented.; The ID of the tab. Tab IDs are unique within a browser session.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
index ( optional enumerated integer ): Undocumented.; The zero-based index of the tab within its window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
windowId ( optional enumerated integer ): Undocumented.; The ID of the window the tab is contained within.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
highlighted ( optional enumerated boolean ): Undocumented.; Whether the tab is highlighted.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
active ( optional enumerated boolean ): Undocumented.; Whether the tab is active in its window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
pinned ( optional enumerated boolean ): Undocumented.; Whether the tab is pinned.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
url ( optional enumerated string ): Undocumented.; The URL the tab is displaying.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
title ( optional enumerated string ): Undocumented.; The title of the tab. This may not be available if the tab is loading.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
favIconUrl ( optional enumerated string ): Undocumented.; The URL of the tab's favicon. This may not be available if the tab is loading.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
status ( optional enumerated string ): Undocumented.; Either loading or complete.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.
incognito ( optional enumerated boolean ): Undocumented.; Whether the tab is in an incognito window.; This parameter was added in version . You must omit this parameter in earlier versions, and you may omit it in any version. If you require this parameter, the manifest key minimum_chrome_version can ensure that your extension won't be run in an earlier browser version.

Parameters

Google Chrome Extensions (Labs)

Developer's Guide

Packaged Apps

Tutorials

Reference

Samples

More

Tabs

Contents

Manifest

Examples

API reference: chrome.tabs

Properties

getLastError

Methods

captureVisibleTab

Parameters

Returns

Callback function

connect

Parameters

Returns

Callback function

create

Parameters

Returns

Callback function

detectLanguage

Parameters

Returns

Callback function

executeScript

Parameters

Returns

Callback function

get

Parameters

Returns

Callback function

method name

Parameters

Returns

Callback function

getCurrent

Parameters

Returns

Callback function

method name

Parameters

Returns

Callback function

highlight

Parameters

Returns

Callback function

insertCSS

Parameters

Returns

Callback function

move

Parameters

Returns

Callback function

query

Parameters

Returns

Callback function

reload

Parameters

Returns

Callback function

remove

Parameters

Returns

Callback function

sendRequest

Parameters

Parameters

Returns