LoadingButtonAndroid

Additional

Language
Kotlin
Version
2.1.4 (May 17, 2019)
Created
Aug 11, 2016
Updated
May 17, 2019
Owner
Leandro Borges Ferreira (leandroBorgesFerreira)
Contributors
Guilherme Torres Castro (guitcastro)
cavega
searchy2
shahimclt
Leandro Borges Ferreira (leandroBorgesFerreira)
NetoDevel
jbmlaird
jachenry
ZinoKader
MrStahlfelge
jguerinet
thesalah
bors[bot]
borsleandro[bot]
flo5324
NicolasDucom
wokkaflokka
ookamip
Show all (20)20
Activity
Badge
Generate
Download
Source code
APK file

Advertising

Progress Button Android

Android Button that morphs into a loading progress bar.

  • Fully customizable in the XML
  • Really simple to use.
  • Makes your app looks cooler =D

You can check how this library was implemented here (Old version): https://medium.com/p/9efee6e39711/

Contents

Installation

implementation 'br.com.simplepass:loading-button-android:2.1.4'

How to use

Animate and revert animation

Add the button in your layout file and customize it the way you like it.

<br.com.simplepass.loadingbutton.customViews.CircularProgressButton
 android:id="@+id/btn_id"
 android:layout_width="match_parent"
 android:layout_height="wrap_content"
 android:background="@drawable/circular_border_shape" />
 app:spinning_bar_width="4dp" <!-- Optional -->
 app:spinning_bar_color="#FFF" <!-- Optional -->
 app:spinning_bar_padding="6dp" <!-- Optional -->

Then, instanciate the button

CircularProgressButton btn = (CircularProgressButton) findViewById(R.id.btn_id)
btn.startAnimation();

//[do some async task. When it finishes]
//You can choose the color and the image after the loading is finished
btn.doneLoadingAnimation(fillColor, bitmap);

//[or just revert de animation]
btn.revertAnimation();

You can also add a callback to trigger an action after the startAnimation has finished resizing the button :

btn.startAnimation {
 <start async task>
}

Switch to determinant progress

You can switch between indeterminant and determinant progress:

circularProgressButton.setProgress(10)
...
circularProgressButton.setProgress(50)
...
circularProgressButton.setProgress(100)

- Show 'done' animation

When the loading animation is running, call:

//Choose the color and the image that will be show
circularProgressButton.doneLoadingAnimation(fillColor, bitmap);

- Revert the loading animation with different text or image

progressButton.revertAnimation {
 progressButton.text = "Some new text"
}

or

progressImageButton.revertAnimation {
 progressImageButton.setImageResource(R.drawable.image)
}

- Button State

This button is a state machine and it changes its state during the animation process. The states are:

Before Draw

This state is the initial one, the button is in this state before the View is draw on the screen. This is the state when the button is accesed in the onCreate() of an Activity.

Idle

After the button is drawn in the screen, it gets in the Idle state. It is basically waiting for an animation. Call startAnimation() to start animations with this button.

WAITING_PROGRESS

If the startAnimation() is called before the Idle state, the button goes to this state. The button waits for the button to be drawn in the screen before start the morph animation.

MORPHING

The button stays in this state during the morphing animation.

PROGRESS

After the morph animation, the button start the progress animation. From this state the done and revert animations can happen.

MORPHING_REVERT

The button stays in this state during the morphing animation reversal.

WAITING_DONE

If the doneLoadingAnimation(fillColor: Int, bitmap: Bitmap) is called when the button is still morphing, it enter in this state. The button waits for the morph animation to complete and then start the done animation.

DONE

The button enters this state when the doneLoadingAnimation finishes.

WAITING_TO_STOP

The button enters this state when the stopAnimation() is called before the morph state is completed. The button waits for the morph animation to complete and the stops further animations.

STOPPED

The button enters this state after stopAnimation() when the button is not morphing.

Configure XML

  • app:spinning_bar_width : Changes the width of the spinning bar inside the button
  • app:spinning_bar_color: Changes the color of the spinning bar inside the button
  • app:spinning_bar_padding: Changes the padding of the spinning bar in relation of the button bounds.
  • app:initialCornerAngle: The initial corner angle of the animation. Insert 0 if you have a square button.
  • app:finalCornerAngle: The final corner angle of the animation.

Problems and troubleshooting

Manifest merge

This library only supports androidx since prior the version 2.0.0. So don't try to use it with the old Support Library. Use androidx instead.

Avoid Memory Leaks

Prior to version 2.1.0, to avoid memory leaks is your code, you must dispose the buttons in the onDestroy method. Example:

override fun onDestroy() {
        super.onDestroy()
 progressButton.dispose()
}

In version 2.1.0, ProgressButton was updated to be a LifecycleObserver and will automatically call dispose() when an onDestroy() event is observed by the lifecycle owner.

Contributing

###Setup Git Pre-commit hook script (Optional)

The purpose of setting up this optional pre-commit hook is so that the lintKotlin Gradle task runs each time you as a developer create a commit. Although the Travis build will run lintKotlin in the cloud, running this locally will allow you to catch Kotlin Lint violations early in the development cycle without having to wait for Travis's build report.

To enable the script, execute the following commands starting from the project's root directory:

cd .git/hooks
ln -s ../../scripts/pre-commit.sh pre-commit     

Bugs and Feedback

For bugs, feature requests, and discussion please use GitHub Issues.

Credits

This library was inspired in this repo: https://github.com/dmytrodanylyk/android-morphing-button

And that's it! Enjoy!