make Electron tray icon mimic the Favico.js one

DRY: moved Favicon stuff into the base platform

Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski 2017-05-13 12:37:13 +01:00
parent 0e0918d07c
commit bbda658b7f
3 changed files with 55 additions and 52 deletions

View File

@ -15,12 +15,7 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
const path = require('path'); const {app, Tray, Menu, nativeImage} = require('electron');
const electron = require('electron');
const app = electron.app;
const Tray = electron.Tray;
const MenuItem = electron.MenuItem;
let trayIcon = null; let trayIcon = null;
@ -44,7 +39,7 @@ exports.create = function (win, config) {
} }
}; };
const contextMenu = electron.Menu.buildFromTemplate([ const contextMenu = Menu.buildFromTemplate([
{ {
label: 'Show/Hide ' + config.brand, label: 'Show/Hide ' + config.brand,
click: toggleWin click: toggleWin
@ -64,4 +59,11 @@ exports.create = function (win, config) {
trayIcon.setToolTip(config.brand); trayIcon.setToolTip(config.brand);
trayIcon.setContextMenu(contextMenu); trayIcon.setContextMenu(contextMenu);
trayIcon.on('click', toggleWin); trayIcon.on('click', toggleWin);
win.webContents.on('page-favicon-updated', function(ev, favicons) {
try {
const img = nativeImage.createFromDataURL(favicons[0]);
trayIcon.setImage(img);
} catch (e) {console.error(e);}
});
}; };

View File

@ -17,12 +17,57 @@ See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
*/ */
import BasePlatform from 'matrix-react-sdk/lib/BasePlatform' import BasePlatform from 'matrix-react-sdk/lib/BasePlatform';
import Favico from 'favico.js';
/** /**
* Vector-specific extensions to the BasePlatform template * Vector-specific extensions to the BasePlatform template
*/ */
export default class VectorBasePlatform extends BasePlatform { export default class VectorBasePlatform extends BasePlatform {
constructor() {
super();
// The 'animations' are really low framerate and look terrible.
// Also it re-starts the animationb every time you set the badge,
// and we set the state each time, even if the value hasn't changed,
// so we'd need to fix that if enabling the animation.
this.favicon = new Favico({animation: 'none'});
this._updateFavicon();
}
_updateFavicon() {
try {
// This needs to be in in a try block as it will throw
// if there are more than 100 badge count changes in
// its internal queue
let bgColor = "#d00",
notif = this.notificationCount;
if (this.errorDidOccur) {
notif = notif || "×";
bgColor = "#f00";
}
this.favicon.badge(notif, {
bgColor: bgColor,
});
} catch (e) {
console.warn(`Failed to set badge count: ${e.message}`);
}
}
setNotificationCount(count: number) {
if (this.notificationCount === count) return;
super.setNotificationCount(count);
this._updateFavicon();
}
setErrorStatus(errorDidOccur: boolean) {
if (this.errorDidOccur === errorDidOccur) return;
super.setErrorStatus(errorDidOccur);
this._updateFavicon();
}
/** /**
* Check for the availability of an update to the version of the * Check for the availability of an update to the version of the
* app that's currently running. * app that's currently running.

View File

@ -18,7 +18,6 @@ limitations under the License.
*/ */
import VectorBasePlatform from './VectorBasePlatform'; import VectorBasePlatform from './VectorBasePlatform';
import Favico from 'favico.js';
import request from 'browser-request'; import request from 'browser-request';
import dis from 'matrix-react-sdk/lib/dispatcher.js'; import dis from 'matrix-react-sdk/lib/dispatcher.js';
import q from 'q'; import q from 'q';
@ -27,49 +26,6 @@ import url from 'url';
import UAParser from 'ua-parser-js'; import UAParser from 'ua-parser-js';
export default class WebPlatform extends VectorBasePlatform { export default class WebPlatform extends VectorBasePlatform {
constructor() {
super();
this.runningVersion = null;
// The 'animations' are really low framerate and look terrible.
// Also it re-starts the animationb every time you set the badge,
// and we set the state each time, even if the value hasn't changed,
// so we'd need to fix that if enabling the animation.
this.favicon = new Favico({animation: 'none'});
this._updateFavicon();
}
_updateFavicon() {
try {
// This needs to be in in a try block as it will throw
// if there are more than 100 badge count changes in
// its internal queue
let bgColor = "#d00",
notif = this.notificationCount;
if (this.errorDidOccur) {
notif = notif || "×";
bgColor = "#f00";
}
this.favicon.badge(notif, {
bgColor: bgColor,
});
} catch (e) {
console.warn(`Failed to set badge count: ${e.message}`);
}
}
setNotificationCount(count: number) {
if (this.notificationCount === count) return;
super.setNotificationCount(count);
this._updateFavicon();
}
setErrorStatus(errorDidOccur: boolean) {
if (this.errorDidOccur === errorDidOccur) return;
super.setErrorStatus(errorDidOccur);
this._updateFavicon();
}
/** /**
* Returns true if the platform supports displaying * Returns true if the platform supports displaying