GithubHelp home page GithubHelp logo

skydoves / progressview Goto Github PK

View Code? Open in Web Editor NEW
756.0 13.0 56.0 486 KB

๐ŸŒŠ A polished and flexible ProgressView, fully customizable with animations.

License: Apache License 2.0

Kotlin 100.00%
kotlin android android-library progressbar progressview animations ux-design skydoves

progressview's Introduction

ProgressView


License API CI Medium License API

๐ŸŒŠ A polished and flexible ProgressView, fully customizable with animations.

UI/UX Design Philosophy

1_z4zp5wWQ202LaX2q9zPyjA

Label is integrated into the progress bar and the label moves flexibly according to the progress.
If the width size of the label is bigger than the width size of the progress, the label will be located on the outside (right side) of the progress bar. We can consider the color of the label according to the color of the container.
And if the width size of the progress is bigger than the width size of the label, the label will be located on the inside of the progress bar. ProgressView follows the color consistency of the label.
You can check more details about it on the medium post.

Including in your project

Maven Central Jitpack

Gradle

Add below codes to your root build.gradle file (not your module build.gradle file).

allprojects {
    repositories {
        mavenCentral()
    }
}

And add a dependency code to your module's build.gradle file.

dependencies {
    implementation "com.github.skydoves:progressview:1.1.3"
}

Usage

Add following XML namespace inside your XML layout file.

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

ProgressView

Here is a basic example of implementing ProgressView.

<com.skydoves.progressview.ProgressView
  android:id="@+id/progressView1"
  android:layout_width="match_parent"
  android:layout_height="35dp"
  app:progressView_colorBackground="@color/white" // the color of the container.
  app:progressView_colorProgress="@color/skyBlue" // the color of the progress bar.
  app:progressView_progress="40" // progress value.
  app:progressView_min="15" // min progress value.
  app:progressView_max="100" // max progress value.
  app:progressView_progressFromPrevious="true" // animates progress from previous progress.
  app:progressView_autoAnimate="true" // starts filling animation automatically when finishing inflate.
  app:progressView_radius="12dp" // the corner radius of the progressView and progress bar.
  app:progressView_padding="1dp" // the padding of the progress bar.
  app:progressView_labelColorInner="@color/white" // the text color when the label placed on the progress bar.
  app:progressView_labelColorOuter="@color/black" // the text color when the label placed out of the progress bar.
  app:progressView_labelSize="13sp" // the label text size.
  app:progressView_labelSpace="10dp" // the space size of the between label and progress bar. 
  app:progressView_labelText="achieve 65%" // the text of the label.
  app:progressView_labelTypeface="bold" // the typeface of the label.
 />

Gradient

We can give a gradient effect to the progress bar using the below attributes.

app:progressView_colorGradientStart="@color/md_yellow_100" // starting color of the gradient.
app:progressView_colorGradientEnd="@color/md_yellow_200" // ending color of the gradient.

We can change the progress color and gradient colors using below methods.

progressView.highlightView.color = ContextCompat.getColor(this, R.color.colorPrimary)
progressView.highlightView.colorGradientEnd = ContextCompat.getColor(this, R.color.colorPrimary)
progressView.highlightView.colorGradientStart = ContextCompat.getColor(this, R.color.colorPrimary)

Progress filling Animation

We can implement progress filling animation using the below attributes or method.

app:progressView_autoAnimate="true" // starts filling animation automatically when progress is changed.

// if you want to animate progress from previous progress.
app:progressView_progressFromPrevious="true"

or we can animate manually using below method.

progressView.progressAnimate()

ProgressViewAnimation

We can implement progress animations when the progress value is changed.

BalloonAnimation.NORMAL
BalloonAnimation.BOUNCE
BalloonAnimation.DECELERATE
BalloonAnimation.ACCELERATEDECELERATE
NORMAL BOUNCE DECELERATE ACCELERATEDECELERATE

If we want to use our customized interpolator, we can use below method.

progressView.interpolator = new NiceInterpolator(); 

Highlighting Effect

We can give a highlighting effect on the progress bar when clicked.

app:progressView_highlighting="true" // gives the highlighting effect or not.
app:progressView_highlightAlpha="0.8" // the alpha of the highlight.
app:progressView_highlightColor="@color/skyBlue" // the color of the highlight.
app:progressView_highlightWidth="1.5dp" // the thickness of the highlight.
app:progressView_padding="1.5dp" // the padding of the progress bar.

OnProgressChangeListener, OnProgressClickListener

We can listen to the progress value is changed or the progressbar is clicked.

progressView.setOnProgressChangeListener(new OnProgressChangeListener() {
  @Override
  public void onChange(float progress) {
    progressView.setLabelText(progress + "% archived");
  }
});

progressView.setOnProgressClickListener(new OnProgressClickListener() {
  @Override
  public void onClickProgress(boolean highlighting) {
    // do something
  }
});

We can simplify it using kotlin.

progressView.setOnProgressChangeListener { progressView.labelText = "achieve ${it.toInt()}%" }
progressView.setOnProgressClickListener { Toast.makeText(baseContext, "clicked", Toast.LENGTH_SHORT).show() }

Vertical Orientation

We can implement the ProgressView vertically using the below option.
We should set the width and height value like vertical shape.

<com.skydoves.progressview.ProgressView
  android:layout_width="35dp"
  android:layout_height="300dp"
  app:progressView_orientation="vertical"
  
  ...

TextForm

TextFrom is an attribute class that has some attributes about TextView for customizing ProgressView's label.

TextForm textForm = new TextForm.Builder(context)
    .setText("This is a TextForm")
    .setTextColor(R.color.colorPrimary)
    .setTextSize(14f)
    .setTextTypeFace(Typeface.BOLD)
    .build();

progressView.setTextForm(textForm);

This is how to create TextForm using kotlin dsl.

val form = textForm(context) {
  text = "This is a TextForm"
  textColor = ContextCompat.getColor(baseContext, R.color.white_87)
  textSize = 14f
  textTypeface = Typeface.BOLD
}

Create using Builder

We can create the ProgressView using ProgressView.Builder.

ProgressView progressView = new ProgressView.Builder(context)
    .setSize(300, 35)
    .setProgress(70f)
    .setMax(100f)
    .setRadius(12f)
    .setDuration(1200L)
    .setAutoAnimate(true)
    .setLabelColorInner(ContextCompat.getColor(context, R.color.white))
    .setLabelColorOuter(ContextCompat.getColor(context, R.color.black))
    .setLabelText("archive 70%")
    .setLabelSize(13f)
    .setLabelSpace(10f)
    .setLabelTypeface(Typeface.BOLD);

This is how to create an instance of the ProgressView using kotlin dsl.

val myProgressView = progressView(context) {
    setSize(300, 35)
    setProgress(70f)
    setMin(10f)
    setMax(100f)
    setRadius(12f)
    setDuration(1200L)
    setAutoAnimate(true)
    setLabelColorInner(ContextCompat.getColor(context, R.color.white))
    setLabelColorOuter(ContextCompat.getColor(context, R.color.black))
    setLabelText("archive 70%")
    setLabelSize(13f)
    setLabelSpace(10f)
    setLabelTypeface(Typeface.BOLD)
}

ProgressView Attributes

Here are attributes of the ProgressView and ProgressView.Builder.

Progressbar

Attributes Type Default Description
orientation ProgressViewOrientation Horizontal ProgressView's orientation.
progress Float 0f value of the progress.
min Float 0f value of the minimum progress. The progress value can not under the min value.
max Float 100f value of the maximum progress. The progress value can not over the max value.
radius Dimension 8dp corner radius of the ProgressView.
padding Dimension 0dp padding of the progressbar.
duration Long 1000L duration of the animation.
colorProgress Color colorPrimary color of the progressbar.
colorBackground Color Color.WHITE color of the container.
colorGradientStart Color colorPrimary starting color of the gradient.
colorGradientEnd Color colorPrimary ending color of the gradient.
borderColor Color colorBackground a border color of the container.
borderWidth Int 0 a border width size of the container.
autoAnimate Boolean true starts filling animation automatically when finishing inflate.
animation ProgressViewAnimation NORMAL animation of the progress animation.
progressFromPrevious Boolean false animates progress from previous progress.

Label

Attributes Type Default Description
labelText String "" text of the progressbar label.
labelSize Dimension 12p text size of the progressbar label.
labelColorInner Int(Color) colorPrimary text color when the label placed on the progress bar.
labelColorOuter Int(Color) colorPrimary text color when the label placed out of the progress bar.
labelSpace Dimension 8dp space size of the between label and progress bar.
labelTypeface Typeface Typeface.NORMAL typeface of the label.
labelConstraints ProgressLabelConstraints Progress determines the constraints of the label positioning.

Highlighting

Attributes Type Default Description
highlighting Boolean false highlights the progressbar when clicked.
highlightColor Int(Color) colorPrimary color of the highlighting effect.
highlightAlpha Float 1f alpha of the highlighting effect.
highlightWidth Float 0dp thickness of the highlighting effect.

Find this library useful? โค๏ธ

Support it by joining stargazers for this repository. โญ

License

Copyright 2019 skydoves (Jaewoong Eum)

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.

progressview's People

Contributors

animsh avatar anoop44 avatar skydoves avatar ten-wang avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

progressview's Issues

RTL please

progressview support RTL but the label inside the progress not going RTL, i hope you can add this feature

Add a way to specify a minimum value for progress.

Add a way that prevents the progress from going below a specified min value.

Something similar to this:

var progress = 0f
    set(value) {
      field = if (value >= max) max
      else if (values <= min) min
      else value
      updateProgressView()
      onProgressChangeListener?.onChange(field)
    }

HighlightView get parent's click event

If I put this progressView in a generic layout (relative or linear doesn't matter) the click listener on parent won't be raised.
I lost a lot of time to understand it, so i want to help someone in same situation.
I had to set same clickListener both to parent and setOnProgressClickListener;

`
parentView.setOnClickListener(new View.OnClickListener() {
@OverRide
public void onClick(final View v)
{
execEvent();
}
});

progressViewLibrary.setOnProgressClickListener(new OnProgressClickListener() {
@OverRide
public void onClickProgress(boolean highlighting)
{
execEvent();
}
});
`

[Feature Req] Animating Progress From Previous Progress

Hi, I love your library.

Currently, I'm implementing multipage registration with viewpager and using your library to show the current progress.

But, I found if it will more 'nice to see?' if the animation start from previous progress.

fun progressAnimate() { ... }
// instead of reset the value to 0, why not using the old progress value

Bunch of core Androidx libraries are not found after implementing the library!

  • Library-Version [v1.1.1]

After implementing the library, the main Androidx libraries are not working for me and my whole project become a pure red thing!

Error description:

Could not determine the dependencies of task ':app:compileDebugJavaWithJavac'.
> Could not resolve all task dependencies for configuration ':app:debugCompileClasspath'.
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.core:core-ktx:1.3.2
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.appcompat:appcompat:1.3.0-alpha01
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.fragment:fragment:1.2.4
         project :app > androidx.activity:activity:1.1.0
         project :app > androidx.vectordrawable:vectordrawable:1.1.0
         project :app > androidx.coordinatorlayout:coordinatorlayout:1.1.0
         project :app > androidx.transition:transition:1.3.0
         project :app > androidx.viewpager2:viewpager2:1.0.0
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.appcompat:appcompat-resources:1.3.0-alpha01
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.drawerlayout:drawerlayout:1.1.0
         project :app > com.google.android.material:material:1.2.1
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.recyclerview:recyclerview:1.2.0-alpha04
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.viewpager:viewpager:1.0.0
         project :app > androidx.loader:loader:1.0.0
   > Could not find androidx.core:core:1.4.0-alpha01.
     Required by:
         project :app > androidx.customview:customview:1.1.0``

Progress is not filled after screen was off

Please complete the following information:

  • Library Version [1.1.3]
  • Affected Device [Samsung Galaxy A30 with Android 11]

Describe the Bug:
I run my app through Android Studio, my device screen was off, when I turn it on, progress was not filled to the correct position, still on zero.
app:progressView_autoAnimate="true"

Screenshot from 2022-01-12 11-35-46

Expected Behavior:
to fill up 2/3 of whole progress width

Screenshot from 2022-01-12 11-36-01

ProgressView is used in RecyclerView

Please complete the following information:

  • Library Version 1.0.9
  • Affected Device(s) ALL

Describe the Bug:
ProgressView can't set progress, but in the getProgress() has value

Label blinking while located on the outside of the progress bar.

  • Library Version [v1.1.1]
  • Affected Device(s) [OnePlus 8T, Android 11, minSdk 26, I haven't tested it on other devices]

I'm making an app that is updating progress bar every 50 milliseconds. When the label is located on the inside of the progress bar, everything works perfectly, but when it's outside, it's rapidly blinking. It looks like it's disappearing for a few milliseconds and then reappearing. Of course, I have a .setOnProgressChangeListener that changes the labelText.
Edit: If I'm not mistaken, it happens because of changing the progress, not the label. It's really noticeable even if I'm updating the progress every second (not every 0.05 s) so I do think that it should be fixed.

21-07-22-00-20-41.online-video-cutter.com.mp4

Android resource linking failed

Getting error after adding this dependency
D:\android\handheld\app\build\intermediates\incremental\mergeDebugResources\merged.dir\values\values.xml:6541: error: resource android:attr/lStar not found.
error: failed linking references.

Label size specified programmatically are not in sp

If I specify label size from code, it looks like it is measured in pixels. Here is the code from library:

this.labelView.setTextSize(TypedValue.COMPLEX_UNIT_PX, labelSize)

I can propose to change it to

this.labelView.setTextSize(labelSize)

because this way you will specify size in sp, not in pixels. This is how all controls in android work. Your default value of 12f is very small because of px units instead of sp.

border color

i need to change the border color, because i want to se backgroud as trasparent

Curved Progress Bar displays Squarish Progress when progress is less than 2%

Please complete the following information:

  • Library Version: 1.0.1
  • Affected Device(s): Any

Describe the Bug:

When the progress bar has a very strong radius or is very curved. The progress bar is showing a more squarish progress than a curved one.

Expected Behavior:

Should still show a more curved one.

Screenshot_20190829-155653

Custom Font Family For Progress Label

Is your feature request related to a problem?

No, it is not related to a problem.

Describe the solution you'd like:

To have our very own custom font family for the progress label.

Describe alternatives you've considered:

No, but if I can't find a solution then I might consider making a custom progessview myself

Cant find OnProgressClickListener written in Java

Hi, is there an OnProgressClickListener written in Java ?(not the kotlin one)
If not, do you think you can add one so we will be able to do this:

`
progressView.setOnProgressClickListener(new OnProgressClickListener()
{

        @Override
        public void onClickProgress(boolean b)
        {
            Toast.makeText(MainActivity.this, progressView.getProgress() + "% selected: " + b, Toast.LENGTH_SHORT).show();
        }
    })

`

(Im coding in Java)
so im getting the error:

class file for kotlin.jvm.functions.Function1 not found

Thanks a lot.

Use with DataBinding in Xml

Is your feature request related to a problem?

No. It is not related to a problem.

Describe the solution you'd like:

I would like to update the progress and progressLabel with viewModel attributes.

app:progressView_progress="@{viewModel.progress}"
app:progressView_labelText="@{viewModel.progress + `%`}"

Describe alternatives you've considered:

None

progress direction

i've managed to change the progress direction using android:layoutDirection
but i need some option to set the direction from the adapter without changing layoutDirection...
is there any other way to animate the progress in another directions?

Im currently using
app:progressView_orientation="horizontal"
but this is showing me from right to left and i want in some cases to show ltr instead,
thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.