Add initial touch bar specs
authorKevin Sawicki <kevinsawicki@gmail.com>
Fri, 3 Mar 2017 18:22:25 +0000 (10:22 -0800)
committerKevin Sawicki <kevinsawicki@gmail.com>
Fri, 3 Mar 2017 22:00:39 +0000 (14:00 -0800)
docs/api/touch-bar.md
lib/browser/api/touch-bar.js
spec/api-touch-bar-spec.js [new file with mode: 0644]

index 147087b..a499703 100644 (file)
@@ -13,9 +13,6 @@ Creates a new touch bar with the specified items. Use
 
 ## Examples
 
-The `TouchBar` class is only available in the main process, it is not currently
-possible to use in the renderer process **even** through the remote module.
-
 Below is an example of a simple slot machine touch bar game with a button
 and some labels.
 
index 905179d..d4c8c5c 100644 (file)
@@ -24,7 +24,7 @@ class TouchBar extends EventEmitter {
     super()
 
     if (!Array.isArray(items)) {
-      throw new Error('The items object provided has to be an array')
+      throw new Error('Must specify items array as first argument')
     }
 
     this.windowListeners = {}
@@ -42,7 +42,7 @@ class TouchBar extends EventEmitter {
     }
     items.forEach((item) => {
       if (!(item instanceof TouchBarItem)) {
-        throw new Error('Each item must be an instance of TouchBarItem')
+        throw new Error('Each item must be an instance of TouchBarItem')
       }
       this.ordereredItems.push(item)
       registerItem(item)
@@ -121,7 +121,9 @@ TouchBar.TouchBarButton = class TouchBarButton extends TouchBarItem {
     this._addLiveProperty('backgroundColor', backgroundColor)
     this._addLiveProperty('icon', icon)
     if (typeof click === 'function') {
-      this.onInteraction = config.click
+      this.onInteraction = () => {
+        config.click()
+      }
     }
   }
 }
diff --git a/spec/api-touch-bar-spec.js b/spec/api-touch-bar-spec.js
new file mode 100644 (file)
index 0000000..b658c0c
--- /dev/null
@@ -0,0 +1,50 @@
+const assert = require('assert')
+const {BrowserWindow, TouchBar} = require('electron').remote
+const {closeWindow} = require('./window-helpers')
+
+const {TouchBarButton, TouchBarColorPicker, TouchBarGroup} = TouchBar
+const {TouchBarLabel, TouchBarPopover, TouchBarSlider, TouchBarSpacer} = TouchBar
+
+describe('TouchBar module', function () {
+  it('throws an error when created without an items array', function () {
+    assert.throws(() => {
+      const touchBar = new TouchBar()
+      touchBar.toString()
+    }, /Must specify items array as first argument/)
+  })
+
+  it('throws an error when created with invalid items', function () {
+    assert.throws(() => {
+      const touchBar = new TouchBar([1, true, {}, []])
+      touchBar.toString()
+    }, /Each item must be an instance of TouchBarItem/)
+  })
+
+  describe('BrowserWindow behavior', function () {
+    let window
+
+    beforeEach(function () {
+      window = new BrowserWindow()
+    })
+
+    afterEach(function () {
+      window.setTouchBar(null)
+      return closeWindow(window).then(function () { window = null })
+    })
+
+    it('can be added to and removed from a window', function () {
+      const touchBar = new TouchBar([
+        new TouchBarButton({label: 'foo', backgroundColor: '#F00', click: () => {}}),
+        new TouchBarColorPicker({selectedColor: '#F00', change: () => {}}),
+        new TouchBarGroup({items: new TouchBar([new TouchBarLabel({label: 'hello'})])}),
+        new TouchBarLabel({label: 'bar'}),
+        new TouchBarPopover({items: new TouchBar([new TouchBarButton({label: 'pop'})])}),
+        new TouchBarSlider({label: 'slide', value: 5, minValue: 2, maxValue: 75, change: () => {}}),
+        new TouchBarSpacer({size: 'large'})
+      ])
+      window.setTouchBar(touchBar)
+      window.setTouchBar()
+      window.setTouchBar(new TouchBar([new TouchBarLabel({label: 'two'})]))
+    })
+  })
+})