electron/docs/api/touch-bar-button.md

## Class: TouchBarButton

> Create a button in the touch bar for native macOS applications

Process: [Main](../glossary.md#main-process)<br />
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._

### `new TouchBarButton(options)`

* `options` Object
  * `label` String (optional) - Button text.
  * `accessibilityLabel` String (optional) - A short description of the button for use by screenreaders like VoiceOver.
  * `backgroundColor` String (optional) - Button background color in hex format,
    i.e `#ABCDEF`.
  * `icon` [NativeImage](native-image.md) | String (optional) - Button icon.
  * `iconPosition` String (optional) - Can be `left`, `right` or `overlay`. Defaults to `overlay`.
  * `click` Function (optional) - Function to call when the button is clicked.
  * `enabled` Boolean (optional) - Whether the button is in an enabled state.  Default is `true`.

When defining `accessibilityLabel`, ensure you have considered macOS [best practices](https://developer.apple.com/documentation/appkit/nsaccessibilitybutton/1524910-accessibilitylabel?language=objc).

### Instance Properties

The following properties are available on instances of `TouchBarButton`:

#### `touchBarButton.accessibilityLabel`

A `String` representing the description of the button to be read by a screen reader. Will only be read by screen readers if no label is set.

#### `touchBarButton.label`

A `String` representing the button's current text. Changing this value immediately updates the button
in the touch bar.

#### `touchBarButton.backgroundColor`

A `String` hex code representing the button's current background color. Changing this value immediately updates
the button in the touch bar.

#### `touchBarButton.icon`

A `NativeImage` representing the button's current icon. Changing this value immediately updates the button
in the touch bar.

#### `touchBarButton.iconPosition`

A `String` - Can be `left`, `right` or `overlay`.  Defaults to `overlay`.

#### `touchBarButton.enabled`

A `Boolean` representing whether the button is in an enabled state.
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			`## Class: TouchBarButton`

			`> Create a button in the touch bar for native macOS applications`

fix: ensure the typescript definitions only export correct value types (#28712) * fix: ensure the typescript definitions only export correct value types In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes #22167 * chore: update typescript-defs * chore: update typescript-defs * chore: fix bad typescript in IPC test * docs: test rendering of new syntax * chore: update per feedback, use same syntax but with 'this is not exportedd' line 2021-06-15 20:50:31 +00:00			`Process: [Main](../glossary.md#main-process)<br />`
			_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
Add initial touch bar docs 2017-03-03 17:54:46 +00:00
docs: document what experimental means explicitly (#22893) * docs: document what experimental means explicitly * Apply suggestions from code review Co-Authored-By: Jeremy Apthorp <jeremya@chromium.org> * Update experimental.md Co-authored-by: Jeremy Apthorp <jeremya@chromium.org> 2020-04-02 16:32:18 +00:00			### `new TouchBarButton(options)`
Add initial touch bar docs 2017-03-03 17:54:46 +00:00
			* `options` Object
			* `label` String (optional) - Button text.
feat: improve TouchBarButton accessibility (#20454) 2019-10-08 15:13:57 +00:00			* `accessibilityLabel` String (optional) - A short description of the button for use by screenreaders like VoiceOver.
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			* `backgroundColor` String (optional) - Button background color in hex format,
			i.e `#ABCDEF`.
test: move the TouchBar specs to the main process (#19413) 2019-07-25 18:30:42 +00:00			* `icon` [NativeImage](native-image.md) \| String (optional) - Button icon.
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			* `iconPosition` String (optional) - Can be `left`, `right` or `overlay`. Defaults to `overlay`.
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			* `click` Function (optional) - Function to call when the button is clicked.
feat: allow TouchBarButton instances to be disabled (#20945) * feat: allow TouchBarButton instances to be disabled * Update touch-bar-button.md 2019-11-05 23:56:36 +00:00			* `enabled` Boolean (optional) - Whether the button is in an enabled state. Default is `true`.
Add initial touch bar docs 2017-03-03 17:54:46 +00:00
feat: improve TouchBarButton accessibility (#20454) 2019-10-08 15:13:57 +00:00			When defining `accessibilityLabel`, ensure you have considered macOS [best practices](https://developer.apple.com/documentation/appkit/nsaccessibilitybutton/1524910-accessibilitylabel?language=objc).

Add initial touch bar docs 2017-03-03 17:54:46 +00:00			`### Instance Properties`

			The following properties are available on instances of `TouchBarButton`:

feat: improve TouchBarButton accessibility (#20454) 2019-10-08 15:13:57 +00:00			#### `touchBarButton.accessibilityLabel`

			A `String` representing the description of the button to be read by a screen reader. Will only be read by screen readers if no label is set.

Add initial touch bar docs 2017-03-03 17:54:46 +00:00			#### `touchBarButton.label`

Add more explicit types to docs for TouchBar 2017-03-04 05:14:41 +00:00			A `String` representing the button's current text. Changing this value immediately updates the button
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			`in the touch bar.`

			#### `touchBarButton.backgroundColor`

Add more explicit types to docs for TouchBar 2017-03-04 05:14:41 +00:00			A `String` hex code representing the button's current background color. Changing this value immediately updates
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			`the button in the touch bar.`

			#### `touchBarButton.icon`

Add more explicit types to docs for TouchBar 2017-03-04 05:14:41 +00:00			A `NativeImage` representing the button's current icon. Changing this value immediately updates the button
Add initial touch bar docs 2017-03-03 17:54:46 +00:00			`in the touch bar.`
feat: allow TouchBarButton instances to be disabled (#20945) * feat: allow TouchBarButton instances to be disabled * Update touch-bar-button.md 2019-11-05 23:56:36 +00:00
build: convert touch-bar to typescript (#24511) 2020-07-16 18:37:38 +00:00			#### `touchBarButton.iconPosition`

			A `String` - Can be `left`, `right` or `overlay`. Defaults to `overlay`.

feat: allow TouchBarButton instances to be disabled (#20945) * feat: allow TouchBarButton instances to be disabled * Update touch-bar-button.md 2019-11-05 23:56:36 +00:00			#### `touchBarButton.enabled`

			A `Boolean` representing whether the button is in an enabled state.