From 0999ffe36d3fee4c505cb53167a22ae48b054c07 Mon Sep 17 00:00:00 2001 From: Hoarfroster Date: Thu, 8 Aug 2024 11:03:45 +0800 Subject: [PATCH] zh-CN: create `action.getUserSettings()` (#22947) Co-authored-by: A1lo --- .../api/action/getusersettings/index.md | 92 +++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 files/zh-cn/mozilla/add-ons/webextensions/api/action/getusersettings/index.md diff --git a/files/zh-cn/mozilla/add-ons/webextensions/api/action/getusersettings/index.md b/files/zh-cn/mozilla/add-ons/webextensions/api/action/getusersettings/index.md new file mode 100644 index 00000000000000..c1bcbc8e583733 --- /dev/null +++ b/files/zh-cn/mozilla/add-ons/webextensions/api/action/getusersettings/index.md @@ -0,0 +1,92 @@ +--- +title: action.getUserSettings() +slug: Mozilla/Add-ons/WebExtensions/API/action/getUserSettings +l10n: + sourceCommit: b30a10c08b986ebabd44733fb62f67667350403e +--- + +{{AddonSidebar}} + +获取浏览器操作的用户设置。 + +> [!NOTE] +> 该 API 在 Manifest V3 或更高版本中可用。 + +这是一个返回 [`Promise`](/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Promise) 的异步函数。 + +## 语法 + +```js-nolint +let userSettings = await browser.action.getUserSettings(); +``` + +### 参数 + +无参数。 + +### 返回值 + +一个 [`Promise`](/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Promise),会兑现包含下列属性的对象: + +- `userSettings` + + - : 包含由用户指定的浏览器操作设置的对象,具有下列属性: + + - `isOnToolbar` {{optional_inline}} + - : `boolean`,用户是否将该操作的图标固定到浏览器 UI。这一设置并不能指示操作图标是否可见。可见性取决于浏览器窗口的尺寸以及浏览器 UI 布局。 + +## 示例 + +以下代码输出指示操作是否被固定的信息: + +```js +function gotSettings(userSettings) { + if (userSettings.isOnToolbar) { + console.log("操作被固定到工具栏"); + } else { + console.log("操作未被固定到工具栏。"); + } +} + +let gettingUserSettings = browser.action.getUserSettings(); +gettingUserSettings.then(gotSettings); +``` + +{{WebExtExamples}} + +## 浏览器兼容性 + +{{Compat}} + +> [!NOTE] +> 该 API 基于 Chromium 的 [`chrome.action`](https://developer.chrome.com/docs/extensions/reference/action/#method-getUserSettings) API。 + +