runtime.openOptionsPage()

If your extension has an options page defined, this method opens it.

This is an asynchronous function that returns a Promise.

Syntax

js
let openingPage = browser.runtime.openOptionsPage()

Parameters

None.

Return value

A Promise that will be fulfilled with no arguments when the options page has been created successfully, or rejected with an error message if the operation failed.

Browser compatibility

Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
openOptionsPage

Examples

Open the options page when the user clicks a browser action's icon:

js
function onOpened() {
  console.log(`Options page opened`);
}

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

let opening = browser.runtime.openOptionsPage();
opening.then(onOpened, onError);

Example extensions

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