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

chore: deprecate setHighlightMode (#19202)

Browse source
This commit is contained in:
Micha Hanselmann 2019-07-11 08:11:46 -07:00 • committed by Shelley Vohr
parent 06d48514c6
commit 1f70dfbffd
3 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/api/breaking-changes.md
View file

@ -152,6 +152,17 @@ app.enableMixedSandbox()
Mixed-sandbox mode is now enabled by default. Mixed-sandbox mode is now enabled by default.
### `Tray`
Under macOS Catalina our former Tray implementation breaks.
Apple's native substitute doesn't support changing the highlighting behavior.
```js
// Deprecated
tray.setHighlightMode(mode)
// API will be removed in v7.0 without replacement.
```
## Planned Breaking API Changes (5.0) ## Planned Breaking API Changes (5.0)
### `new BrowserWindow({ webPreferences })` ### `new BrowserWindow({ webPreferences })`

2
docs/api/tray.md
View file

@ -216,6 +216,8 @@ Returns `String` - the title displayed next to the tray icon in the status bar
Sets when the tray's icon background becomes highlighted (in blue). Sets when the tray's icon background becomes highlighted (in blue).
**[Deprecated](breaking-changes.md#tray)**
**Note:** You can use `highlightMode` with a [`BrowserWindow`](browser-window.md) **Note:** You can use `highlightMode` with a [`BrowserWindow`](browser-window.md)
by toggling between `'never'` and `'always'` modes when the window visibility by toggling between `'never'` and `'always'` modes when the window visibility
changes. changes.

4
lib/browser/api/tray.js
View file

@ -1,8 +1,12 @@
'use strict' 'use strict'
const { EventEmitter } = require('events') const { EventEmitter } = require('events')
const { deprecate } = require('electron')
const { Tray } = process.electronBinding('tray') const { Tray } = process.electronBinding('tray')
Object.setPrototypeOf(Tray.prototype, EventEmitter.prototype) Object.setPrototypeOf(Tray.prototype, EventEmitter.prototype)
// Deprecations
Tray.prototype.setHighlightMode = deprecate.removeFunction(Tray.prototype.setHighlightMode, 'setHighlightMode')
module.exports = Tray module.exports = Tray