mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: type names changed from wrapper to primitive (#31752)

Browse source
This commit is contained in:
Milan Burda 2021-11-16 05:13:18 +01:00 • committed by GitHub
parent 246884c4fb
commit e6b1d95a1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
115 changed files with 1685 additions and 1685 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/touch-bar-label.md
View file

@ -8,9 +8,9 @@ _This class is not exported from the `'electron'` module. It is only available a
### `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`.
* `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).
@ -20,14 +20,14 @@ 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
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.
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
A `string` hex code representing the label's current text color. Changing this value immediately updates the
label in the touch bar.