Give users options
Published on • Updated on
Just as extensions allow users to customize the Chrome browser, the options page enables customization of the extension. Use options to enable features and allow users to choose what functionality is relevant to their needs.
Locating the options page
Users can access the options page by direct link or by right-clicking the extension icon in the toolbar and then selecting options. Additionally, users can navigate to the Extensions page at chrome://extensions, locate the desired extension, click Details, and then select the options link.
Write the options page
The following is an example of an options page:
options.html:
<!DOCTYPE html>
<html>
<head>
<title>My Test Extension Options</title>
</head>
<body>
<select id="color">
<option value="red">red</option>
<option value="green">green</option>
<option value="blue">blue</option>
<option value="yellow">yellow</option>
</select>
<label>
<input type="checkbox" id="like" />
I like colors.
</label>
<div id="status"></div>
<button id="save">Save</button>
<script src="options.js"></script>
</body>
</html>Below is an example options script. Save it in the same folder as options.html. This saves the user's preferred options across devices using the storage.sync API.
options.js:
// Saves options to chrome.storage
const saveOptions = () => {
const color = document.getElementById('color').value;
const likesColor = document.getElementById('like').checked;
chrome.storage.sync.set(
{ favoriteColor: color, likesColor: likesColor },
() => {
// Update status to let user know options were saved.
const status = document.getElementById('status');
status.textContent = 'Options saved.';
setTimeout(() => {
status.textContent = '';
}, 750);
}
);
};
// Restores select box and checkbox state using the preferences
// stored in chrome.storage.
const restoreOptions = () => {
chrome.storage.sync.get(
{ favoriteColor: 'red', likesColor: true },
(items) => {
document.getElementById('color').value = items.favoriteColor;
document.getElementById('like').checked = items.likesColor;
}
);
};
document.addEventListener('DOMContentLoaded', restoreOptions);
document.getElementById('save').addEventListener('click', saveOptions);Finally, add the "storage" permission to the extension's manifest file:
manifest.json:
{
"name": "My extension",
...
"permissions": [
"storage"
]
...
}Declare options page behavior
There are two available types of extension options pages, full page and embedded. The type of options page is determined by how it is declared in the manifest.
Full page options
An extension's options page is displayed in a new tab. The options HTML file is registered under the "options_page" field.
manifest.json:
{
"name": "My extension",
...
"options_page": "options.html",
...
}
Embedded options
Embedded options allows users to adjust extension options without navigating away from the extensions management page inside an embedded box. To declare embedded options, register the HTML file under the "options_ui" field in the extension manifest, with the "open_in_tab" key set to false.
manifest.json:
{
"name": "My extension",
...
"options_ui": {
"page": "options.html",
"open_in_tab": false
},
...
}
page(string)- Path to the options page, relative to the extension's root.
open_in_tab(boolean)- Specify as
falseto declare an embedded options page. Iftrue, the extension's options page will be opened in a new tab rather than embedded in chrome://extensions.
Consider the differences
Options pages embedded inside chrome://extensions have subtle behavior differences from options pages in tabs.
Linking to the options page
An extension can link directly to the options page by calling chrome.runtime.openOptionsPage(). For example, it can be added to a popup:
popup.html:
<button id="go-to-options">Go to options</button>
<script src="popup.js"></script>popup.js:
document.querySelector('#go-to-options').addEventListener('click', function() {
if (chrome.runtime.openOptionsPage) {
chrome.runtime.openOptionsPage();
} else {
window.open(chrome.runtime.getURL('options.html'));
}
});Tabs API
Extension embedded options page code is not hosted inside a tab, affecting how the Tabs API can be used:
tabs.query()will never find a tab within an extension's options page URL.tabs.onCreatedwill not fire when the options page is opened.tabs.onUpdatedwill not fire when the options page load state changes.tabs.connect()ortabs.sendMessage()cannot be used to communicate with the options page.
Use runtime.connect() and runtime.sendMessage() to work around these restrictions, if the options page does need to manipulate the containing tab.
Messaging APIs
If an extension's options page sends a message using runtime.connect() or runtime.sendMessage(), the sender's tab will not be set, and the sender's URL will be the options page URL.
Sizing
The embedded options should automatically determine their own size based on the page content. However, the embedded box may not find a good size for some types of content. This problem is most common for options pages that adjust their content shape based on window size.
If this is an issue, provide fixed minimum dimensions for the options page to ensure that the embedded page will find an appropriate size.
Updated on • Improve article