Skip to content

Latest commit

 

History

History
240 lines (213 loc) · 7.18 KB

README.md

File metadata and controls

240 lines (213 loc) · 7.18 KB
Raw

Forked from badoualy/stepper-indicator

flavors

launcher icon Stepper indicator v2

Pt 2/3

Pt 1/3: ObservableFlow

Pt 3/3: SugarPreferences

BuddyBuild Minimum API 9 Release rakshakhegde newsletter

Designed by the awesome https://dribbble.com/LeslyPyram :)

Check out the release and sample apk here

StepperIndicator + Remixer Medium article here


Please sign up for my newsletter rakshakhegde 📧

Setup

First, add jitpack in your build.gradle at the end of repositories:

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

Then, add the library dependency:

compile 'com.github.rakshakhegde:stepper-indicator:2.0.0-alpha'

Now go do some awesome stuff!

Usage

<com.rakshakhegde.stepperindicator.StepperIndicator
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:stpi_stepCount="5"/>

Attributes:

Name Description Default value
stpi_animDuration duration of the line tracing animation 250 ms
stpi_stepCount number of pages/steps
stpi_circleColor color of the stroke circle #b3bdc2 (grey)
stpi_circleRadius radius of the circle 10dp
stpi_circleStrokeWidth width of circle's radius 4dp
stpi_indicatorColor color for the current page indicator #00b47c (green)
stpi_indicatorRadius radius for the circle of the current page indicator 4dp
stpi_lineColor color of the line between indicators #b3bdc2 (grey)
stpi_lineDoneColor color of a line when step is done #00b47c (green)
stpi_lineStrokeWidth width of the line stroke 2dp
stpi_lineMargin margin at each side of the line 5dp
stpi_showDoneIcon show the done check icon or not true
stpi_showStepNumberInstead display text number for each step instead of bullets false
stpi_useBottomIndicator display the indicator for the current step at the bottom instead of inside bullet false
stpi_useBottomIndicatorWithStepColors use the same color for the bottom indicator as the step color false
stpi_bottomIndicatorHeight set the height for the bottom indicator component 3dp
stpi_bottomIndicatorWidth set the width for the bottom indicator component 50dp
stpi_bottomIndicatorMarginTop set the top margin for the bottom indicator component 10dp
stpi_stepsCircleColors use multiple colors for each step (array of colors with the size at least the same size as the stpi_stepCount value)
stpi_stepsIndicatorColors use multiple colors for each step indicator (array of colors with the size at least the same size as the stpi_stepCount value)
stpi_labels supply an array of strings to show labels for every step indicator
stpi_showLabels Show labels for each step indicator. Useful for timelines or checkpoints. false
stpi_labelMarginTop Top margin for the labels 2dp
stpi_labelSize Size for the labels 12sp
stpi_labelColor Color for the labels android:textColorSecondary defined in your project 
indicator.setViewPager(pager);
// or keep last page as "end page"
indicator.setViewPager(pager, pager.getAdapter().getCount() - 1); //
// or manual change
indicator.setStepCount(3);
indicator.setCurrentStep(2);

Created & Maintained By

Rakshak R.Hegde (@rakshakhegde) Wanna contribute to this project? Pull requests welcome ❤️

Note: This project is a part of an ongoing series of open-source projects I'm working on. If you liked my work, please consider following me on Twitter @rakshakhegde and Github. Also please share this project with fellow developers. I'm also starting a newsletter of my own called rakshakhegde 📧. It would be great if you could fill in your email address and subscribe to my new project announcements, releases or blog posts. Subscribe here :)

License

The MIT License (MIT)

Copyright (c) 2017 Rakshak Hegde

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.