Browse Source

test: move the TouchBar specs to the main process (#19413)

Jeremy Apthorp 5 years ago
parent
commit
e58f8a79ee

+ 1 - 1
docs/api/browser-window.md

@@ -1705,7 +1705,7 @@ deprecated and will be removed in an upcoming version of macOS.
 
 #### `win.setTouchBar(touchBar)` _macOS_ _Experimental_
 
-* `touchBar` TouchBar
+* `touchBar` TouchBar | null
 
 Sets the touchBar layout for the current window. Specifying `null` or
 `undefined` clears the touch bar. This method only has an effect if the

+ 1 - 1
docs/api/touch-bar-button.md

@@ -10,7 +10,7 @@ Process: [Main](../tutorial/application-architecture.md#main-and-renderer-proces
   * `label` String (optional) - Button text.
   * `backgroundColor` String (optional) - Button background color in hex format,
     i.e `#ABCDEF`.
-  * `icon` [NativeImage](native-image.md) (optional) - Button icon.
+  * `icon` [NativeImage](native-image.md) | String (optional) - Button icon.
   * `iconPosition` String (optional) - Can be `left`, `right` or `overlay`.
   * `click` Function (optional) - Function to call when the button is clicked.
 

+ 7 - 7
docs/api/touch-bar-scrubber.md

@@ -8,15 +8,15 @@ Process: [Main](../tutorial/application-architecture.md#main-and-renderer-proces
 
 * `options` Object
   * `items` [ScrubberItem[]](structures/scrubber-item.md) - An array of items to place in this scrubber.
-  * `select` Function - Called when the user taps an item that was not the last tapped item.
+  * `select` Function (optional) - Called when the user taps an item that was not the last tapped item.
     * `selectedIndex` Integer - The index of the item the user selected.
-  * `highlight` Function - Called when the user taps any item.
+  * `highlight` Function (optional) - Called when the user taps any item.
     * `highlightedIndex` Integer - The index of the item the user touched.
-  * `selectedStyle` String - Selected item style. Defaults to `null`.
-  * `overlayStyle` String - Selected overlay item style. Defaults to `null`.
-  * `showArrowButtons` Boolean - Defaults to `false`.
-  * `mode` String - Defaults to `free`.
-  * `continuous` Boolean - Defaults to `true`.
+  * `selectedStyle` String (optional) - Selected item style. Defaults to `null`.
+  * `overlayStyle` String (optional) - Selected overlay item style. Defaults to `null`.
+  * `showArrowButtons` Boolean (optional) - Defaults to `false`.
+  * `mode` String (optional) - Defaults to `free`.
+  * `continuous` Boolean (optional) - Defaults to `true`.
 
 ### Instance Properties
 

+ 1 - 1
docs/api/touch-bar-segmented-control.md

@@ -27,7 +27,7 @@ Process: [Main](../tutorial/application-architecture.md#main-and-renderer-proces
     * `buttons` - Make the segments act as buttons, each segment can be pressed and released but never marked as active.
   * `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 - Called when the user selects a new segment.
+  * `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.
 

+ 1 - 1
docs/api/touch-bar.md

@@ -7,7 +7,7 @@ Process: [Main](../tutorial/application-architecture.md#main-and-renderer-proces
 ### `new TouchBar(options)` _Experimental_
 
 * `options` Object
-  * `items` ([TouchBarButton](touch-bar-button.md) | [TouchBarColorPicker](touch-bar-color-picker.md) | [TouchBarGroup](touch-bar-group.md) | [TouchBarLabel](touch-bar-label.md) | [TouchBarPopover](touch-bar-popover.md) | [TouchBarScrubber](touch-bar-scrubber.md) | [TouchBarSegmentedControl](touch-bar-segmented-control.md) | [TouchBarSlider](touch-bar-slider.md) | [TouchBarSpacer](touch-bar-spacer.md))[]
+  * `items` ([TouchBarButton](touch-bar-button.md) | [TouchBarColorPicker](touch-bar-color-picker.md) | [TouchBarGroup](touch-bar-group.md) | [TouchBarLabel](touch-bar-label.md) | [TouchBarPopover](touch-bar-popover.md) | [TouchBarScrubber](touch-bar-scrubber.md) | [TouchBarSegmentedControl](touch-bar-segmented-control.md) | [TouchBarSlider](touch-bar-slider.md) | [TouchBarSpacer](touch-bar-spacer.md))[] (optional)
   * `escapeItem` ([TouchBarButton](touch-bar-button.md) | [TouchBarColorPicker](touch-bar-color-picker.md) | [TouchBarGroup](touch-bar-group.md) | [TouchBarLabel](touch-bar-label.md) | [TouchBarPopover](touch-bar-popover.md) | [TouchBarScrubber](touch-bar-scrubber.md) | [TouchBarSegmentedControl](touch-bar-segmented-control.md) | [TouchBarSlider](touch-bar-slider.md) | [TouchBarSpacer](touch-bar-spacer.md) | null) (optional)
 
 Creates a new touch bar with the specified items. Use

+ 22 - 22
spec/api-touch-bar-spec.js → spec-main/api-touch-bar-spec.ts

@@ -1,53 +1,53 @@
-const path = require('path')
-const { BrowserWindow, TouchBar } = require('electron').remote
-const { closeWindow } = require('./window-helpers')
-const { expect } = require('chai')
+import * as path from 'path'
+import { BrowserWindow, TouchBar } from 'electron'
+import { closeWindow } from './window-helpers'
+import { expect } from 'chai'
 
-const { TouchBarButton, TouchBarColorPicker, TouchBarGroup } = TouchBar
-const { TouchBarLabel, TouchBarPopover, TouchBarScrubber, TouchBarSegmentedControl, TouchBarSlider, TouchBarSpacer } = TouchBar
+const { TouchBarButton, TouchBarColorPicker, TouchBarGroup, TouchBarLabel, TouchBarPopover, TouchBarScrubber, TouchBarSegmentedControl, TouchBarSlider, TouchBarSpacer } = TouchBar
 
 describe('TouchBar module', () => {
   it('throws an error when created without an options object', () => {
     expect(() => {
-      const touchBar = new TouchBar()
+      const touchBar = new (TouchBar as any)()
       touchBar.toString()
     }).to.throw('Must specify options object as first argument')
   })
 
   it('throws an error when created with invalid items', () => {
     expect(() => {
-      const touchBar = new TouchBar({ items: [1, true, {}, []] })
+      const touchBar = new TouchBar({ items: [1, true, {}, []] as any })
       touchBar.toString()
     }).to.throw('Each item must be an instance of TouchBarItem')
   })
 
   it('throws an error when an invalid escape item is set', () => {
     expect(() => {
-      const touchBar = new TouchBar({ items: [], escapeItem: 'esc' })
+      const touchBar = new TouchBar({ items: [], escapeItem: 'esc' as any })
       touchBar.toString()
     }).to.throw('Escape item must be an instance of TouchBarItem')
 
     expect(() => {
       const touchBar = new TouchBar({ items: [] })
-      touchBar.escapeItem = 'esc'
+      touchBar.escapeItem = 'esc' as any
     }).to.throw('Escape item must be an instance of TouchBarItem')
   })
 
   describe('BrowserWindow behavior', () => {
-    let window
+    let window: BrowserWindow
 
     beforeEach(() => {
-      window = new BrowserWindow()
+      window = new BrowserWindow({show: false})
     })
 
-    afterEach(() => {
+    afterEach(async () => {
       window.setTouchBar(null)
-      return closeWindow(window).then(() => { window = null })
+      await closeWindow(window)
+      window = null as unknown as BrowserWindow
     })
 
     it('can be added to and removed from a window', () => {
       const label = new TouchBarLabel({ label: 'bar' })
-      const touchBar = new TouchBar([
+      const touchBar = new TouchBar({ items: [
         new TouchBarButton({ label: 'foo', backgroundColor: '#F00', click: () => {} }),
         new TouchBarButton({
           icon: path.join(__dirname, 'fixtures', 'assets', 'logo.png'),
@@ -55,9 +55,9 @@ describe('TouchBar module', () => {
           click: () => {}
         }),
         new TouchBarColorPicker({ selectedColor: '#F00', change: () => {} }),
-        new TouchBarGroup({ items: new TouchBar([new TouchBarLabel({ label: 'hello' })]) }),
+        new TouchBarGroup({ items: new TouchBar({ items: [new TouchBarLabel({ label: 'hello' })] }) }),
         label,
-        new TouchBarPopover({ items: new TouchBar([new TouchBarButton({ label: 'pop' })]) }),
+        new TouchBarPopover({ items: new TouchBar({ items: [new TouchBarButton({ label: 'pop' })] }) }),
         new TouchBarSlider({ label: 'slide', value: 5, minValue: 2, maxValue: 75, change: () => {} }),
         new TouchBarSpacer({ size: 'large' }),
         new TouchBarSegmentedControl({
@@ -72,14 +72,14 @@ describe('TouchBar module', () => {
           mode: 'fixed',
           showArrowButtons: true
         })
-      ])
+      ]})
       const escapeButton = new TouchBarButton({ label: 'foo' })
       window.setTouchBar(touchBar)
       touchBar.escapeItem = escapeButton
       label.label = 'baz'
       escapeButton.label = 'hello'
-      window.setTouchBar()
-      window.setTouchBar(new TouchBar([new TouchBarLabel({ label: 'two' })]))
+      window.setTouchBar(null)
+      window.setTouchBar(new TouchBar({items: [new TouchBarLabel({ label: 'two' })]}))
       touchBar.escapeItem = null
     })
 
@@ -92,7 +92,7 @@ describe('TouchBar module', () => {
       })
       const touchBar = new TouchBar({ items: [button] })
       window.setTouchBar(touchBar)
-      window.emit('-touch-bar-interaction', {}, button.id)
+      window.emit('-touch-bar-interaction', {}, (button as any).id)
     })
 
     it('calls the callback on the escape item when a window interaction event fires', (done) => {
@@ -104,7 +104,7 @@ describe('TouchBar module', () => {
       })
       const touchBar = new TouchBar({ escapeItem: button })
       window.setTouchBar(touchBar)
-      window.emit('-touch-bar-interaction', {}, button.id)
+      window.emit('-touch-bar-interaction', {}, (button as any).id)
     })
   })
 })