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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
Basic supportChrome Full support 42Edge No support NoFirefox Full support 48Opera Full support 29Firefox Android Full support 57

Legend

Full support  
Full support
No support  
No support

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: wbamberg, andrewtruongmoz, Makyen, chrisdavidmills, kmaglione
Last updated by: wbamberg,