minibugdev / drawablebadge Goto Github PK

View Code? Open in Web Editor NEW

134.0 5.0 29.0 254 KB

Drawable Badge is an Android library for adding badges to drawables.

License: MIT License

Kotlin 100.00%

android kotlin android-library badge hacktoberfest hacktoberfest2022

drawablebadge's Introduction

Drawable Badge

Drawable Badge is a android library for adding badges to drawables.

Usage

Generate drawable with badge

val drawable = DrawableBadge.Builder(context)
    .drawableResId(R.mipmap.ic_launcher_round)
    .badgeColor(R.color.badgeColor)
    .badgeSize(R.dimen.badge_size)
    .badgeGravity(Gravity.CENTER_VERTICAL or Gravity.Start)
    .badgeMargin(R.dimen.badge_margin)
    .textColor(R.color.textColor)
    .showBorder(true)
    .badgeBorderColor(R.color.badgeBorderColor)
    .badgeBorderSize(R.dimen.badge_border_size)
    .maximumCounter(99)
    .showCounter(true)
    .build()
    .get(99)

Apply to image view.

imageViewBadge.setImageDrawable(drawable)

Customize

drawableResId: Drawable resource id to added badges.
drawable: Drawable to added badges.
bitmap: Bitmap to added badges.
textColor: Badge text color resource id, default #FFFFFF.
badgeColor: Badge color resource id , default #FF0000.
badgeSize: Badge size supported @DimenRes or @Px, default 16dp.
badgeGravity: Position of badge by Android Gravity which need to added. default Gravity.TOP or Gravity.END.
badgeMargin: Badge margin supported @DimenRes or @Px, default 0.
showBorder: Set visible of badge border, default true.
badgeBorderColor: Badge border color resource id , default #FFFFFF.
badgeBorderSize: Badge border size supported @DimenRes or @Px, default 0.5dp.
maximumCounter: Maximum counter text will append with +, default and not more than 99.
showCounter: Set visible of badge counter number, default true.

Deprecated

badgePosition: Position of Badge which need to added.

Download

repositories {
    maven { url 'https://jitpack.io' }
}

compile 'com.github.minibugdev:drawablebadge:2.0.1'

License

MIT License

Copyright (c) 2017 Teeranai.P

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

drawablebadge's People

Contributors

Stargazers

Watchers

drawablebadge's Issues

Add support for Badge Position CENTER

Library is very useful, and all the provided methods are amazing.
but the only feature which lacks is the center positioning of badge over parent Drawable.

Imageview Tint overrides badge colors

If the badge added to an Imageview that has android:tint=... in the layout, the tint color overrides any colors added in the builder.

Example:

<ImageView
        android:id="@+id/icon"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:tint="@android:color/white"/>

The badge (number and background) will all be white here, regardless of what colors are chosen in the DrawableBadge builder.

Add support for badgeColor(int)

Nice Library,
but can you please add support for passing color as int since i wanna update color dynamically.
Thanks.

Vectors

Please add support for vectors, it doesn't work right now, crashes with NPE.

.drawableResId(R.drawable.vector_icon)
.drawable(someImageviewWithVector.getDrawable())

       ImageView iconServerState = findViewById(R.id.image_view);
        DrawableBadge drawable = new DrawableBadge.Builder(this)
                .drawableResId(R.drawable.ic_done_black_24dp)
                .badgeColor(R.color.md_green_500)
                .badgeSize(16)
                .badgePosition(BadgePosition.TOP_RIGHT)
                .showBorder(true)
                .badgeBorderColor(android.R.color.white)
                .badgeBorderSize(8)
                .maximumCounter(99)
                .build();
        iconServerState.setImageDrawable(drawable);

error

ImageView cannot be applied to (com.minibugdev.drawablebadge.DrawableBadge)