sidebar_action

型別 Object
必填
Manifest 版本 2 或更高
示例
json
"sidebar_action": {
  "default_icon": {
    "16": "button/geo-16.png",
    "32": "button/geo-32.png"
  },
  "default_title": "My sidebar",
  "default_panel": "sidebar/sidebar.html",
  "open_at_install":true
}

一個側邊欄是在網頁旁邊,顯示在瀏覽器視窗左側的窗格。瀏覽器提供了一個使用者介面,允許使用者檢視當前可用的側邊欄並選擇要顯示的側邊欄。

sidebar_action 鍵使您能夠定義側邊欄的預設屬性。您可以使用sidebarAction API 在執行時更改這些屬性。

語法

sidebar_action 鍵是一個物件,可以包含下面列出的任何屬性。唯一強制的屬性是 default_panel

名稱 型別 描述
browser_style
可選
已棄用 在 Manifest V3 中。
Boolean

可選,預設為

  • Manifest V2 和 Firefox 115 之前的 Manifest V3 中為 true
  • Firefox 115 及更高版本的 Manifest V3 中為 false

請勿將 browser_style 設定為 true:從 Firefox 118 開始,Manifest V3 不支援它。請參閱browser_style 的 Manifest V3 遷移

在 Firefox 中,可以在 chrome://browser/content/extension.css 或 macOS 上的 chrome://browser/content/extension-mac.css 中找到樣式表。設定尺寸時,請注意此樣式表設定了 box-sizing: border-box(請參閱box-sizing)。

default_icon
可選
ObjectString

使用此項為側邊欄指定一個或多個圖示。該圖示顯示在瀏覽器 UI 中,用於開啟和關閉側邊欄。

圖示指定為相對於 manifest.json 檔案本身的 URL。

您可以透過在此處提供一個字串來指定單個圖示檔案。

json
"default_icon": "path/to/geo.svg"

要指定不同尺寸的多個圖示,請在此處指定一個物件。每個屬性的名稱是圖示的畫素高度,並且必須可轉換為整數。值是 URL。例如:

json
    "default_icon": {
      "16": "path/to/geo-16.png",
      "32": "path/to/geo-32.png"
    }

有關此方面的更多指導,請參閱選擇圖示尺寸

此屬性是可選的:如果省略,側邊欄將沒有圖示。

default_panel String

指向一個 HTML 檔案的路徑,該檔案指定側邊欄的內容。

HTML 檔案可以使用 <link><script> 元素包含 CSS 和 JavaScript 檔案,就像普通網頁一樣。

與普通網頁不同,在面板中執行的 JavaScript 可以訪問所有WebExtension API(當然,這取決於擴充套件是否具有適當的許可權)。

此屬性是必需的。

這是一個 可本地化屬性

default_title
可選
String

側邊欄的標題。這用於瀏覽器 UI 中列出和開啟側邊欄,並在側邊欄開啟時顯示在頂部。

此屬性是可選的:如果省略,側邊欄的標題將是擴充套件的 name

這是一個 可本地化屬性

open_at_install
可選
Boolean 可選,預設為 true。確定側邊欄是否應在安裝時開啟。預設行為是在安裝完成後開啟側邊欄。

示例

json
"sidebar_action": {
  "default_icon": "sidebar.svg",
  "default_title": "My sidebar!",
  "default_panel": "sidebar.html"
}

要檢視使用側邊欄的擴充套件示例,請參閱annotate-page

瀏覽器相容性

另見