就像扩展程序可让用户自定义 Chrome 浏览器一样,您可以通过选项页面对扩展程序进行自定义。使用选项来启用特定功能,并允许用户选择与其需求相关的功能。
找到选项页面
用户可以通过以下两种方式访问选项页面:直接链接;或者右键点击工具栏中的扩展程序图标,然后选择相应选项。此外,用户还可以通过以下方式导航到选项页面:首先打开 chrome://extensions
,找到所需扩展程序,点击详细信息,然后选择选项链接。
![界面中的选项页面链接](https://developer.chrome.google.cn/static/docs/extensions/develop/ui/options-page/image/options-page-link-the-us-ae0a3ee5d7b2e.png?authuser=8&hl=nb)
![上下文菜单选项页面](https://developer.chrome.google.cn/static/docs/extensions/develop/ui/options-page/image/context-menu-options-page-3d4d2c8dcce27.png?authuser=8&hl=nb)
编写选项页面
以下是选项页面的示例:
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>
下面是一个选项脚本示例。将其保存在 options.html
所在的文件夹中。这会使用 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);
最后,将 "storage"
权限添加到该扩展程序的清单文件中:
manifest.json:
{
"name": "My extension",
...
"permissions": [
"storage"
]
...
}
声明选项页面行为
附加信息选项页分为两类:整页页和嵌入式页。选项页面的类型取决于其在清单中的声明方式。
整页显示选项
系统会在新标签页中显示整页选项页面。在清单中的 "options_page"
字段中注册选项 HTML 文件。
manifest.json:
{
"name": "My extension",
...
"options_page": "options.html",
...
}
![整页显示选项](https://developer.chrome.google.cn/static/docs/extensions/develop/ui/options-page/image/full-page-options-06cf906a1303e.png?authuser=8&hl=nb)
嵌入式选项
通过嵌入式选项页面,用户无需离开嵌入式框内的扩展程序管理页面,即可调整扩展程序选项。如需声明嵌入式选项,请在扩展程序清单中的 "options_ui"
字段下注册 HTML 文件,并将 "open_in_tab"
键设置为 false
。
manifest.json:
{
"name": "My extension",
...
"options_ui": {
"page": "options.html",
"open_in_tab": false
},
...
}
![嵌入式选项](https://developer.chrome.google.cn/static/docs/extensions/develop/ui/options-page/image/embedded-options-7de329f362ce.png?authuser=8&hl=nb)
page
(字符串)- 指定选项页面相对于扩展程序根目录的路径。
open_in_tab
(boolean)- 用于指示是否在新标签页中打开扩展程序的选项页面。如果设为
false
,该扩展程序的选项页面会嵌入chrome://extensions
中,而不会在新标签页中打开。
考虑不同之处
chrome://extensions
中嵌入的选项页面与标签页中的选项页面存在细微的行为差异。
指向选项页面的链接
扩展程序可以通过调用 chrome.runtime.openOptionsPage()
直接链接到选项页面。例如,可以将其添加到弹出式窗口中:
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
由于嵌入式选项代码未托管在标签页中,因此无法使用 Tabs API。如果选项页面确实需要处理包含的标签页,请改用 runtime.connect()
和 runtime.sendMessage()
。
Messaging API
如果扩展程序的选项页面使用 runtime.connect()
或 runtime.sendMessage()
发送消息,则不会设置发送者的标签页,而发送者的网址将是选项页面的网址。
大小
嵌入的选项应根据网页内容自动确定其自己的大小。但是,对于某些类型的内容,嵌入式框可能没有合适的大小。此问题最常见于根据窗口大小调整内容形状的选项页面。
如果这是一个问题,请为选项页面提供固定的最小尺寸,以确保嵌入式网页能够找到合适的尺寸。