类: TouchBarButton

类: TouchBarButton

为mac os应用在touch bar中创建一个按钮组件

Process: Main
This class is not exported from the 'electron' module. 它只能作为 Electron API 中其他方法的返回值。

new TouchBarButton(options)

• 选项 对象
  • labelstring (可选) 按钮文本。
  • accessibilityLabel string (可选) - 一个简短描述提供给屏幕朗读器，像是 VoiceOver。
  • backgroundColorstring (可选) - 按钮背景颜色以十六进制格式，例如 #ABCDEF。
  • icon NativeImage | string (optional) - Button icon.
  • iconPositionstring (可选) - 可以是 left、 right 或 overlay。 默认值为 overlay。
  • clickfunction (可选) - 单击按钮时调用的函数。
  • enabled boolean (可选) - 按钮是否是启用状态。 默认值为 true。

当定义 accessibilityLabel 时，请确保已经考虑过 macOS 的最佳实践。

实例属性

下面的这些是TouchBarButton中的属性：

touchBarButton.accessibilityLabel

一 string 值，表明被屏幕阅读器朗读的按钮描述。 如果没有设置标签，仅会被屏幕阅读器朗读。

touchBarButton.label

一 string 值，表示按钮当前文本。 更改此值会立即更新 touch bar 中的按钮。

touchBarButton.backgroundColor

一个 string 的 hex 值，表示按钮的当前背景色。 更改此值会立即更新 touch bar 中的按钮。

touchBarButton.icon

一个 NativeImage 值，表示按钮当前图标。 更改此值会立即更新 touch bar 中的按钮。

touchBarButton.iconPosition

一个 string 值 - 可以是 left，right 或 overlay。 默认值为 overlay。

touchBarButton.enabled

一个 boolean 值， 表示按钮是否是启用状态。