From c350692e88638a03809e5a347f67c6a49e6701e5 Mon Sep 17 00:00:00 2001 From: Hoarfroster Date: Mon, 16 Dec 2024 14:24:57 +0800 Subject: [PATCH] zh-CN: create `sidebarAction.getTitle()` (#24897) Co-authored-by: A1lo --- .../api/sidebaraction/gettitle/index.md | 100 ++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 files/zh-cn/mozilla/add-ons/webextensions/api/sidebaraction/gettitle/index.md diff --git a/files/zh-cn/mozilla/add-ons/webextensions/api/sidebaraction/gettitle/index.md b/files/zh-cn/mozilla/add-ons/webextensions/api/sidebaraction/gettitle/index.md new file mode 100644 index 00000000000000..4a76ff0cf49ebb --- /dev/null +++ b/files/zh-cn/mozilla/add-ons/webextensions/api/sidebaraction/gettitle/index.md @@ -0,0 +1,100 @@ +--- +title: sidebarAction.getTitle() +slug: Mozilla/Add-ons/WebExtensions/API/sidebarAction/getTitle +l10n: + sourceCommit: b8a0743ca8b1e1b1b1a95cc93a4413c020f11262 +--- + +{{AddonSidebar}} + +获取侧边栏的标题。 + +就像你可以使用 {{WebExtAPIRef("sidebarAction.setTitle()")}} 在每个标签上设置标题一样,你也可以通过将标签页的 ID 传递给此函数来检索特定于标签页的标题。 + +这是一个返回 [`Promise`](/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Promise) 的异步函数。 + +## 语法 + +```js-nolint +let gettingTitle = browser.sidebarAction.getTitle( + details // 对象 +) +``` + +### 参数 + +- `details` + + - : `object`。包含以下属性的对象: + + - `tabId` {{optional_inline}} + - : `integer`。获取特定于给定标签页的侧边栏的标题。 + - `windowId` {{optional_inline}} + - : `integer`。获取特定于给定窗口的侧边栏的标题。 + + + +- 如果同时提供了 `windowId` 和 `tabId`,函数将失败且返回的 promise 将被拒绝。 +- 如果同时省略 `windowId` 和 `tabId`,则返回全局标题。 + +### 返回值 + +[`Promise`](/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Promise),将兑现为包含侧边栏标题的字符串。 + +## 浏览器兼容性 + +{{Compat}} + +## 示例 + +在用户点击浏览器操作时在“这”和“那”之间切换标题: + +```js +function toggleTitle(title) { + if (title === "this") { + browser.sidebarAction.setTitle({ title: "那" }); + } else { + browser.sidebarAction.setTitle({ title: "这" }); + } +} + +browser.browserAction.onClicked.addListener(() => { + let gettingTitle = browser.sidebarAction.getTitle({}); + gettingTitle.then(toggleTitle); +}); +``` + +{{WebExtExamples}} + +> [!NOTE] +> 此 API 基于 Opera 的 [`chrome.sidebarAction`](https://help.opera.com/en/extensions/sidebar-action-api/) API。 + +