Browse Source

docs: update hasShadow for win and linux (#19675)

Shelley Vohr 5 years ago
parent
commit
ed3b69ffb1
2 changed files with 14 additions and 12 deletions
  1. 3 7
      docs/api/browser-window.md
  2. 11 5
      spec-main/api-browser-window-spec.ts

+ 3 - 7
docs/api/browser-window.md

@@ -1437,20 +1437,16 @@ screen readers
 Sets a 16 x 16 pixel overlay onto the current taskbar icon, usually used to
 convey some sort of application status or to passively notify the user.
 
-#### `win.setHasShadow(hasShadow)` _macOS_
+#### `win.setHasShadow(hasShadow)`
 
 * `hasShadow` Boolean
 
-Sets whether the window should have a shadow. On Windows and Linux does
-nothing.
+Sets whether the window should have a shadow.
 
-#### `win.hasShadow()` _macOS_
+#### `win.hasShadow()`
 
 Returns `Boolean` - Whether the window has a shadow.
 
-On Windows and Linux always returns
-`true`.
-
 #### `win.setOpacity(opacity)` _Windows_ _macOS_
 
 * `opacity` Number - between 0.0 (fully transparent) and 1.0 (fully opaque)

+ 11 - 5
spec-main/api-browser-window-spec.ts

@@ -3338,21 +3338,27 @@ describe('BrowserWindow module', () => {
     })
 
     describe('hasShadow state', () => {
-      // On Windows there is no shadow by default and it can not be changed
-      // dynamically.
+      it('returns a boolean on all platforms', () => {
+        const w = new BrowserWindow({ show: false })
+        const hasShadow = w.hasShadow()
+        expect(hasShadow).to.be.a('boolean')
+      })
+
+      // On Windows there's no shadow by default & it can't be changed dynamically.
       it('can be changed with hasShadow option', () => {
         const hasShadow = process.platform !== 'darwin'
-        const w = new BrowserWindow({ show: false, hasShadow: hasShadow })
+        const w = new BrowserWindow({ show: false, hasShadow })
         expect(w.hasShadow()).to.equal(hasShadow)
       })
 
-      ifit(process.platform === 'darwin')('can be changed with setHasShadow method', () => {
+      it('can be changed with setHasShadow method', () => {
         const w = new BrowserWindow({ show: false })
-        expect(w.hasShadow()).to.be.true('hasShadow')
         w.setHasShadow(false)
         expect(w.hasShadow()).to.be.false('hasShadow')
         w.setHasShadow(true)
         expect(w.hasShadow()).to.be.true('hasShadow')
+        w.setHasShadow(false)
+        expect(w.hasShadow()).to.be.false('hasShadow')
       })
     })
   })