Home

Awesome

ShortcutBadger: Maven Central

The ShortcutBadger makes your Android App show the count of unread messages as a badge on your App shortcut!

Supported launchers:<br/>

<table> <tr> <td width="130"> <h3>Sony</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_sony.png"/> </td> <td width="130"> <h3>Samsung</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_samsung.png"/> </td> <td width="130"> <h3>LG</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_lg.png"/> </td> <td width="130"> <h3>HTC</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_htc.png"/> </td> </tr> <tr> <td width="130"> <h3>Xiaomi</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_xiaomi.png"/> <br> </td> <td width="130"> <h3>ASUS</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_asus.png"/> </td> <td width="130"> <h3>ADW</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_adw.png"/> </td> <td width="130"> <h3>APEX</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_apex.png"/> </td> <tr> <td width="130"> <h3>NOVA</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_nova.png"/> </td> <td width="130"> <h3>Huawei</h3> <br> (Not Fully Support) <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_huawei.png"/> <br> (1.1.7+) </td> <td width="130"> <h3>ZUK</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_zuk.png"/> <br> (1.1.10+) </td> <td width="130"> <h3>OPPO</h3> <br> (Not Fully Support) <br> <img src="screenshots/ss_oppo.png?raw=true"/> <br> (1.1.10+) </td> </tr> <tr> <td width="130"> <h3>EverythingMe</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_evme.png"/> </td> <td width="130"> <h3>ZTE</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_zte.png"/> <br> (1.1.17+) </td> <td width="260" colspan="2"> <h3>KISS</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_kiss.png"/> <br> (1.1.18+) </td> </tr> <tr> <td width="130"> <h3>LaunchTime</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_launchtime.png"/> </td> <td width="260" colspan="2"> <h3>Yandex Launcher</h3> <br> <img src="https://raw.github.com/leolin310148/ShortcutBadger/master/screenshots/ss_yandex.png"/> <br> (1.1.23+) </td> </tr> </table>

About Xiaomi devices

Xiaomi devices require extra setup with notifications, please read wiki.

IsBadgeWorking?

A tool for displaying your device, launcher & android version and testing whether ShortcutBadger works or not may be downloaded from

USAGE

<br/>1. Add mavenCentral to your build script.

    repositories {
        mavenCentral()
    }

<br/>2. Add dependencies for ShortcutBadger, it's available from maven now.

    dependencies {
        implementation "me.leolin:ShortcutBadger:1.1.22@aar"
    }

<br/>3. Add the codes below:

    int badgeCount = 1;
    ShortcutBadger.applyCount(context, badgeCount); //for 1.1.4+
    ShortcutBadger.with(getApplicationContext()).count(badgeCount); //for 1.1.3
    

<br/>4. If you want to remove the badge

    ShortcutBadger.removeCount(context); //for 1.1.4+
    ShortcutBadger.with(getApplicationContext()).remove();  //for 1.1.3

or

    ShortcutBadger.applyCount(context, 0); //for 1.1.4+
    ShortcutBadger.with(getApplicationContext()).count(0); //for 1.1.3
<br/> <br/> <br/> <br/>

DEVELOP BY

Leo Lin - leolin310148@gmail.com

ABOUT Google Play Developer Term Violations

If you receive a message from Google containing something like this:<br/>

    REASON FOR WARNING: Violation of section 4.4 of the Developer Distribution Agreement.
    

please use version 1.1.0+!

CHANGE LOG

1.1.23:

1.1.22:

1.1.20:

1.1.19:

1.1.18:

1.1.17:

1.1.16:

1.1.15:

1.1.14:

1.1.13:

1.1.12:

1.1.11:

1.1.10:

1.1.9:

1.1.8:

1.1.7:

1.1.6:

1.1.5:

1.1.4:

1.1.3:

1.1.2:

1.1.1:

1.1.0:

1.0.10:

1.0.9:

LICENSE

<br/>
    Copyright 2014 Leo Lin
    
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
    
        http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
<br/>