Create a segmented control (a button group) where one button has a selected state
This class is not exported from the
'electron' module. It is only available as a return value of other methods in the Electron API.
segmentStyleString (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
rounded- The control is displayed using the rounded style. Maps to
textured-rounded- The control is displayed using the textured rounded style. Maps to
round-rect- The control is displayed using the round rect style. Maps to
textured-square- The control is displayed using the textured square style. Maps to
capsule- The control is displayed using the capsule style. Maps to
small-square- The control is displayed using the small square style. Maps to
separated- The segments in the control are displayed very close to each other but not touching. Maps to
modeString (optional) - The selection mode of the control:
single- Default. One item selected at a time, selecting one deselects the previously selected item. Maps to
multiple- Multiple items can be selected at a time. Maps to
buttons- Make the segments act as buttons, each segment can be pressed and released but never marked as active. Maps to
segmentsSegmentedControlSegment - An array of segments to place in this control.
selectedIndexInteger (optional) - The index of the currently selected segment, will update automatically with user interaction. When the mode is
multipleit will be the last selected item.
changeFunction (optional) - Called when the user selects a new segment.
selectedIndexInteger - The index of the segment the user selected.
isSelectedBoolean - Whether as a result of user selection the segment is selected or not.
The following properties are available on instances of
String representing the controls current segment style. Updating this value immediately updates the control in the touch bar.
SegmentedControlSegment array representing the segments in this control. Updating this value immediately updates the control in the touch bar. Updating deep properties inside this array does not update the touch bar.
Integer representing the currently selected segment. Changing this value immediately updates the control in the touch bar. User interaction with the touch bar will update this value automatically.
String representing the current selection mode of the control. Can be