81795744cf
* 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
40 lines
1.4 KiB
Markdown
40 lines
1.4 KiB
Markdown
## Class: TouchBarSlider
|
|
|
|
> Create a slider in the touch bar for native macOS applications
|
|
|
|
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 TouchBarSlider(options)`
|
|
|
|
* `options` Object
|
|
* `label` String (optional) - Label text.
|
|
* `value` Integer (optional) - Selected value.
|
|
* `minValue` Integer (optional) - Minimum value.
|
|
* `maxValue` Integer (optional) - Maximum value.
|
|
* `change` Function (optional) - Function to call when the slider is changed.
|
|
* `newValue` Number - The value that the user selected on the Slider.
|
|
|
|
### Instance Properties
|
|
|
|
The following properties are available on instances of `TouchBarSlider`:
|
|
|
|
#### `touchBarSlider.label`
|
|
|
|
A `String` representing the slider's current text. Changing this value immediately updates the slider
|
|
in the touch bar.
|
|
|
|
#### `touchBarSlider.value`
|
|
|
|
A `Number` representing the slider's current value. Changing this value immediately updates the slider
|
|
in the touch bar.
|
|
|
|
#### `touchBarSlider.minValue`
|
|
|
|
A `Number` representing the slider's current minimum value. Changing this value immediately updates the
|
|
slider in the touch bar.
|
|
|
|
#### `touchBarSlider.maxValue`
|
|
|
|
A `Number` representing the slider's current maximum value. Changing this value immediately updates the
|
|
slider in the touch bar.
|