Skip to content

Commit

Permalink
docs: update hasShadow for win and linux (#19675) (#19692)
Browse files Browse the repository at this point in the history
  • Loading branch information
codebytere committed Aug 12, 2019
1 parent 1ca76e8 commit a8e70a8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
10 changes: 3 additions & 7 deletions docs/api/browser-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -1347,20 +1347,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)
Expand Down
18 changes: 12 additions & 6 deletions spec/api-browser-window-spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -3094,23 +3094,29 @@ describe('BrowserWindow module', () => {
})

describe('hasShadow state', () => {
// On Window there is no shadow by default and it can not be changed
// dynamically.
beforeEach(() => { w.destroy() })

it('returns a boolean on all platforms', () => {
w = new BrowserWindow({ show: false })
const hasShadow = w.hasShadow()
assert.strictEqual(typeof hasShadow, 'boolean')
})

it('can be changed with hasShadow option', () => {
w.destroy()
const hasShadow = process.platform !== 'darwin'
w = new BrowserWindow({ show: false, hasShadow: hasShadow })
w = new BrowserWindow({ show: false, hasShadow })
assert.strictEqual(w.hasShadow(), hasShadow)
})

it('can be changed with setHasShadow method', () => {
if (process.platform !== 'darwin') return
w = new BrowserWindow({ show: false })

assert.strictEqual(w.hasShadow(), true)
w.setHasShadow(false)
assert.strictEqual(w.hasShadow(), false)
w.setHasShadow(true)
assert.strictEqual(w.hasShadow(), true)
w.setHasShadow(false)
assert.strictEqual(w.hasShadow(), false)
})
})
})
Expand Down

0 comments on commit a8e70a8

Please sign in to comment.