sidebarAction.setTitle()

設定側邊欄的標題。該標題會在瀏覽器列出可用側邊欄的任何地方顯示。例如,Firefox 會在“檢視 > 側邊欄”選單中顯示它。側邊欄開啟時,標題也會顯示在側邊欄頂部。

標題的型別

您的擴充套件應該在 sidebar_action manifest 鍵中為側邊欄指定一個標題。這被稱為“manifest 標題”。如果您不指定 manifest 標題,它將預設為副檔名。

如果您使用 setTitle() 設定新標題,幷包含 tabId 選項,則該標題僅為給定的標籤頁設定。這被稱為“標籤頁特定標題”

如果您使用 setTitle() 設定新標題,幷包含 windowId 選項,則該標題僅為給定的視窗設定。這被稱為“視窗特定標題”,並且會出現在該視窗中所有未設定標籤頁特定標題的標籤頁上。

如果您使用 setTitle() 設定新標題,並省略 tabIdwindowId 選項,則會設定“全域性標題”。全域性標題將顯示在所有未設定標籤頁特定標題且其視窗未設定視窗特定標題的標籤頁上。

語法

js
browser.sidebarAction.setTitle(
  details // object
)

引數

details

object。一個具有以下屬性的物件。

title

stringnull。側邊欄的新標題。

如果 title 是一個空字串,則使用的標題將是副檔名,但 sidebarAction.getTitle 仍會返回空字串。

如果 titlenull,則會移除之前設定的標題,以便

  • 如果指定了 tabId,並且該標籤頁設定了標籤頁特定標題,那麼該標籤頁將繼承它所屬視窗的標題。
  • 如果指定了 windowId,並且該視窗設定了視窗特定標題,那麼該視窗將繼承全域性標題。
  • 否則,全域性標題將重置為 manifest 標題。
tabId 可選

integer。僅為給定的標籤頁設定標題。

windowId 可選

integer。僅為給定的視窗設定標題。

  • 如果同時提供了 windowIdtabId,則函式會失敗,標題不會被設定。
  • 如果同時省略了 windowIdtabId,則會設定全域性標題。

示例

此程式碼會在使用者點選瀏覽器操作時更改側邊欄的標題,但僅針對當前標籤頁。

js
let title = "A different title";

function setTitleForTab(tab) {
  browser.sidebarAction.setTitle({ title, tabId: tab.id });
}

browser.browserAction.onClicked.addListener(setTitleForTab);

瀏覽器相容性

注意:此 API 基於 Opera 的 chrome.sidebarAction API。