Skip to content
This repository was archived by the owner on Oct 16, 2022. It is now read-only.

QuanticLabs/material-stepper

 
 

Repository files navigation

Material Stepper

Dependency

Add it in your root build.gradle at the end of repositories:

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

Add the dependency

dependencies {
    compile 'com.github.mispistachos:material-stepper:1.0.8'
}

Preview

text progress dots tabs

Tab Style

  • classic

classic

  • alternative

alternative

Use

Extend one of these classes TextStepper, ProgressStepper, DotStepper, TabStepper

public class TabSample extends TabStepper {

    @Override
    protected void onCreate(Bundle savedInstanceState) {

        // programatically set colors
        setColorPrimary(Color.parseColor("#795548"));
        setColorPrimaryDark(Color.parseColor("#5d4037"));

        setErrorTimeout(1500);

        // --- only TabStepper ---
        
        // set linear stepper or not
        setLinear(true);

        // show a "previous" button in tab navigation
        showPreviousButton();
        
        // disable touch event on tab
        disabledTouch();
        
        // alternative tab style (see screenshot)
        setAlternativeTab(true);

        setTitle("Stepper Title");

        addStep(new Step());
        addStep(new Step());
        addStep(new Step());

        super.onCreate(savedInstanceState);
    }

    // called when 'complete' button is pressed
    @Override
    public void onComplete() {
        System.out.println("completed");
    }

Extend AbstractStep

public class StepSample extends AbstractStep {

   ...

    // step name
    @Override
    public String name() {
        return "Step title";
    }

    // step optional title (default: "Optional")
    @Override
    public String optional() {
        return "Optional subtitle";
    }
    
    // set step optional or not (default: false)
    @Override
    public boolean isOptional() {
        return true;
    }

    // override only if step is limited by condition
    @Override
    public boolean nextIf() {
        return i > 5;
    }

    // error showed on change next step ( see nextIf )
    @Override
    public String error() {
        return "<b>Condition</b>";
    }

    // do something when step is visible
    @Override
    public void onStepVisible() {
        super.onStepVisible();
    }

}

Save data returned in onActivityResult

Bundle data = mStepper.getExtras();

Overwrite these strings for support multilanguage / custom titles

<string name="ms_prev">PREV</string>
<string name="ms_next">NEXT</string>
<string name="ms_end">COMPLETE</string>
<string name="ms_continue">CONTINUE</string>
<string name="ms_optional">Optional</string>
<string name="ms_text_step">Step $current of $total</string>

About

Android Library to create simple stepper activities

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Java 100.0%