SwipeOpenItemTouchHelper

Additional

Language
Java
Version
2.0.1 (May 23, 2019)
Created
Apr 13, 2016
Updated
May 24, 2019
Owner
Alex Townsend (alex-townsend)
Contributor
Alex Townsend (alex-townsend)
1
Activity
Badge
Generate
Download
Source code
APK file

Show card

SwipeOpenItemTouchHelper

Library to easily add swipe-to-open functionality to any RecyclerView.

How To

Create SwipeOpenItemTouchHelper and add to your RecyclerView

RecyclerView recyclerView = ...
SwipeOpenItemTouchHelper helper = new SwipeOpenItemTouchHelper(new SwipeOpenItemTouchHelper.SimpleCallback(
 SwipeOpenItemTouchHelper.START | SwipeOpenItemTouchHelper.END));
helper.attachToRecyclerView(recyclerview);

Implement ViewHolders by extending BaseSwipeOpenViewHolder or implementing SwipeOpenViewHolder.

static class SwipeViewHolder extends BaseSwipeOpenViewHolder {

  public LinearLayout swipeView;
  public TextView startView;
  public TextView endView;
  
  // view holder code

  @NonNull @Override public View getSwipeView() {
    return swipeView;
  }

  @Override public float getEndHiddenViewSize() {
    return endView.getMeasuredWidth();
  }

  @Override public float getStartHiddenViewSize() {
    return startView.getMeasuredWidth();
  }
}

And that's it! Your swipe view can now be swiped open/closed (as long as your layouts are setup correctly).

See sample for examples on how to implement on vertical or horizontal RecyclerView, as well as example layouts for a ViewHolder.

Build

Add through Gradle:

  • Add jitpack to your project's root build.gradle
allprojects {
 repositories {
  ...
  maven { url "https://jitpack.io" }
 }
}
  • Add the dependency
compile 'com.github.alex-townsend:SwipeOpenItemTouchHelper:2.0.0'

Or, add through Maven:

  • Add jitpack repository
<repositories>
 <repository>
     <id>jitpack.io</id>
     <url>https://jitpack.io</url>
 </repository>
</repositories>
  • Add dependency
<dependency>
    <groupId>com.github.alex-townsend</groupId>
    <artifactId>SwipeOpenItemTouchHelper</artifactId>
    <version>2.0.0</version>
</dependency>

License

Copyright 2016 Alex Townsend

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.
License for ItemTouchHelper (that this library was adapted from)
Copyright 2015 The Android Open Source Project
https://github.com/android/platform_frameworks_support/blob/master/v7/recyclerview/src/android/support/v7/widget/helper/ItemTouchHelper.java

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.