メインコンテンツにスキップ

クラス: TouchBarButton

クラス: TouchBarButton

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

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

new TouchBarButton(options)

  • options オブジェクト
    • label 文字列 (オプション) - ボタンのテキスト。
    • accessibilityLabel 文字列 (オプション) - VoiceOverなどのスクリーンリーダーで使用するためのボタンの簡単な説明。
    • backgroundColor 文字列 (オプション) - 16進数形式(例:#ABCDEF)のボタンの背景色。
    • icon NativeImage | 文字列 (オプション) - ボタンのアイコン。
    • iconPosition 文字列 (オプション) - leftright、またはoverlayを指定できます。デフォルトはoverlayです。
    • click 関数 (オプション) - ボタンがクリックされたときに呼び出す関数。
    • enabled 真偽値 (オプション) - ボタンが有効状態かどうか。デフォルトはtrueです。

accessibilityLabelを定義する際は、macOSのベストプラクティスを考慮してください。

インスタンスプロパティ

以下のプロパティはTouchBarButtonのインスタンスで利用可能です。

touchBarButton.accessibilityLabel

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

touchBarButton.label

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

touchBarButton.backgroundColor

ボタンの現在の背景色を表す文字列の16進数コード。この値を変更すると、タッチバーのボタンがすぐに更新されます。

touchBarButton.icon

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

touchBarButton.iconPosition

文字列 - leftright、またはoverlayを指定できます。デフォルトはoverlayです。

touchBarButton.enabled

ボタンが有効状態かどうかを表す真偽値