Awesome Open Source
Awesome Open Source

Electron Windows Badge

Electron Windows Badge plugin to access and modify the badge number of the app icon in windows.

demo

Installation

$ npm i electron-windows-badge --save

Usage

1) Require electron-windows-badge in your main process:
    const Badge = require('electron-windows-badge');

2) Initialize new object of badge while creating window:
    function createWindow () {
        win = new BrowserWindow({width: 800, height: 600});
        const badgeOptions = {}
        new Badge(win, badgeOptions);
    }

3) To update the badge you just need to call this(you must do it in render process):
    ipcRenderer.sendSync('update-badge', 1);

4) To remove badge just call this(you must do it in render process):
    ipcRenderer.sendSync('update-badge', null);

API

Badge options

Option Name Default Value Description
fontColor 'white' Font color
font '24px arial' Font style
color 'red' The color of badge
fit true Be sure that your number will be fit into badge
decimals 0 Numbers after dot (For float numbers)
radius 8 The radius of badge

License

MIT

Alternatives To Electron Windows Badge
Select To Compare


Alternative Project Comparisons
Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Javascript (1,075,498
Js (1,075,497
Icons (15,056
Badge (4,857