tabs.captureTab()
Creates a data URI encoding the image of an area of the given tab. You must have the <all_urls>
permission to use this method.
This is an asynchronous function that returns a Promise
.
Syntax
var capturing = browser.tabs.captureTab(
tabId, // optional integer
options // optional extensionTypes.ImageDetails
)
Parameters
tabId
Optionalinteger
. ID of the tab to capture. Defaults to the active tab in the current window.options
OptionalextensionTypes.ImageDetails
.
Return value
A Promise
that will be fulfilled with a data URL which encodes the captured image. May be assigned to the 'src' property of an HTML Image element for display. If any error occurs the promise will be rejected with an error message.
Examples
Capture an image of the active tab in the current window, with default settings:
function onCaptured(imageUri) {
console.log(imageUri);
}
function onError(error) {
console.log(`Error: ${error}`);
}
browser.browserAction.onClicked.addListener(function() {
var capturing = browser.tabs.captureTab();
capturing.then(onCaptured, onError);
});
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
captureTab | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support59 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support82 |
Legend
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Acknowledgements
This API is based on Chromium's chrome.tabs
API. This documentation is derived from tabs.json
in the Chromium code.