一年前的 2022 年 5 月,我们在 Chrome 中添加了侧边栏。这是一款全新的辅助界面,可让用户在浏览内容的同时利用各种工具。今天,我们很高兴地宣布,从 Chrome 114 开始,您的扩展程序可以开始在侧边栏中显示内容。
对用户更好,对开发者来说也更简单
我们已经看到许多开发者在其扩展程序中实现了类似边栏的体验,因此我们很高兴将其作为平台标准。借助新的 Side Panel API,您现在可以提供一个持久的界面,该界面会随用户正在访问的页面一起打开。扩展程序之间保持一致的位置和布局对用户来说很有益。此外,无需请求主机权限即可显示界面,这对用户来说是一项重要的隐私保护功能,还有一个额外的好处,即减少在安装时针对您的扩展程序显示的警告数量。
侧边栏 API 可消除向不可信页面注入内容时遇到的麻烦。此外,它还大大减少了在不同网站上保持兼容性的需求,并减少了筛选有关您的扩展程序意外中断的 bug 报告的工作量。
整个网络中的用户的好帮手
在扩展程序中构建新的侧边栏体验时,您需要牢记一件事:您将如何帮助用户完成各种 Web 任务?以下是您应该考虑的几个问题:
- 边栏对用户有何帮助?
- 单一用途政策也适用于侧边栏。请确保您的侧边栏提供的功能与扩展程序的其余部分以及用户尝试实现的目标直接相关。
- 我的侧边栏是否仅在相关时才显示?
- 借助 Side Panel API,您可以选择要在哪些网站上向用户显示侧边栏。这样,您就可以避免在广告与用户无关或与用户正在浏览的内容无关时展示广告。
- 该图标的设计是否与扩展程序的其余部分保持一致?
- 边栏应采用美观的设计,与您的扩展程序和商品详情的徽标、颜色、图标和字体相匹配。这样,无论用户在何处使用您的扩展程序,都能获得一致且易于识别的体验。
- 用户如何发现我的侧边栏?
- 在扩展程序中提供充足的文档或培训,让新用户了解如何使用侧边栏。这有助于留住用户,并避免商品详情中出现差评。请注意,您可以在商家信息中添加演示扩展程序运作方式的 YouTube 视频,以便在用户安装扩展程序之前先教他们如何使用。
我们还更新了计划政策,更新了最佳实践和质量指南部分,以反映这些考虑因素。这些更改强调,侧边栏应通过提供补充功能,为用户浏览体验提供帮助。还明确说明您的侧边栏不应放置不必要的干扰元素。
API 概览
若要让您的扩展程序显示在侧边栏中,请在manifest中请求 "sidePanel"
权限,并添加 "side_panel"
键以及指向该扩展程序中网页的 "default_path"
:
manifest.json:
{
...
"side_panel": {
"default_path": "sidepanel.html"
},
"permissions": [
"sidePanel"
]
...
}
在侧边栏页面上,您可以加载脚本和附加电话信息 API,就像在其他任何附加信息页面上一样。侧边栏的图标将取自扩展程序的图标,请务必设置该图标,以进一步优化扩展程序。
额外功能
您可以将侧边栏与操作图标相关联,以便随时轻松打开侧边栏:
service-worker.js:
await chrome.sidePanel.setPanelBehavior({ openPanelOnActionClick: true });
如果您只希望侧边栏显示在特定网页上,可以进行相应控制,以防止其显示在与用户无关的其他位置:
service-worker.js:
chrome.tabs.onUpdated.addListener((tabId, info, tab) => {
if (!tab.url) return;
const url = new URL(tab.url);
if (url.origin === 'https://example.com') {
chrome.sidePanel.setOptions({ tabId, path: 'sidepanel.html', enabled: true });
} else {
chrome.sidePanel.setOptions({ tabId, enabled: false });
}
});
了解详情
我们已发布 Side Panel API 文档,您可以立即开始阅读。我们还在 chrome-extensions-samples 代码库中添加了示例,您可以通过这些示例了解如何在实践中使用该 API。
如前所述,我们还修订了政策页面和最佳实践,以便详细介绍如何构建侧边栏,为用户提供最佳体验。
您可以访问我们的“新变化”页面,及时了解 Chrome 扩展程序的最新动态。如果您对侧边栏 API 有疑问或需要帮助,可以访问 Chromium 扩展程序 Google 群组。
照片由 Vardan Papikyan 拍摄,选自 Unsplash