W3cubDocs

/Web Extensions

runtime.openOptionsPage()

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

This is an asynchronous function that returns a Promise.

Syntax

var 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

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
openOptionsPage
42
79
48
?
29
14
?
?
57
?
?
?

Examples

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

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

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

var 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.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/openOptionsPage