SwipeCoordinator

Additional

Language
Java
Version
0.0.1 (Oct 22, 2016)
Created
Oct 22, 2016
Updated
Oct 24, 2016 (Retired)
Owner
Víctor Albertos (VictorAlbertos)
Contributor
Víctor Albertos (VictorAlbertos)
1
Activity
Badge
Generate
Download
Source code
APK file

Show card

SwipeCoordinator

SwipeCoordinator simplifies the processs of implementing animated swipeable views. It links a view with its parent as a single behavioural unit constrained by the parent boundaries. SwipeCoordinator supports both left-to-right and top-to-bottom direction.

SetUp

Add to top level gradle.build file

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

Add to app module gradle.build file

dependencies {
    compile 'com.github.VictorAlbertos:SwipeCoordinator:0.0.1'
}

Usage

Identify the swipeable view with @id/swipeable_view attribute. Thew ViewGroup containing the swipeable view can not declare any padding attribute, as such as the swipeable view can not declare any margin. Otherwise the calculations will be misleading.

<RelativeLayout
      android:id="@+id/parent_swipeable_view"
      android:layout_width="match_parent"
      android:layout_height="?attr/actionBarSize"
      android:background="@color/colorPrimary">

    <View
        android:id="@id/swipeable_view"
        android:layout_width="?attr/actionBarSize"
        android:layout_height="?attr/actionBarSize"
        android:background="@color/colorAccent"/>

</RelativeLayout>

Create an instance of SwipeCoordinator suppliyng as argument constructor the parent layout of the swipeable view, and the expected direction for the swipe gesture.

ViewGroup parentSwipeableView = (ViewGroup) findViewById(R.id.parent_swipeable_view);
    SwipeCoordinator swipeCoordinator =
        new SwipeCoordinator(parentSwipeableView, SwipeDirection.LEFT_TO_RIGHT);

ActionUpSwipeListener

ActionUpSwipeListener signals the MotionEvent ACTION_UP of the swipeable view providing a boolean as a flag to indicate if the action took place surpassing the threshold value. This callback is the place to determine if the user fulfilled the motion event.

swipeCoordinator.setOnActionUpSwipeListener(new SwipeCoordinator.ActionUpSwipeListener() {
  @Override public void onActionUp(boolean thresholdReached) {
    if (thresholdReached) Toast.makeText(this, "Approved", Toast.LENGTH_SHORT).show();
    else Toast.makeText(this, "Pending", Toast.LENGTH_SHORT).show();
  }
});

ProgressListener

ProgressListener emits the progress of the swipeable view. From 0 to 1, this value represent in percentage the left distance to its fulfilled position. This callback is the perfect place to create animations based on the progress value.

swipeCoordinator.setProgressListener(new SwipeCoordinator.ProgressListener() {
  @Override public void onProgress(float progress) {
    tvAccepted.setScaleX(progress);
    tvAccepted.setScaleY(progress);
    tvAccepted.setAlpha(progress);
  }
});

Survive to config changes

SwipeCoordinator exposes doSwipe method. It translates the swipeable view to the fulfilled stage and calls ProgressListener::onProgress(progress) with a value of 1.0 to restore all the dependent state views (scale, alpha...).

Customization

Threshold

The value in percentage of the threshold to signal it as reached when the user drops the swipeable view. From 0 to 1, being the default value 0.7.

swipeCoordinator.setThreshold(0.5f);

Variance percentage

Increment (if number greater than 1.0) or decrement (if number less than 1.0) the duration of the rearrange animation performed when the user drops the swipeable view. Default value is 1.0.

swipeCoordinator.setVariancePercentage(0.5f);

Examples

The module test-sample contains both example and UI test driven by Espresso.

Author

Víctor Albertos

Another author's libraries:

  • BreadcrumbsView: A customizable Android view for paginated forms.
  • Mockery: Android and Java library for mocking and testing networking layers with built-in support for Retrofit.
  • ReactiveCache: A reactive cache for Android and Java which honors the Observable chain.
  • RxActivityResult: A reactive-tiny-badass-vindictive library to break with the OnActivityResult implementation as it breaks the observables chain.