Skip to content

squeeish/MaterialProgressBar

 
 

Repository files navigation

MaterialProgressBar

Icon

Material Design ProgressBar with consistent appearance on Android 4.0+.

Why MaterialProgressBar?

  • Consistent appearance on Android 4.0+.
  • Correct tinting across platforms.
  • Able to remove the intrinsic padding of framework ProgressBar.
  • Able to hide the track of framework horizontal ProgressBar.
  • Used as a drop-in replacement for framework ProgressBar.

Preview

Android 4.4.4

Android 4.4.4

Samsung Android 5.0.1 (native implementation fails to tint)

Samsung Android 5.0.1

Android 5.1.1

Android 5.1.1

Sample APK

Integration

Gradle:

compile 'me.zhanghai.android.materialprogressbar:library:1.1.6'

Usage

You can either simply use the MaterialProgressBar widget, or set drawables from this library on a regular ProgressBar.

Using Widget

Simply replace your ProgressBar with MaterialProgressBar, and remember to apply corresponding style and attribute for correct behavior.

For example, to create an indeterminate horizontal MaterialProgressBar:

<me.zhanghai.android.materialprogressbar.MaterialProgressBar
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:indeterminate="true"
    app:mpb_progressStyle="horizontal"
    style="@style/Widget.MaterialProgressBar.ProgressBar.Horizontal" />

In order to make your ProgressBar take the correct and consistent size on all versions, you will always need to use one of the styles from this library. The trick inside it is android:minWidth, android:maxWidth (and height) that controls the drawable size.

  • Widget.MaterialProgressBar.ProgressBar
  • Widget.MaterialProgressBar.ProgressBar.Horizontal
  • And more size and no-padding variants in styles.xml

Available custom attributes:

  • app:mpb_progressStyle: Style of progress drawable: circular or horizontal. Defaults to circular.
  • app:mpb_setBothDrawables: Whether both determinate and indeterminate drawables should be set on this progress bar. Determinate circular progress drawable is not supported yet. Defaults to false.
  • app:mpb_useIntrinsicPadding: Whether progress drawable should use its intrinsic padding. Defaults to true.
  • app:mpb_showTrack: Whether progress drawable should show a track. Defaults to true for horizontal progress drawable, false otherwise.

android:tint and app:mpb_tintMode are also supported so that they can control the tinting of progress drawables. The default tint color is ?colorControlActivated, and the default tint mode is src_in.

For a detailed example, you can refer to the sample app's layout, there you can find examples such as removing progress bar padding or track.

Using Drawable

Three Material Design drawables are backported to Android 4.0 (API 14), so you can create one and set it directly on your ProgressBar.

For example, to set a IndeterminateHorizontalProgressDrawable on a ProgressBar.

progressBar.setIndeterminateDrawable(new IndeterminateHorizontalProgressDrawable(this));

You will also need to set a style from this library as in the section above.

For example, to define an indeterminate horizontal ProgressBar.

<ProgressBar
            android:id="@+id/indeterminate_horizontal_progress"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:indeterminate="true"
            style="@style/Widget.MaterialProgressBar.ProgressBar.Horizontal" />

Don't forget to create and set the drawable as above.

You can also customize the behavior of these drawables by calling setShowTrack() and setUseIntrinsicPadding(). Tint-related methods setTint(), setTintList() and setTintMode() are also backported so that you can use them directly, but remember to take these drawables as their actual type or TintableDrawable because VM won't be able to find these methods on Drawable for legacy platforms.

For a detailed example, you can refer to the onCreate() method of the old sample's MainActivity and its layout main_activity.xml.

ProGuard

The AAR of this library has already included a Proguard configuration file to make ObjectAnimator work properly.

Older versions

Neither Support v4 nor AppCompat v7 backported animation API to versions prior to ICS, and the NineOldAndroids library has already been deprecated since people should all be using minSdkVersion="14" now, so versions older than ICS are not supported.

License

Copyright 2015 Zhang Hai

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.

About

Material Design ProgressBar with consistent appearance

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 99.9%
  • Shell 0.1%