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

10
docs/api/touch-bar-segmented-control.md
View file

@ -8,7 +8,7 @@ _This class is not exported from the `'electron'` module. It is only available a
### `new TouchBarSegmentedControl(options)`
* `options` Object
* `segmentStyle` String (optional) - Style of the segments:
* `segmentStyle` string (optional) - Style of the segments:
* `automatic` - Default. The appearance of the segmented control is
automatically determined based on the type of window in which the control
is displayed and the position within the window. Maps to `NSSegmentStyleAutomatic`.
@ -22,7 +22,7 @@ _This class is not exported from the `'electron'` module. It is only available a
* `small-square` - The control is displayed using the small square style. Maps to `NSSegmentStyleSmallSquare`.
* `separated` - The segments in the control are displayed very close to each
other but not touching. Maps to `NSSegmentStyleSeparated`.
* `mode` String (optional) - The selection mode of the control:
* `mode` string (optional) - The selection mode of the control:
* `single` - Default. One item selected at a time, selecting one deselects the previously selected item. Maps to `NSSegmentSwitchTrackingSelectOne`.
* `multiple` - Multiple items can be selected at a time. Maps to `NSSegmentSwitchTrackingSelectAny`.
* `buttons` - Make the segments act as buttons, each segment can be pressed and released but never marked as active. Maps to `NSSegmentSwitchTrackingMomentary`.
@ -30,7 +30,7 @@ _This class is not exported from the `'electron'` module. It is only available a
* `selectedIndex` Integer (optional) - The index of the currently selected segment, will update automatically with user interaction. When the mode is `multiple` it will be the last selected item.
* `change` Function (optional) - Called when the user selects a new segment.
* `selectedIndex` Integer - The index of the segment the user selected.
* `isSelected` Boolean - Whether as a result of user selection the segment is selected or not.
* `isSelected` boolean - Whether as a result of user selection the segment is selected or not.
### Instance Properties
@ -38,7 +38,7 @@ The following properties are available on instances of `TouchBarSegmentedControl
#### `touchBarSegmentedControl.segmentStyle`
A `String` representing the controls current segment style. Updating this value immediately updates the control
A `string` representing the controls current segment style. Updating this value immediately updates the control
in the touch bar.
#### `touchBarSegmentedControl.segments`
@ -53,4 +53,4 @@ in the touch bar. User interaction with the touch bar will update this value aut
#### `touchBarSegmentedControl.mode`
A `String` representing the current selection mode of the control. Can be `single`, `multiple` or `buttons`.
A `string` representing the current selection mode of the control. Can be `single`, `multiple` or `buttons`.