tabs.setZoom()

Zooms the specified tab.

This is an asynchronous function that returns a Promise.

Syntax

js

let zooming = browser.tabs.setZoom(
  tabId,           // optional integer
  zoomFactor       // number
)

Parameters

tabId Optional

integer. The ID of the tab to zoom. Defaults to the active tab of the current window.

zoomFactor

number. The new zoom factor. Use a value of 0 here to set the tab to its current default zoom factor. Otherwise, this must be a number between 0.3 and 5, specifying a zoom factor.

Return value

A Promise that will be fulfilled with no arguments after the zoom factor has been changed. If the tab could not be found or some other error occurs, the promise will be rejected with an error message.

Examples

Set the zoom factor for the current tab to 2:

js

function onError(error) {
  console.log(`Error: ${error}`);
}

let setting = browser.tabs.setZoom(2);
setting.then(null, onError);

Set the zoom factor for the tab whose ID is 16 tab to 0.5:

js

function onError(error) {
  console.log(`Error: ${error}`);
}

let setting = browser.tabs.setZoom(16, 0.5);
setting.then(null, onError);

Example extensions

Browser compatibility

BCD tables only load in the browser

Note: This API is based on Chromium's chrome.tabs API. This documentation is derived from tabs.json in the Chromium code.