https://github.com/nex3z/notificationbadge

A notification badge with animation.
https://github.com/nex3z/notificationbadge

Last synced: 3 days ago
JSON representation

A notification badge with animation.

• Host: GitHub
• URL: https://github.com/nex3z/notificationbadge
• Owner: nex3z
• License: apache-2.0
• Created: 2016-12-07T13:25:25.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2021-02-07T16:17:29.000Z (almost 4 years ago)
• Last Synced: 2024-11-09T16:43:57.997Z (5 days ago)
• Language: Kotlin
• Homepage:
• Size: 625 KB
• Stars: 322
• Watchers: 13
• Forks: 58
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# NotificationBadge

A notification badge with animation.

![sample](images/sample.gif)

## Gradle

```

implementation 'com.nex3z:notification-badge:1.0.4'

```

## Usage

```xml

```

Use `setNumber(int number)` or `setText(String text)` to add number or arbitrary text on the badge. Use `clear()` to clear the badge.

## Attributes

| Attribute           | Format    | Description                                                                                                |

|---------------------|-----------|------------------------------------------------------------------------------------------------------------|

| textSize            | dimension | Text size.                                                                                                 |

| textColor           | color     | Text color.                                                                                                |

| nbBackground        | reference | Badge background image.                                                                                    |

| nbAnimationEnabled  | boolean   | `true` to enable animation, `false`to disable it. The default is `true`.                                   |

| nbAnimationDuration | integer   | Duration of the animation in milliseconds. The default is `500` milliseconds.                              |

| nbMaxTextLength     | integer   | Max text length allowed to show on the badge. The default is `2`.                                          |

| nbEllipsizeText     | string    | Special text to show when the length of the original text reaches `nbMaxTextLength`. The default is `...`. |

## Licence

```

Copyright 2016 nex3z

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.

```