Skip to content

Commit

Permalink
docs: update hasShadow for win and linux (#19691)
Browse files Browse the repository at this point in the history
  • Loading branch information
trop[bot] authored and codebytere committed Aug 9, 2019
1 parent 171c76e commit 3e181b8
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 12 deletions.
10 changes: 3 additions & 7 deletions docs/api/browser-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
16 changes: 11 additions & 5 deletions spec-main/api-browser-window-spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3335,21 +3335,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')
})
})
})
Expand Down

0 comments on commit 3e181b8

Please sign in to comment.