https://github.com/shuhart/StepView

A simple animated step view for Android
https://github.com/shuhart/StepView

animated-steps step steps stepview

Last synced: 3 months ago
JSON representation

A simple animated step view for Android

• Host: GitHub
• URL: https://github.com/shuhart/StepView
• Owner: shuhart
• License: apache-2.0
• Archived: true
• Created: 2017-10-30T08:16:23.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2023-04-18T06:41:29.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T19:36:18.700Z (6 months ago)
• Topics: animated-steps, step, steps, stepview
• Language: Java
• Size: 1.84 MB
• Stars: 902
• Watchers: 18
• Forks: 154
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - shuhart/StepView - A simple animated step view for Android (Java)

README

        
StepView

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

A simple animated step view for Android. Backward and forward animations is supported.

Usage

-----

1. Add mavenCentral() to repositories block in your gradle file.

2. Add `implementation 'com.github.shuhart:stepview:1.5.1'` to your dependencies.

3. Add `StepView` into your layouts or view hierarchy.

Supported animations:

Name| Preview

-------- | ---

`ANIMATION_LINE`| ![animation_line](/images/animation_line.gif)

`ANIMATION_CIRCLE`| ![animation_circle](/images/animation_circle.gif)

`ANIMATION_ALL`| ![animation_all](/images/animation_all.gif)

`ANIMATION_NONE`| ![animation_none](/images/animation_none.gif)

`ANIMATION_ALL and all next circles enabled`| ![animation_circles](/images/animation_circles.gif)

In ANIMATION_CIRCLE and ANIMATION_NONE examples the line color remains the same. You can achieve this by specifying:

``` app:doneStepLineColor="@color/stepview_line_next" ```

Usage:

Specify steps with xml attribute:

```xml

	app:steps="@array/steps"

```

```java

	stepView.setSteps(List steps);

```

Or Specify numbers of steps so that only circles with step number are shown:

```xml

	app:stepsNumber="4"

```

```java

	stepView.setStepsNumber(4);

```



Styling:

```xml

```

or instantiate and setup it in runtime with handy state builder:

```java

    stepView.getState()

            .selectedTextColor(ContextCompat.getColor(this, R.color.colorAccent))

            .animationType(StepView.ANIMATION_CIRCLE)

            .selectedCircleColor(ContextCompat.getColor(this, R.color.colorAccent))

            .selectedCircleRadius(getResources().getDimensionPixelSize(R.dimen.dp14))

            .selectedStepNumberColor(ContextCompat.getColor(this, R.color.colorPrimary))

            // You should specify only stepsNumber or steps array of strings.

            // In case you specify both steps array is chosen.

            .steps(new ArrayList() {{

                add("First step");

                add("Second step");

                add("Third step");

            }})

            // You should specify only steps number or steps array of strings.

            // In case you specify both steps array is chosen.

            .stepsNumber(4)

            .animationDuration(getResources().getInteger(android.R.integer.config_shortAnimTime))

            .stepLineWidth(getResources().getDimensionPixelSize(R.dimen.dp1))

            .textSize(getResources().getDimensionPixelSize(R.dimen.sp14))

            .stepNumberTextSize(getResources().getDimensionPixelSize(R.dimen.sp16))

            .typeface(ResourcesCompat.getFont(context, R.font.roboto_italic))

            // other state methods are equal to the corresponding xml attributes

            .commit();

```

Change a step:

```java

    // Passing 'true' triggers an animation if enabled.

    // Animation would run if a difference between current and next is 1.

    stepView.go(step, true);

```

If you want to mark last step with a done mark:

```java

	stepView.done(true);

```

If you want to allow going back after that, you should unmark the done state:

```java

	stepView.done(false)

```

You can set a step click listener:

```java

    stepView.setOnStepClickListener(new StepView.OnStepClickListener() {

        @Override

        public void onStepClick(int step) {

            // 0 is the first step

        }

    });

```

See the sample for additional details.

If you want a custom typeface you should add font files to the resource folder "font" and reference any in xml layout.

Alternatively you can specify typeface using the state builder in your code. Look into the sample for additional details on that.

You can enable view to draw remained step circles with a specified color.

In xml:

```xml

```

In java:

```java

    stepView.getState()

        .nextStepCircleEnabled(isChecked)

        .nextStepCircleColor(Color.GRAY)

        .commit();

```

License

=======

    Copyright 2017 Bogdan Kornev.

    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.