Git Product home page Git Product logo

electron-windows-badge's Introduction

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

electron-windows-badge's People

Contributors

viktor-shmigol avatar

Watchers

Neginegi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.