RoundedProgressBar
A customizable, animated progress bar that features rounded corners. This Android library is designed to look great and be simple to use 🎉
Install / Use
/learn @MackHartley/RoundedProgressBarREADME
Using the RoundedProgressBar library you can easily create beautiful progress bars with individually rounded corners, animating progress text and more! Below are several examples of progress bars created with this library.
<br>
<br>
If you’d like to see if this library is right for your project then try downloading the demo app which is available on the Google Play Store. There you can fully customize a RoundedProgressBar to see if you’re able to achieve the desired look and feel for your project.
<br>
Do you use RoundedProgressBar in your app? Consider adding a picture or GIF of your usage to who_uses_rpb.md. This provides examples to developers on how the library is used and gives your app a bit of free publicity!
Gradle Setup ⚙️
If you don't have this already, add it to your root build.gradle file:
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
Then you can add the dependency to your app build.gradle file:
dependencies {
...
implementation 'com.github.MackHartley:RoundedProgressBar:3.0.0'
}
Notable Features 🌟
- Full Color Customization - You can even specify what color the text is depending on which background it draws over. Transparent colors are also supported
- Complete Text Customization - The text displayed on the progress bar can be <a href="https://github.com/MackHartley/RoundedProgressBar/blob/master/roundedprogressbar/src/main/java/com/mackhartley/roundedprogressbar/ProgressTextFormatter.kt#L3">customized</a> to say whatever you want. Additionally you can add padding and even supply your own font for use with the progress bar (
.ttfand.otfformats supported)
- Low Value Support - The progress bar looks nice even at low values (This is a common issue when dealing with rounded progress bars)
- Any Corner Radius Allowed - Individual corners can even have different radius values
- Modular - The
RoundedProgressBarlibrary can be seamlessly included in custom layouts due to the fact that each corner can have a different radius
Additionally, the RoundedProgressBar handles all internal state during configuration changes
Public Methods and Xml Attributes 💻
These are the methods which can be called on the RoundedProgressBar class:
setProgressPercentage(progressPercentage: Double, shouldAnimate: Boolean = true)
getProgressPercentage(): Double
setProgressDrawableColor(@ColorInt newColor: Int) // Sets the color of the 'progress' part of the progress bar
setBackgroundDrawableColor(@ColorInt newColor: Int) // Sets the color of the 'background' part of the progress bar
setProgressTextColor(@ColorInt newColor: Int) // Sets text color for when it is drawn over the progress part of progress bar
setBackgroundTextColor(@ColorInt newColor: Int) // Sets text color for when it is drawn over the background part of progress bar
setCornerRadius(
topLeftRadius: Float,
topRightRadius: Float,
bottomRightRadius: Float,
bottomLeftRadius: Float
)
setTextSize(newTextSize: Float)
setTextPadding(newTextPadding: Float) // Sets the padding between the progress text and end (or start) of the progress bar
setAnimationLength(newAnimationLength: Long)
showProgressText(shouldShowProgressText: Boolean)
setRadiusRestricted(isRestricted: Boolean)
The RoundedProgressBar can also be configured via xml attributes. Below is the full list of attributes along with the methods they map to.
| Xml Attribute | Method |
|---|---|
| rpbProgress | setProgressPercentage(...) |
| rpbProgressColor | setProgressDrawableColor(...) |
| rpbBackgroundColor | setBackgroundDrawableColor(...) |
| rpbProgressTextColor | setProgressTextColor(...) |
| rpbBackgroundTextColor | setBackgroundTextColor(...) |
| rpbCornerRadius | setCornerRadius(...) |
| rpbCornerRadiusTopLeft | setCornerRadius(...) |
| rpbCornerRadiusTopRight | setCornerRadius(...) |
| rpbCornerRadiusBottomRight | setCornerRadius(...) |
| rpbCornerRadiusBottomLeft | setCornerRadius(...) |
| rpbTextSize | setTextSize(...) |
| rpbTextPadding | setTextPadding(...) |
| rpbAnimationLength | setAnimationLength(...) |
| rpbShowProgressText | showProgressText(...) |
| rpbIsRadiusRestricted | setRadiusRestricted(...) |
Contributing 🤝
Feel free to open up issues on this repo to report bugs or request features.
Additionally if you'd like to contribute to the library please feel free to open up a pull request! Just give me a heads up first though (via issues or comments) so we don't overwrite each other in the event I am updating the project.
Special thanks to all those who have supported this repo thus far!
<p align="center"> <a href="https://github.com/MackHartley/RoundedProgressBar/stargazers"><img src="http://reporoster.com/stars/MackHartley/RoundedProgressBar"/></a> <br> <a href="https://github.com/MackHartley/RoundedProgressBar/network/members"><img src="http://reporoster.com/forks/MackHartley/RoundedProgressBar"/></a> <br> <br> <i>Featured in <a href="https://androidweekly.net/issues/issue-467">Android Weekly</a>, <a href="https://android-arsenal.com/details/1/8327">Android Arsenal</a> and <a href="https://medium.com/@mmbialas/25-best-android-libraries-projects-and-tools-you-dont-want-to-miss-in-2021-681dafe58b1c">Medium</a></i>. </p>License 📄
Copyright 2021 Mack Hartley
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.
