Ecosyste.ms: Awesome

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

https://github.com/VictorAlbertos/BreadcrumbsView

A customizable Android view for paginated forms
https://github.com/VictorAlbertos/BreadcrumbsView

Last synced: about 20 hours ago
JSON representation

A customizable Android view for paginated forms

Lists

README

        

# BreadcrumbsView

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-BreadcrumbsView-brightgreen.svg?style=flat)](http://android-arsenal.com/details/1/4475)

A customizable Android view which shows the current step of a given series. Its main purpose is to provide a contextual reference for paginated forms.

![Screenshots](breadcrumbs.gif)

## SetUp

Add to top level *gradle.build* file

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

Add to app module *gradle.build* file
```gradle
dependencies {
compile 'com.github.VictorAlbertos:BreadcrumbsView:0.0.4'
}
```

## Usage

### XML inflation
Define a `BreadcrumbsView` in xml layout as follows:

```xml

```

Among the previous custom attributes, only `app:numberOfSteps` is mandatory, requiring to be an integer value greater than 1.

### Moving between steps
Once instantiated the instance of `BreadcrumbsView`, use `breadcrumbs.nextStep()` to move to the next step, and `breadcrumbs.prevStep()` to move to the previous one. If not steps are left to move backward or forward, an `IndexOutOfBoundsException` is thrown.

### Survive config changes
In order to retain the current step between config changes, use `breadcrumbs.setCurrentStep(int)`. You must call it before the view is measured. Otherwise, it throws an `IllegalStateException`.

### Examples
The module [test-sample](https://github.com/VictorAlbertos/BreadcrumbsView/tree/master/test-sample) contains both a minimal example and a UI test driven by Espresso.