electron/docs/api/touch-bar-segmented-control.md

## Class: TouchBarSegmentedControl

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

Process: [Main](../glossary.md#main-process)<br />
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._

### `new TouchBarSegmentedControl(options)`

* `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. Maps to `NSSegmentStyleAutomatic`.
    * `rounded` - The control is displayed using the rounded style. Maps to `NSSegmentStyleRounded`.
    * `textured-rounded` - The control is displayed using the textured rounded
      style. Maps to `NSSegmentStyleTexturedRounded`.
    * `round-rect` - The control is displayed using the round rect style. Maps to `NSSegmentStyleRoundRect`.
    * `textured-square` - The control is displayed using the textured square
      style. Maps to `NSSegmentStyleTexturedSquare`.
    * `capsule` - The control is displayed using the capsule style. Maps to `NSSegmentStyleCapsule`.
    * `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:
    * `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`.
  * `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. 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.

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

#### `touchBarSegmentedControl.mode`

A `String` representing the current selection mode of the control.  Can be `single`, `multiple` or `buttons`.
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00			`## Class: TouchBarSegmentedControl`

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

fix: ensure the typescript definitions only export correct value types (#28712) * fix: ensure the typescript definitions only export correct value types In typescript there are two main types of "types" you can export, value types (class, const) and definition types (type, interface). The typescript compiler will let anything declared via const or class be used as a value. Unfortunately we were exporting a bunch of things (see the diff) as class/const when they weren't actually exported values. This lead to typescript being happy but the runtime throwing errors (not something we want). This change passes "exported-in" context through our docs, to the parser and then to the definitions generator to ensure we only mark things as exported in the ts defs that we actually export. Fixes #22167 * chore: update typescript-defs * chore: update typescript-defs * chore: fix bad typescript in IPC test * docs: test rendering of new syntax * chore: update per feedback, use same syntax but with 'this is not exportedd' line 2021-06-15 20:50:31 +00:00			`Process: [Main](../glossary.md#main-process)<br />`
			_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00
docs: document what experimental means explicitly (#22893) * docs: document what experimental means explicitly * Apply suggestions from code review Co-Authored-By: Jeremy Apthorp <jeremya@chromium.org> * Update experimental.md Co-authored-by: Jeremy Apthorp <jeremya@chromium.org> 2020-04-02 16:32:18 +00:00			### `new TouchBarSegmentedControl(options)`
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00
			* `options` Object
feat(docs): fix 'optional' wording 2017-11-28 17:15:15 +00:00			* `segmentStyle` String (optional) - Style of the segments:
Add descriptions for each segmentStyle 2017-03-30 19:06:33 +00:00			* `automatic` - Default. The appearance of the segmented control is
			`automatically determined based on the type of window in which the control`
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			is displayed and the position within the window. Maps to `NSSegmentStyleAutomatic`.
			* `rounded` - The control is displayed using the rounded style. Maps to `NSSegmentStyleRounded`.
Add descriptions for each segmentStyle 2017-03-30 19:06:33 +00:00			* `textured-rounded` - The control is displayed using the textured rounded
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			style. Maps to `NSSegmentStyleTexturedRounded`.
			* `round-rect` - The control is displayed using the round rect style. Maps to `NSSegmentStyleRoundRect`.
Add descriptions for each segmentStyle 2017-03-30 19:06:33 +00:00			* `textured-square` - The control is displayed using the textured square
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			style. Maps to `NSSegmentStyleTexturedSquare`.
			* `capsule` - The control is displayed using the capsule style. Maps to `NSSegmentStyleCapsule`.
			* `small-square` - The control is displayed using the small square style. Maps to `NSSegmentStyleSmallSquare`.
Add descriptions for each segmentStyle 2017-03-30 19:06:33 +00:00			* `separated` - The segments in the control are displayed very close to each
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			other but not touching. Maps to `NSSegmentStyleSeparated`.
feat(docs): fix 'optional' wording 2017-11-28 17:15:15 +00:00			* `mode` String (optional) - The selection mode of the control:
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			* `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`.
:art: 2017-05-04 21:15:48 +00:00			* `segments` [SegmentedControlSegment[]](structures/segmented-control-segment.md) - An array of segments to place in this control.
docs: fix TouchBar related documentation (#19444) 2019-08-01 14:59:26 +00:00			* `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.
test: move the TouchBar specs to the main process (#19413) 2019-07-25 18:30:42 +00:00			* `change` Function (optional) - Called when the user selects a new segment.
:art: 2017-05-04 21:15:48 +00:00			* `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.
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00
			`### Instance Properties`

			The following properties are available on instances of `TouchBarSegmentedControl`:

			#### `touchBarSegmentedControl.segmentStyle`

fix(docs): fix all missing dots and add some links 2017-11-29 10:38:35 +00:00			A `String` representing the controls current segment style. Updating this value immediately updates the control
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00			`in the touch bar.`

			#### `touchBarSegmentedControl.segments`

remove all double spaces not needed 2017-11-29 10:58:24 +00:00			A `SegmentedControlSegment[]` array representing the segments in this control. Updating this value immediately
fix(docs): fix all missing dots and add some links 2017-11-29 10:38:35 +00:00			`updates the control in the touch bar. Updating deep properties inside this array does not update the touch bar.`
Add docs for segmented control touch bar item 2017-03-10 06:50:23 +00:00
			#### `touchBarSegmentedControl.selectedIndex`

remove all double spaces not needed 2017-11-29 10:58:24 +00:00			An `Integer` representing the currently selected segment. Changing this value immediately updates the control
fix(docs): fix all missing dots and add some links 2017-11-29 10:38:35 +00:00			`in the touch bar. User interaction with the touch bar will update this value automatically.`
build: convert touch-bar to typescript (#24511) 2020-07-16 18:37:38 +00:00
			#### `touchBarSegmentedControl.mode`

			A `String` representing the current selection mode of the control. Can be `single`, `multiple` or `buttons`.