https://github.com/nekocode/Badge

:octocat: Drawable of badge.
https://github.com/nekocode/Badge

android widget

Last synced: 5 months ago
JSON representation

:octocat: Drawable of badge.

• Host: GitHub
• URL: https://github.com/nekocode/Badge
• Owner: nekocode
• License: apache-2.0
• Created: 2016-05-29T07:50:46.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-11-15T21:32:16.000Z (over 1 year ago)
• Last Synced: 2024-10-29T18:24:02.674Z (6 months ago)
• Topics: android, widget
• Language: Java
• Homepage:
• Size: 964 KB
• Stars: 957
• Watchers: 30
• Forks: 126
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-android-ui - Badge - 一系列徽章图片 (徽章(Badge))

README

        
# Badge

[![Apache 2.0 License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0.html) [![Release](https://jitpack.io/v/nekocode/Badge.svg)](https://jitpack.io/#nekocode/Badge)

### Preview

![](art/preview.png)

## Integration

- Add the JitPack repository to your root build.gradle:

```gradle

repositories {

    maven { url "https://jitpack.io" }

}

```

- Add the dependency to your sub build.gradle:

```gradle

dependencies {

    implementation "com.github.nekocode:Badge:${last-version}"

}

```

## Badge Types

This library provides four types of badges with cliche customizations.

| Type | Badge | Type | Badge |

| :----- | :------ | :----- | :------ |

| **`TYPE_NUMBER`** | ![number](art/number.png) | **`TYPE_ONLY_ONE_TEXT`** | ![single](art/single_text.png) |

| **`TYPE_TWO_TEXT`** | ![two](art/two_text.png) | **`TYPE_TWO_TEXT_COMPLEMENTARY`** | ![complementary](art/two_text_complementary.png) |

### Attributes

![](art/attributes.png)

## Usage

The above screenshot's example:

```java

final BadgeDrawable drawable =

        new BadgeDrawable.Builder()

                .type(BadgeDrawable.TYPE_NUMBER)

                .number(9)

                .build();

final BadgeDrawable drawable2 =

        new BadgeDrawable.Builder()

                .type(BadgeDrawable.TYPE_ONLY_ONE_TEXT)

                .badgeColor(0xff336699)

                .text1("VIP")

                .build();

final BadgeDrawable drawable3 =

        new BadgeDrawable.Builder()

                .type(BadgeDrawable.TYPE_WITH_TWO_TEXT_COMPLEMENTARY)

                .badgeColor(0xffCC9933)

                .text1("LEVEL")

                .text2("10")

                .padding(dp2px(2), dp2px(2), dp2px(2), dp2px(2), dp2px(2))

                .strokeWidth(dp2px(1))

                .build();

final BadgeDrawable drawable4 =

        new BadgeDrawable.Builder()

                .type(BadgeDrawable.TYPE_WITH_TWO_TEXT)

                .badgeColor(0xffCC9999)

                .text1("TEST")

                .text2("Pass")

                .build();

final BadgeDrawable drawable5 =

        new BadgeDrawable.Builder()

                .type(BadgeDrawable.TYPE_NUMBER)

                .number(999)

                .badgeColor(0xff336699)

                .build();

```

The above `drawable4` BadgeDrawable has set a number that too large to show, in this case, it will be replaced with **"..."** for showing. And then you can use `toSpannable()` for converting the drawable to SpannableString without setting its drawing bounds. It has already took internal measure.

```java

SpannableString spannableString =

        new SpannableString(TextUtils.concat(

                "TextView ",

                drawable.toSpannable(),

                " ",

                drawable2.toSpannable(),

                " ",

                drawable3.toSpannable(),

                " ",

                drawable4.toSpannable(),

                " ",

                drawable5.toSpannable()

        ));

textView.setText(spannableString);

```

If the drawable's bounds was setted by manual or content view. It will auto cut the text to adjust the bounds' width. Look like:

![](art/1.png)

You can also use the badge drawable for ImageView and other more view.