跳转到主要内容

systemPreferences

获取系统偏好设置。

进程： 主进程, 实用进程

const { systemPreferences } = require('electron')

console.log(systemPreferences.getEffectiveAppearance())

事件​

systemPreferences 对象会发出以下事件：

Event: 'accent-color-changed' Windows Linux​

返回

  • event Event
  • newColor string - 用户为其系统强调色设置的新 RGBA 颜色。

Event: 'color-changed' Windows​

返回

  • event Event

方法​

systemPreferences.isSwipeTrackingFromScrollEventsEnabled() macOS​

Returns boolean - 是否启用了“通过滚动事件跟踪滑动”设置。

systemPreferences.postNotification(event, userInfo[, deliverImmediately]) macOS​

  • event string
  • userInfo Record<string, any>
  • deliverImmediately boolean (optional) - true 表示即使订阅的应用处于非活动状态，也立即发送通知。

将 event 作为 macOS 的原生通知发布。userInfo 是一个对象，其中包含随通知一起发送的用户信息字典。

systemPreferences.postLocalNotification(event, userInfo) macOS​

  • event string
  • userInfo Record<string, any>

将 event 作为 macOS 的原生通知发布。userInfo 是一个对象，其中包含随通知一起发送的用户信息字典。

systemPreferences.postWorkspaceNotification(event, userInfo) macOS​

  • event string
  • userInfo Record<string, any>

将 event 作为 macOS 的原生通知发布。userInfo 是一个对象，其中包含随通知一起发送的用户信息字典。

systemPreferences.subscribeNotification(event, callback) macOS​

  • event string | null
  • callback Function
    • event string
    • userInfo Record<string, unknown>
    • object string

Returns number - 此订阅的 ID。

订阅 macOS 的原生通知，当发生相应的 event 时，callback 将以 callback(event, userInfo) 的形式被调用。userInfo 是一个包含随通知一起发送的用户信息字典的对象。object 是通知的发送者，目前仅支持 NSString 类型的值。

返回订阅者的 id，该 ID 可用于取消订阅 event。

该 API 底层订阅的是 NSDistributedNotificationCenter，event 的示例值包括：

  • AppleInterfaceThemeChangedNotification
  • AppleAquaColorVariantChanged
  • AppleColorPreferencesChangedNotification
  • AppleShowScrollBarsSettingChanged

如果 event 为 null，则 NSDistributedNotificationCenter 不将其用作传递给观察者的标准。有关更多信息，请参阅 文档。

systemPreferences.subscribeLocalNotification(event, callback) macOS​

  • event string | null
  • callback Function
    • event string
    • userInfo Record<string, unknown>
    • object string

Returns number - 此订阅的 ID。

与 subscribeNotification 相同，但使用 NSNotificationCenter 处理本地默认值。这对于 NSUserDefaultsDidChangeNotification 等事件至关重要。

如果 event 为 null，则 NSNotificationCenter 不将其用作传递给观察者的标准。有关更多信息，请参阅 文档。

systemPreferences.subscribeWorkspaceNotification(event, callback) macOS​

  • event string | null
  • callback Function
    • event string
    • userInfo Record<string, unknown>
    • object string

Returns number - 此订阅的 ID。

与 subscribeNotification 相同，但使用 NSWorkspace.sharedWorkspace.notificationCenter。这对于 NSWorkspaceDidActivateApplicationNotification 等事件至关重要。

如果 event 为 null，则 NSWorkspaceNotificationCenter 不将其用作传递给观察者的标准。有关更多信息，请参阅 文档。

systemPreferences.unsubscribeNotification(id) macOS​

  • id Integer

移除具有 id 的订阅者。

systemPreferences.unsubscribeLocalNotification(id) macOS​

  • id Integer

与 unsubscribeNotification 相同，但从 NSNotificationCenter 中移除订阅者。

systemPreferences.unsubscribeWorkspaceNotification(id) macOS​

  • id Integer

与 unsubscribeNotification 相同，但从 NSWorkspace.sharedWorkspace.notificationCenter 中移除订阅者。

systemPreferences.registerDefaults(defaults) macOS​

  • defaults Record<string, string | boolean | number> - 一个包含 (key: value) 用户默认值的字典。

将指定的默认值添加到您的应用程序的 NSUserDefaults 中。

systemPreferences.getUserDefault<Type extends keyof UserDefaultTypes>(key, type) macOS​

  • key string
  • type Type - 可以是 string、boolean、integer、float、double、url、array 或 dictionary。

Returns UserDefaultTypes[Type] - NSUserDefaults 中 key 的值。

一些常用的 key 和 type 是：

  • AppleInterfaceStyle: string
  • AppleAquaColorVariant: integer
  • AppleHighlightColor: string
  • AppleShowScrollBars: string
  • NSNavRecentPlaces: array
  • NSPreferredWebServices: dictionary
  • NSUserDictionaryReplacementItems: array

systemPreferences.setUserDefault<Type extends keyof UserDefaultTypes>(key, type, value) macOS​

  • key string
  • type Type - 可以是 string、boolean、integer、float、double、url、array 或 dictionary。
  • value UserDefaultTypes[Type]

设置 NSUserDefaults 中 key 的值。

注意，type 必须与 value 的实际类型匹配。如果类型不匹配，将抛出异常。

一些常用的 key 和 type 是：

  • ApplePressAndHoldEnabled: boolean

systemPreferences.removeUserDefault(key) macOS​

  • key string

移除 NSUserDefaults 中的 key。这可用于恢复之前使用 setUserDefault 设置的 key 的默认值或全局值。

systemPreferences.getAccentColor()​

Returns string - 用户当前的系统范围强调色偏好设置，以 RGBA 十六进制格式表示。

const color = systemPreferences.getAccentColor() // `"aabbccdd"`
const red = color.substr(0, 2) // "aa"
const green = color.substr(2, 2) // "bb"
const blue = color.substr(4, 2) // "cc"
const alpha = color.substr(6, 2) // "dd"

此 API 仅在 macOS 10.14 Mojave 或更高版本可用。

systemPreferences.getColor(color) Windows macOS​

  • color string - 以下值之一：
    • 在 Windows 上：
      • 3d-dark-shadow - 三维显示元素的暗阴影。
      • 3d-face - 三维显示元素的脸部颜色，以及对话框背景的颜色。
      • 3d-highlight - 三维显示元素的高光颜色。
      • 3d-light - 三维显示元素的浅色。
      • 3d-shadow - 三维显示元素的阴影颜色。
      • active-border - 活动窗口边框。
      • active-caption - 活动窗口标题栏。当启用渐变效果时，指定活动窗口标题栏颜色渐变的左侧颜色。
      • active-caption-gradient - 活动窗口标题栏颜色渐变的右侧颜色。
      • app-workspace - 多文档界面 (MDI) 应用程序的背景颜色。
      • button-text - 按钮上的文本。
      • caption-text - 标题、尺寸框和滚动条箭头框中的文本。
      • desktop - 桌面背景颜色。
      • disabled-text - 灰色（禁用）文本。
      • highlight - 控件中选定的项目。
      • highlight-text - 控件中选定项目的文本。
      • hotlight - 超链接或热跟踪项的颜色。
      • inactive-border - 非活动窗口边框。
      • inactive-caption - 非活动窗口标题。当启用渐变效果时，指定非活动窗口标题栏颜色渐变的左侧颜色。
      • inactive-caption-gradient - 非活动窗口标题栏颜色渐变的右侧颜色。
      • inactive-caption-text - 非活动标题中的文本颜色。
      • info-background - 工具提示控件的背景颜色。
      • info-text - 工具提示控件的文本颜色。
      • menu - 菜单背景。
      • menu-highlight - 菜单显示为平面菜单时用于突出显示菜单项的颜色。
      • menubar - 菜单显示为平面菜单时的菜单栏背景颜色。
      • menu-text - 菜单中的文本。
      • scrollbar - 滚动条灰色区域。
      • window - 窗口背景。
      • window-frame - 窗口边框。
      • window-text - 窗口中的文本。
    • 在 macOS 上：
      • control-background - 大型界面元素（如浏览器或表格）的背景。
      • control - 控件的表面。
      • control-text - 未禁用控件的文本。
      • disabled-control-text - 已禁用控件的文本。
      • find-highlight - 查找指示器的颜色。
      • grid - 表格等界面元素的网格线。
      • header-text - 表格中标题单元格的文本。
      • highlight - 屏幕上的虚拟光源。
      • keyboard-focus-indicator - 当使用键盘进行界面导航时，出现在当前焦点控件周围的环。
      • label - 包含主要内容的标签文本。
      • link - 指向其他内容的链接。
      • placeholder-text - 控件或文本视图中的占位符字符串。
      • quaternary-label - 重要性低于三级标签的标签文本，例如水印文本。
      • scrubber-textured-background - Touch Bar 中滚动条的背景。
      • secondary-label - 重要性低于普通标签的标签文本，例如用于表示子标题或附加信息的标签。
      • selected-content-background - 关键窗口或视图中选定内容的背景。
      • selected-control - 选定控件的表面。
      • selected-control-text - 选定控件的文本。
      • selected-menu-item-text - 选定菜单的文本。
      • selected-text-background - 选定文本的背景。
      • selected-text - 选定文本。
      • separator - 内容不同部分之间的分隔符。
      • shadow - 屏幕上凸起对象投射的虚拟阴影。
      • tertiary-label - 重要性低于二级标签的标签文本，例如用于表示禁用文本的标签。
      • text-background - 文本背景。
      • text - 文档中的文本。
      • under-page-background - 文档内容下方的背景。
      • unemphasized-selected-content-background - 非关键窗口或视图中选定的内容。
      • unemphasized-selected-text-background - 非关键窗口或视图中选定文本的背景。
      • unemphasized-selected-text - 非关键窗口或视图中的选定文本。
      • window-background - 窗口的背景。
      • window-frame-text - 窗口标题栏区域的文本。

Returns string - 系统颜色设置，格式为 RGBA 十六进制（#RRGGBBAA）。有关更多详细信息，请参阅 Windows 文档和 macOS 文档。

以下颜色仅在 macOS 10.14 上可用：find-highlight、selected-content-background、separator、unemphasized-selected-content-background、unemphasized-selected-text-background 和 unemphasized-selected-text。

systemPreferences.getSystemColor(color) macOS​

  • color string - 以下值之一：
    • blue
    • brown
    • gray
    • green
    • orange
    • pink
    • purple
    • red
    • yellow

Returns string - 标准系统颜色，格式为 #RRGGBBAA。

返回几种标准系统颜色中的一种，这些颜色会自动适应动态效果和辅助功能设置（如“增加对比度”和“减弱透明度”）的变化。有关更多详细信息，请参阅 Apple 文档。

systemPreferences.getEffectiveAppearance() macOS​

Returns string - 可以是 dark、light 或 unknown。

获取当前应用于您的应用程序的 macOS 外观设置，映射到 NSApplication.effectiveAppearance。

systemPreferences.canPromptTouchID() macOS​

Returns boolean - 此设备是否能够使用 Touch ID。

systemPreferences.promptTouchID(reason) macOS​

  • reason string - 您请求 Touch ID 身份验证的原因。

Returns Promise<void> - 如果用户已成功使用 Touch ID 进行身份验证，则解析。

const { systemPreferences } = require('electron')

systemPreferences.promptTouchID('To get consent for a Security-Gated Thing').then(success => {
  console.log('You have successfully authenticated with Touch ID!')
}).catch(err => {
  console.log(err)
})

此 API 本身不会保护您的用户数据；相反，它是允许您进行保护的机制。原生应用程序需要为 keychain 条目设置 访问控制常量，例如 kSecAccessControlUserPresence，以便读取它会自动提示用户进行 Touch ID 生物识别同意。这可以使用 node-keytar 来完成，例如，您可以将加密密钥存储在 node-keytar 中，仅在 promptTouchID() 解析时才获取它。

systemPreferences.isTrustedAccessibilityClient(prompt) macOS​

  • prompt boolean - 如果当前进程不受信任，是否会向用户发出提示。

Returns boolean - 如果当前进程是受信任的可访问性客户端，则为 true，否则为 false。

systemPreferences.getMediaAccessStatus(mediaType) Windows macOS​

  • mediaType string - 可以是 microphone、camera 或 screen。

Returns string - 可以是 not-determined、granted、denied、restricted 或 unknown。

在 macOS 10.13 High Sierra 上不需要此用户同意，因此此方法将始终返回 granted。macOS 10.14 Mojave 或更高版本需要同意才能访问 microphone 和 camera。macOS 10.15 Catalina 或更高版本需要同意才能访问 screen。

Windows 10 有一个全局设置控制所有 win32 应用程序的 microphone 和 camera 访问权限。对于 screen 以及旧版本 Windows 上的所有媒体类型，它将始终返回 granted。

systemPreferences.askForMediaAccess(mediaType) macOS​

  • mediaType string - 请求的媒体类型；可以是 microphone、camera。

Returns Promise<boolean> - 一个 Promise，解析为 true（如果同意被授予）或 false（如果被拒绝）。如果传递了无效的 mediaType，Promise 将被拒绝。如果已请求并拒绝访问，则必须通过“系统偏好设置”面板进行更改；不会弹出警报，并且 Promise 将以现有访问状态解析。

重要提示：为了正确利用此 API，您 必须在应用程序的 Info.plist 文件中设置 NSMicrophoneUsageDescription 和 NSCameraUsageDescription 字符串。这些键的值将用于填充权限对话框，以便用户能够正确了解权限请求的目的。有关在 Electron 上下文中如何设置这些内容的更多信息，请参阅 Electron 应用程序分发。

在 macOS 10.14 Mojave 之前不需要此用户同意，因此如果您的系统运行的是 10.13 High Sierra，此方法将始终返回 true。

systemPreferences.getAnimationSettings()​

返回 Object

  • shouldRenderRichAnimation boolean - 如果应渲染丰富的动画，则返回 true。考虑会话类型（例如远程桌面）和辅助功能设置，以提供有关繁重动画的指导。
  • scrollAnimationsEnabledBySystem boolean - 在每个平台的基础上确定是否应启用滚动动画（例如，由 Home/End 键产生的动画）。
  • prefersReducedMotion boolean - 根据平台 API 确定用户是否偏好减少动画。

返回一个包含系统动画设置的对象。

属性​

systemPreferences.accessibilityDisplayShouldReduceTransparency macOS Deprecated​

一个 boolean 属性，用于确定应用程序是否避免使用半透明背景。这映射到 NSWorkspace.accessibilityDisplayShouldReduceTransparency。

已弃用：请使用新的 nativeTheme.prefersReducedTransparency API。

systemPreferences.effectiveAppearance macOS Readonly​

一个 string 属性，可以是 dark、light 或 unknown。

返回当前应用于您的应用程序的 macOS 外观设置，映射到 NSApplication.effectiveAppearance。