メインコンテンツへ飛ぶ

クラス: TouchBarButton

クラス: TouchBarButton

ネイティブ macOS アプリケーション用のタッチバー内にボタンを作成する

プロセス: メイン
このクラスは 'electron' モジュールからはエクスポートされません。 Electron API では、他のメソッドの戻り値としてのみ利用できます。

new TouchBarButton(options)

  • options Object
    • label String (任意) - ボタンのテキスト。
    • accessibilityLabel String (任意) - VoiceOver などのスクリーンリーダーが使用するボタンの簡単な説明文。
    • backgroundColor String (任意) - 16進数形式、即ち #ABCDEF のボタンの背景色。
    • icon NativeImage | String (任意) - ボタンのアイコン。
    • iconPosition String (任意) - leftrightoverlay にできます。 省略値は overlay
    • click Function (任意) - ボタンがクリックされたときに呼ぶ関数。
    • enabled Boolean (任意) - ボタンが有効な状態かどうか。 省略値は true です。

accessibilityLabel を定義するときは、macOS ベストプラクティス を満たしていることを確認してください。

インスタンスプロパティ

TouchBarButton のインスタンスには以下のプロパティがあります。

touchBarButton.accessibilityLabel

スクリーンリーダーが読み上げるボタンの説明文を表す String。 ラベルが設定されていない場合に限り、スクリーンリーダーが読み上げます。

touchBarButton.label

ボタンの現在のテキストを表す String。 この値を変更すると、タッチバー内のボタンがすぐに更新されます。

touchBarButton.backgroundColor

ボタンの背景色を表す 16 進数の String。 この値を変更すると、タッチバー内のボタンがすぐに更新されます。

touchBarButton.icon

ボタンの現在のアイコンを表す NativeImage。 この値を変更すると、タッチバー内のボタンがすぐに更新されます。

touchBarButton.iconPosition

String - left または right または overlay のいずれか。 省略値は overlay

touchBarButton.enabled

ボタンが有効な状態かどうかを表す Boolean