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

Add descriptions for each segmentStyle

Browse source
This commit is contained in:
Kevin Sawicki 2017-03-30 12:06:33 -07:00
parent f805bbee9b
commit 4001ba038e
1 changed files with 13 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -8,14 +8,19 @@ Process: [Main](../tutorial/quick-start.md#main-process)
* `options` Object * `options` Object
* `segmentStyle` String - (Optional) Style of the segments: * `segmentStyle` String - (Optional) Style of the segments:
* `automatic` - Default * `automatic` - Default. The appearance of the segmented control is
* `rounded` automatically determined based on the type of window in which the control
* `textured-rounded` is displayed and the position within the window.
* `round-rect` * `rounded` - The control is displayed using the rounded style.
* `textured-square` * `textured-rounded` - The control is displayed using the textured rounded
* `capsule` style.
* `small-square` * `round-rect` - The control is displayed using the round rect style.
* `separated` * `textured-square` - The control is displayed using the textured square
style.
* `capsule` - The control is displayed using the capsule style
* `small-square` - The control is displayed using the small square style.
* `separated` - The segments in the control are displayed very close to each
other but not touching.
* `segments` [SegmentedControlSegment[]](structures/segmented-control-segment.md) - An array of segments to place in this control * `segments` [SegmentedControlSegment[]](structures/segmented-control-segment.md) - An array of segments to place in this control
* `selectedIndex` Integer (Optional) - The index of the currently selected segment, will update automatically with user interaction * `selectedIndex` Integer (Optional) - The index of the currently selected segment, will update automatically with user interaction
* `change` Function - Called when the user selects a new segment * `change` Function - Called when the user selects a new segment