Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/akexorcist/RoundCornerProgressBar

[Android] Round Corner Progress Bar Library for Android
https://github.com/akexorcist/RoundCornerProgressBar
android android-library java kotlin
Last synced: 3 months ago
JSON representation
[Android] Round Corner Progress Bar Library for Android
Host: GitHub
URL: https://github.com/akexorcist/RoundCornerProgressBar
Owner: akexorcist
License: apache-2.0
Created: 2015-01-01T11:10:21.000Z (about 10 years ago)
Default Branch: main
Last Pushed: 2023-11-19T11:14:43.000Z (about 1 year ago)
Last Synced: 2024-10-29T17:43:28.223Z (3 months ago)
Topics: android, android-library, java, kotlin
Language: Kotlin
Homepage:
Size: 3.14 MB
Stars: 2,503
Watchers: 68
Forks: 371
Open Issues: 10
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project

awesome-loading-indicators - RoundCornerProgressBar - Round Corner Progress Bar Library for Android. (Java)
README

        ![Android Kotlin](https://img.shields.io/badge/Android-Kotlin-6C3FD1.svg?style=flat&logo=android)

![Minimum SDK Version](https://img.shields.io/badge/API-17+-brightgreen)

[![Maven Central](https://img.shields.io/maven-central/v/com.akexorcist/round-corner-progress-bar?color=brightgreen&label=Maven%20Central)](https://search.maven.org/artifact/com.akexorcist/round-corner-progress-bar)

![Apache 2.0](https://img.shields.io/badge/License-Apache%202-brightgreen)

[![Workflow Status](https://github.com/akexorcist/RoundCornerProgressBar/actions/workflows/android.yml/badge.svg)](https://github.com/akexorcist/RoundCornerProgressBar/actions)

[![Google Dev Library](https://img.shields.io/badge/Google%20Dev%20Library-Round%20Corner%20Progress%20Bar-blue.svg?style=flat)](https://devlibrary.withgoogle.com/products/android/repos/akexorcist-RoundCornerProgressBar)

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Round%20Corner%20Progress%20Bar-blue.svg?style=flat)](http://android-arsenal.com/details/1/1375)

# RoundCornerProgressBar

Round corner is cool. Let's make your progress bar with round corner

![Round Corner Progress Bar Sample](/image/header.jpg)

Colorful rounded corner progress bar

# Download

## Gradle

```groovy

implementation 'com.akexorcist:round-corner-progress-bar:2.2.1'

```

## Demo

Go to [Google Play](https://play.google.com/store/apps/details?id=com.akexorcist.roundcornerprogressbar) to download the demo app

# Overview

### Round Corner Progress Bar

Simple round corner progress bar

![Round Corner Progress Bar](/image/overview_simple.jpg)

### CenteredRoundCornerProgressBar

Round corner progress bar with progress expands from the center

![Centered Round Corner Progress Bar](/image/overview_centered.jpg)

### Icon Round Corner Progress Bar

Round corner progress bar with heading icon

![Icon Round Corner Progress Bar](/image/overview_icon.jpg)

### TextRoundCornerProgressBar

Round corner progress bar with text inside the progress

![Icon Round Corner Progress Bar](/image/overview_text.jpg)

### IndeterminateRoundCornerProgressBar and IndeterminateCenteredRoundCornerProgressBar

Simple round corner progress bar and centered round corner progress bar with indeterminate animation

![Indeterminate Round Corner Progress Bar and Indeterminate Centered Round Corner Progress Bar](/image/overview_indeterminate.gif)

# Feature

### Standard Features

- Primary progress and secondary progress supported

- Primary progress, secondary progress and progress background color are customizable

- Customize your own progress background padding

- Customize your own progress's corner radius

- Reversing progress bar supported

- Progress bar with gradient color? Yes!

- Progress change animation? Absolutely yes!

### Component Features

- Progress expanding from center with `CenteredRoundCornerProgressBar`

- Heading icon supported with `IconRoundCornerProgressBar`

- Text inside progress supported with `TextRoundCornerProgressBar`

- Indeterminate animation supported with `IndeterminateRoundCornerProgressBar` or `IndeterminateCenteredRoundCornerProgressBar`

# Usage

For using custom attribute of progress bar, define 'app' namespace as root view attribute in your layout

```xml

xmlns:app="http://schemas.android.com/apk/res-auto"

```

## RoundCornerProgressBar

### Example

```xml

```

![Round Corner Progress Bar](/image/sample_simple.jpg)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Progress

fun getMax(): Float

fun setMax(max: Float)

fun setMax(max: Int)

fun getProgress(): Float

fun setProgress(progress: Int)

fun setProgress(progress: Float)

fun getSecondaryProgress(): Float

fun setSecondaryProgress(secondaryProgress: Int)

fun setSecondaryProgress(secondaryProgress: Float)

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

// Animation

fun enableAnimation()

fun disableAnimation()

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

fun isProgressAnimating(): Boolean

fun isSecondaryProgressAnimating(): Boolean

// Reversing Progress

fun isReverse(): Boolean

fun setReverse(isReverse: Boolean)

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

// Listener

fun setOnProgressChangedListener(listener: OnProgressChangedListener)

```

## CenteredRoundCornerProgressBar

Same as RoundCornerProgressBar but reversing does not supported.

### Example

```xml

```

![Centerd Round Corner Progress Bar](/image/sample_centered.jpg)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Progress

fun getMax(): Float

fun setMax(max: Float)

fun setMax(max: Int)

fun getProgress(): Float

fun setProgress(progress: Int)

fun setProgress(progress: Float)

fun getSecondaryProgress(): Float

fun setSecondaryProgress(secondaryProgress: Int)

fun setSecondaryProgress(secondaryProgress: Float)

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

// Animation

fun enableAnimation()

fun disableAnimation()

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

fun isProgressAnimating(): Boolean

fun isSecondaryProgressAnimating(): Boolean

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

// Listener

fun setOnProgressChangedListener(listener: OnProgressChangedListener)

```

## IconRoundCornerProgressBar

Icon size is required for this progress bar. Use `wrap_content` for `layout_height` is recommended.

```xml

```

### Example

```xml

```

![Icon Round Corner Progress Bar](/image/sample_icon.jpg)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Progress

fun getMax(): Float

fun setMax(max: Float)

fun setMax(max: Int)

fun getProgress(): Float

fun setProgress(progress: Int)

fun setProgress(progress: Float)

fun getSecondaryProgress(): Float

fun setSecondaryProgress(secondaryProgress: Int)

fun setSecondaryProgress(secondaryProgress: Float)

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

fun getIconSize(): Int

fun setIconSize(size: Int)

fun getIconPadding(): Int

fun setIconPadding(padding: Int)

fun getIconPaddingLeft(): Int

fun setIconPaddingLeft(padding: Int)

fun getIconPaddingTop(): Int

fun setIconPaddingTop(padding: Int)

fun getIconPaddingRight(): Int

fun setIconPaddingRight(padding: Int)

fun getIconPaddingBottom(): Int

fun setIconPaddingBottom(padding: Int)

// Animation

fun enableAnimation()

fun disableAnimation()

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

fun isProgressAnimating(): Boolean

fun isSecondaryProgressAnimating(): Boolean

// Reversing Progress

fun isReverse(): Boolean

fun setReverse(isReverse: Boolean)

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

fun getColorIconBackground(): Int

fun setIconBackgroundColor(color: Int)

// Icon

fun getIconImageResource(): Int

fun setIconImageResource(resId: Int)

fun getIconImageBitmap(): Birmap

fun setIconImageBitmap(bitmap: Bitmap)

fun getIconImageDrawable(): Drawable

fun setIconImageDrawable(drawable: Drawable)

// Listener

fun setOnProgressChangedListener(listener: OnProgressChangedListener)

fun setOnIconClickListener(listener: OnIconClickListener)

```

## TextRoundCornerProgressBar

### Example

```xml

```

![Text Round Corner Progress Bar](/image/sample_text.jpg)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Progress

fun getMax(): Float

fun setMax(max: Float)

fun setMax(max: Int)

fun getProgress(): Float

fun setProgress(progress: Int)

fun setProgress(progress: Float)

fun getSecondaryProgress(): Float

fun setSecondaryProgress(secondaryProgress: Int)

fun setSecondaryProgress(secondaryProgress: Float)

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

fun getTextProgressSize(): Int

fun setTextProgressSize(size: Int)

fun getTextProgressMargin(): Int

fun setTextProgressMargin(margin: Int)

// Animation

fun enableAnimation()

fun disableAnimation()

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

fun isProgressAnimating(): Boolean

fun isSecondaryProgressAnimating(): Boolean

// Reversing Progress

fun isReverse(): Boolean

fun setReverse(isReverse: Boolean)

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

fun getTextProgressColor(): Int

fun setTextProgressColor(color: Int)

// Text

fun getProgressText(): String

fun setProgressText(text: String)

// Position

fun getTextPositionPriority(): Int

fun setTextPositionPriority(priority: Int)

fun getTextInsideGravity(): Int

fun setTextInsideGravity(gravity: Int)

fun getTextOutsideGravity(): Int

fun setTextOutsideGravity(gravity: Int)

// Listener

fun setOnProgressChangedListener(listener: OnProgressChangedListener)

```

## IndeterminateRoundCornerProgressBar

### Example

```xml

```

![Indeterminate Round Corner Progress Bar](/image/sample_indeterminate.gif)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

// Animation

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

// Reversing Progress

fun isReverse(): Boolean

fun setReverse(isReverse: Boolean)

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

```

## IndeterminateCenteredRoundCornerProgressBar

Same as IndeterminateRoundCornerProgressBar

### Example

```xml

```

![Indeterminate Centered Round Corner Progress Bar](/image/sample_indeterminate_centered.gif)

### Layout XML

```xml

```

### Public Methods

```kotlin

// Dimension

fun getRadius(): Int

fun setRadius(radius: Int)

fun getPadding(): Int

fun setPadding(padding: Int)

fun getLayoutWidth(): Float

// Animation

fun getAnimationSpeedScale(): Float

fun setAnimationSpeedScale(scale: Float)

// Reversing Progress

fun isReverse(): Boolean

fun setReverse(isReverse: Boolean)

// Color

fun getProgressBackgroundColor(): Int

fun setProgressBackgroundColor(color: Int)

fun getProgressColor(): Int

fun setProgressColor(color: Int)

fun getProgressColors(): List

fun setProgressColors(colors: List)

fun getSecondaryProgressColor(): Int

fun setSecondaryProgressColor(color: Int)

fun getSecondaryProgressColors(): List

fun setSecondaryProgressColors(colors: List)

```

## Apply Gradient Progress Bar Color

Gradient color for progress bar must be in int array resource. At least 2 colors.

```xml

    

        #009688

        #80CBC4

    

```

![Gradient Progress Bar Color](/image/sample_gradient.jpg)

Progress bar does not clipped when size changed. So the gradient color will fully display without clipping also.

## Apply Progress Change Animation

Animation when progress change is disabled by default (exclude `IndeterminateProgressBar` and `IndeterminateCenteredProgressBar`).

So you have to enable the animation by XML attribute or programmatically

```xml

```

When progress changed, the animation will applied automatically.

![Comparison Between With/Without Animation](/image/animation_comparison.gif)

Animation speed scale's value is float between 0.2 - 5.0 (default is 1.0). Higher for slow down the animation, lower for speed up.

# What's Next

- IconTextRoundCornerProgressBar ([#69](https://github.com/akexorcist/Android-RoundCornerProgressBar/pull/69))

- UI Preview improvement

# Known Issues

- Incorrect progress showing in `CenteredRoundCornerProgressBar` with 1%-2% value

- Incorrect text's width in `TextRoundCornerProgressBar` when `outside` priority and value close to 100%

- `setProgress(progress: Int)` does not update text position

# Change Log

See [CHANGELOG.md](CHANGELOG.md)

# Migration

See [MIGRATION.md](MIGRATION.md)

# Licence

Copyright 2023 Akexorcist

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or 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.