mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

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

Browse source
This commit is contained in:
Shelley Vohr 2019-08-08 15:49:43 -07:00 • committed by GitHub
parent 0fb3c8cb7c
commit ed3b69ffb1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/browser-window.md
View file

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

16
spec-main/api-browser-window-spec.ts
View file

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