81795744cf
* 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
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
## Class: TouchBarLabel
|
|
|
|
> Create a label 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 TouchBarLabel(options)`
|
|
|
|
* `options` Object
|
|
* `label` String (optional) - Text to display.
|
|
* `accessibilityLabel` String (optional) - A short description of the button for use by screenreaders like VoiceOver.
|
|
* `textColor` String (optional) - Hex color of text, i.e `#ABCDEF`.
|
|
|
|
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 `TouchBarLabel`:
|
|
|
|
#### `touchBarLabel.label`
|
|
|
|
A `String` representing the label's current text. Changing this value immediately updates the label in
|
|
the touch bar.
|
|
|
|
#### `touchBarLabel.accessibilityLabel`
|
|
|
|
A `String` representing the description of the label to be read by a screen reader.
|
|
|
|
#### `touchBarLabel.textColor`
|
|
|
|
A `String` hex code representing the label's current text color. Changing this value immediately updates the
|
|
label in the touch bar.
|