一跳仿、類型（Types）

一、OpenPopupOptions

1. 屬性

• windowId: number 可選
  • 打開操作彈出式窗口的窗口 ID菲语。如果未指定妄辩，則默認為當前活動窗口。

二山上、TabDetails

1. 屬性

• tabId: number 可選
  • 要查詢其狀態(tài)的標簽頁 ID眼耀。如果未指定標簽頁，則返回非標簽頁專屬狀態(tài)胶哲。

三畔塔、UserSettings

與擴展程序操作相關的用戶指定設置的集合。

1. 屬性

• isOnToolbar: boolean
  • 擴展程序的操作圖標是否顯示在瀏覽器窗口的頂級工具欄中（例如鸯屿，用戶是否已“固定”擴展程序）澈吨。

二、方法（Methods）

一寄摆、disable()

停用標簽頁操作谅辣。

1. 示例

chrome.action.disable(
  tabId?: number,
  callback?: function,
)

2. 參數(shù)

• tabId: number 可選
  • 要為其修改操作的標簽頁的 ID。
• callback: function（可選）
  • callback 參數(shù)如下所示：

()=>void

3. 返回

• Promise<void>

二婶恼、enable()

為標簽頁啟用操作桑阶。默認情況下，操作處于啟用狀態(tài)勾邦。

1. 示例

chrome.action.enable(
  tabId?: number,
  callback?: function,
)

2. 參數(shù)

• tabId: number 可選
  • 要為其修改操作的標簽頁的 ID蚣录。
• callback: function（可選）
  • callback 參數(shù)如下所示

()=>void

3. 返回

• Promise<void>

三、getBadgeBackgroundColor()

獲取操作的背景顏色眷篇。

1. 示例

chrome.action.getBadgeBackgroundColor(
  details: TabDetails,
  callback?: function,
)

2. 參數(shù)

• details: TabDetails
• callback function（可選）
  • callback 參數(shù)如下所示

(result:ColorArray)=>void

3. 返回

• Promise< browserAction.ColorArray >
  • ColorArray: [number, number, number, number]

四萎河、getBadgeText()

獲取操作的標記文本。

如果未指定標簽頁蕉饼，則返回非標簽頁專用標志文本虐杯。如果啟用了 displayActionCountAsBadgeText，則系統(tǒng)將返回占位符文本昧港，除非存在 declarativeNetRequestFeedback 權限或提供了標簽頁專用的標記文本擎椰。

1. 示例

chrome.action.getBadgeText(
  details: TabDetails,
  callback?: function,
)

2. 參數(shù)

• details: TabDetails
• callback: function（可選）
  • callback 參數(shù)如下所示：

(result: string)=>void

3. 返回

• Promise<string>

五、getBadgeTextColor()

獲取操作的文本顏色创肥。

1. 示例

chrome.action.getBadgeTextColor(
  details: TabDetails,
  callback?: function,
)

2. 參數(shù)

• details: TabDetails
• callback functioon（可選）
  • callback 參數(shù)如下所示：

(result: ColorArray)=>void

3. 返回

• Promise< browserAction.ColorArray >

六达舒、getPopup()

獲取設置為此操作的彈出式窗口的 HTML 文檔值朋。

1. 示例

chrome.action.getPopup(
  details: TabDetails,
  callback?: function,
)

2. 參數(shù)

• details: TabDetails
• callback function（可選）
  • callback 參數(shù)如下所示：

(result:string)=>void

3. 返回

• Promise<string>

七、getTitle()

獲取操作的標題休弃。

1. 示例

chrome.action.getTitle(
  details: TabDetails,
  callback?: function,
)

2. 參數(shù)

• details: TabDetails
• callback: function（可選）
  • callback 參數(shù)如下所示：

(result: string)=>void

3. 返回

• Promise<string>

八吞歼、getUserSettings()

返回與擴展程序操作相關的用戶指定設置。

1. 示例

chrome.action.getUserSettings(
  callback?: function,
)

2. 參數(shù)

• callback: function（可選）
  • callback 參數(shù)如下所示：

(userSettings: UserSettings)=>void

3. 返回

• Promise< UserSettings >

九塔猾、isEnabled()

指示是否已為標簽頁啟用擴展程序操作（如果未提供 tabId篙骡，則是在全局范圍內(nèi)啟用）。僅使用 declarativeContent 啟用的操作始終返回 false丈甸。

1. 示例

chrome.action.isEnabled(
  tabId?: number,
  callback?: function,
)

2. 參數(shù)

• tabId: number 可選
  • 要檢查其啟用狀態(tài)的標簽頁的 ID得湘。
• callback: function（可選）
  • callback 參數(shù)如下所示：

(isEnabled: boolean)=>void

3. 返回

• Promise<boolean>

十鸿吆、openPopup()

打開擴展程序的彈出式窗口思犁。

1. 示例

chrome.action.openPopup(
  options?: OpenPopupOptions,
  callback?: function,
)

2. 參數(shù)

• options: OpenPopupOptions 可選
  • 指定用于打開彈出式窗口的選項江掩。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十一、setBadgeBackgroundColor()

設置標志的背景顏色任洞。

1. 示例

chrome.action.setBadgeBackgroundColor(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • color: string|ColorArray
    • ColorArray一個由 [0,255] 范圍內(nèi)的四個整數(shù)組成的數(shù)組，這些整數(shù)構成了徽章的 RGBA 顏色。例如步责，不透明的紅色為 [255, 0, 0, 255]省核。也可以是具有 CSS 值的字符串，其中不透明紅色為 #FF0000 或 #F00气忠。
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間邻储。關閉標簽頁后自動重置。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十二旧噪、setBadgeText()

設置操作的標記文本吨娜。標記會顯示在圖標頂部。

1. 示例

chrome.action.setBadgeText(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間淘钟。關閉標簽頁后自動重置宦赠。
  • text: string（可選）
    • 可以傳遞任意數(shù)量的字符，但不得超過四個字符米母。如果傳遞了空字符串 ('')勾扭，標志文本將被清除。如果指定了 tabId 且 text 為 null铁瞒，指定標簽頁的文本將會被清除妙色，并默認為全局標記文本。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十三慧耍、setBadgeTextColor()

設置標志的文本顏色身辨。

1. 示例

chrome.action.setBadgeTextColor(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • color: string|ColorArray
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間丐谋。關閉標簽頁后自動重置。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十四煌珊、setIcon()

設置操作的圖標号俐。

可將圖標指定為圖像文件的路徑、畫布元素的像素數(shù)據(jù)或上述任何一項的字典定庵。必須指定 path 或 imageData 屬性吏饿。

1. 示例

chrome.action.setIcon(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • imageData: ImageData | object（可選）
    • ImageData 對象或表示要設置的圖標的 {size -> ImageData} 字典。如果將圖標指定為字典洗贰，則系統(tǒng)會根據(jù)屏幕的像素密度選擇要使用的實際圖片找岖。如果適合一個屏幕空間單位的圖片像素數(shù)等于 scale，則系統(tǒng)會選擇尺寸為 scale * n 的圖片敛滋，其中 n 是界面中圖標的尺寸许布。必須至少指定一張圖片。請注意绎晃，"details.imageData = foo" 等同于 "details.imageData = {'16': foo}"
  • path: string|object ******可選**
    • 相對圖片路徑或指向要設置的圖標的字典 {size -> relative image path}蜜唾。
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間。關閉標簽頁后自動重置庶艾。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十五袁余、setPopup()

設置 HTML 文檔，使其在用戶點擊操作的圖標時以彈出式窗口的形式打開咱揍。

1. 示例

chrome.action.setPopup(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • popup: string
    • 要在彈出式窗口中顯示的 HTML 文件的相對路徑颖榜。如果設置為空字符串 ('')，系統(tǒng)不會顯示彈出式窗口煤裙。
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間掩完。關閉標簽頁后自動重置。
• callback: function（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

十六硼砰、setTitle()

設置操作的標題且蓬。這會顯示在提示中。

1. 示例

chrome.action.setTitle(
  details: object,
  callback?: function,
)

2. 參數(shù)

• details: object
  • tabId: number 可選
    • 將更改限制為選擇特定標簽頁的時間题翰。關閉標簽頁后自動重置恶阴。
  • title: string
    • 鼠標懸停時，操作應顯示的字符串豹障。
• callback: funtion（可選）
  • callback 參數(shù)如下所示：()=>void

3. 返回

• Promise<void>

三冯事、事件（Events）

一、onClicked

點擊操作圖標時觸發(fā)血公。

如果操作具有彈出式窗口桅咆，則不會觸發(fā)此事件。

1. 示例

chrome.action.onClicked.addListener(
  callback: function,
)

2. 參數(shù)

• callback: function
  • callback 參數(shù)如下所示：

(tab: tabs.Tab)=>void

引用

• 【action】