runtime.openOptionsPage()

If your add-on 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

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 48.0 No 33

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 add-ons

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