mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
electron/docs/api/touch-bar-segmented-control.md
Kevin Sawicki 4001ba038e Add descriptions for each segmentStyle
2017-03-30 12:36:20 -07:00

2.3 KiB
Raw Blame History

Class: TouchBarSegmentedControl

Create a segmented control (a button group) where one button has a selected state

Process: Main

new TouchBarSegmentedControl(options) Experimental

  • options Object
    • 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.
      • rounded - The control is displayed using the rounded style.
      • textured-rounded - The control is displayed using the textured rounded style.
      • round-rect - The control is displayed using the round rect style.
      • 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[] - 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
    • change Function - Called when the user selects a new segment
      • selectedIndex Integer - The index of the segment the user selected

Instance Properties

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 in the touch bar.

touchBarSegmentedControl.segments

A 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.

touchBarSegmentedControl.selectedIndex

An 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.