runtime.openOptionsPage()

If your add-on has an options page defined, this method opens it.
 

If your add-on does not have an options page, or the browser failed to create one for some other reason, runtime.lastError will be set.

Syntax

chrome.runtime.openOptionsPage(
  function() {...} // optional function
)

This API is also available as browser.runtime.openOptionsPage() in a version that returns a promise.

Parameters

callbackOptional
function. Called when the options page has been created successfully, or after an error has occurred and runtime.lastError has been set.

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() {
  if (chrome.runtime.lastError) {
    console.log(chrome.runtime.lastError);
    // handle the error
  }
}

chrome.browserAction.onClicked.addListener((tab) => {
  chrome.runtime.openOptionsPage(onOpened);
});

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