MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/d6d7ff2e2f9c

Add-ons

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

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic support42No48No29

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

Acknowledgements

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.

Document Tags and Contributors

 Contributors to this page: andrewtruongmoz, wbamberg, Makyen, chrisdavidmills, kmaglione
 Last updated by: andrewtruongmoz,