Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Todd-Davies/ProgressWheel

A progress wheel for android, intended for use instead of the standard progress bar.
https://github.com/Todd-Davies/ProgressWheel

Last synced: 1 day ago
JSON representation

A progress wheel for android, intended for use instead of the standard progress bar.

Lists

README 

        
![Project frozen](https://img.shields.io/badge/status-frozen-blue.png) ![Project unmaintained](https://img.shields.io/badge/project-unmaintained-red.svg)



Deprecation warning

===================



This project is no-longer maintained, and has not been maintained for a few years now. If you're looking for an alternative library, consider the below options:



- https://github.com/pnikosis/materialish-progress

- https://github.com/ybq/Android-SpinKit

- https://github.com/zekapp/Android-ProgressViews



If, on the other hand, you'd like to take over maintinance of the project or modernise it, feel free to do so; just send me pull requests or an email (at [email protected]).



Progress Wheel

=============



This is a custom component for Android intended for use instead of a progress bar.



![Sample Image](https://github.com/Todd-Davies/ProgressWheel/raw/master/sample_image.png "An example implementation")

![Sample Image 3](https://github.com/Todd-Davies/ProgressWheel/raw/master/sample_image_3.png "Another example implementation")

![Sample Image 4](https://github.com/Todd-Davies/ProgressWheel/raw/master/sample_image_4.png "Another example implementation")



Compare it side by side with the Android 2x progress wheel:



![Sample Image 5](https://github.com/Todd-Davies/ProgressWheel/raw/master/sample_image5.png "Side by side comparison")



A complete walkthrough of how to use this component in your app

-------------



**XML:**   

To implement the view in your xml layout do the following:



1. Add the following to your attrs.xml file (in res/values):

``` xml



        

        

        

        

        

        

        

        

        

        

        

        

        

        



```



2. Add the following code to the root view of your layout:

`xmlns:ProgressWheel="http://schemas.android.com/apk/res/com.visualdenim.schooltraq"`



3. Add the widget code in the appropriate place in your xml file. Here's a sample implementation:

``` xml

 

```

	

**Java:**   

First you need to either get a ProgressWheel from a layout file, or initalise one. Do this by:



-  `ProgressWheel pw = new ProgressWheel(myContext, myAttributes);`

-  `ProgressWheel pw = (ProgressWheel) findViewById(R.id.pw_spinner);`



To spin the progress wheel, you just call .`startSpinning()` and to stop it spinning, you call `.stopSpinning()`



Incrementing the progress wheel is slightly more tricky, you call `.incrementProgress()`. However, this is out of 360,  

(because a circle has 360 degrees), and will automatically reset once you get past 360. A percentage display is   

automatically displayed.



Using as a dependency

--------------------------



Add this to your build.gradle:



```gradle

	repositories {

	    maven { url "https://jitpack.io" }

	}

	

	dependencies {

	    compile 'com.github.Todd-Davies:ProgressWheel:1.2'

	}

```



Using as a library project

--------------------------



To use it as a library in Android Studio, please edit build.gradle.



Modify:



    apply plugin: 'android'



Into:



    apply plugin: 'android-library'



Since Android SDK Tools revision 17 (released March 2012), this component can

be used as a library project. In this case, you do *not* need to copy anything

into your project's attrs.xml, and you must use the following namespace URI,

instead of the above:



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



Otherwise, usage should be the same.



[Todd Davies](http://todddavies.co.uk) - [@Todd__Davies](http://twitter.com/todd__davies) - 2012