https://github.com/diftco/SwipeToAction

*** WARNING: This library is no longer maintained *** An easy way to add a simple 'swipe-and-do-something' behavior to your `RecyclerView` items. Just like in Gmail or Inbox apps.
https://github.com/diftco/SwipeToAction

android swipe-actions

Last synced: about 1 month ago
JSON representation

*** WARNING: This library is no longer maintained *** An easy way to add a simple 'swipe-and-do-something' behavior to your `RecyclerView` items. Just like in Gmail or Inbox apps.

• Host: GitHub
• URL: https://github.com/diftco/SwipeToAction
• Owner: vcalvello
• Created: 2015-07-08T20:21:19.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-05-03T21:01:36.000Z (over 6 years ago)
• Last Synced: 2024-08-22T22:31:59.188Z (about 1 month ago)
• Topics: android, swipe-actions
• Language: Java
• Homepage:
• Size: 909 KB
• Stars: 219
• Watchers: 11
• Forks: 45
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
SwipeToAction

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

[![Download](https://api.bintray.com/packages/diftco/maven/swipetoaction/images/download.svg) ](https://bintray.com/diftco/maven/swipetoaction/_latestVersion)

An easy way to add a simple 'swipe-and-do-something' behavior to your `RecyclerView` items.

Just like in Gmail or Inbox apps.

![SwipeToAction Sample](https://raw.githubusercontent.com/diftco/SwipeToAction/master/screenshots/swipetoaction.gif)

### Integration

The lib is available on Maven Central, you can find it with [Gradle, please](http://gradleplease.appspot.com/#swipetoaction)

```

dependencies {

    compile 'co.dift.ui.swipetoaction:library:1.1'

}

```

### Usage

Check a demo project in the `sample/` folder.

1. The view you'll use for the items should have at least 3 children:

 - the one at the front (the last one or anyone with the `tag=front`)

 - the one to reveal when you swipe to left (before the front view or anyone with `tag=reveal-left`)

 - the one to reveal when you swipe to right (before the reveal-left view or anyone with `tag=reveal-right`)

    ```xml

     

     

    

        

     

    

     

     

    

        

     

    

     

     

    

        

    

     

    ```

2. In the adapter for your `RecyclerView` create a ViewHolder that extends SwipeToAction.ViewHolder.

For instance, in the sample project I have a list of books and my items are instances of a Book class, therefore, the ViewHolder inside the adapter looks like this:

    ```java

       public class BookViewHolder extends SwipeToAction.ViewHolder {

         ...

         public BookViewHolder(View v) {

           super(v);

           ...

         }

       }

    ```

    Also, in the `onBindViewHolder` method remember to set the item data to the view holder instance

    

    ```java

      @Override

      public void onBindViewHolder(RecyclerView.ViewHolder holder, int position) {

        Book item = items.get(position);

        BookViewHolder vh = (BookViewHolder) holder;

        vh.data = item;

    

        ...

    

      }

    ```

3. Set the `RecyclerView` as usual to create a vertical list, set the previous adapter and instantiate SwipeToAction

providing the recyclerView instance and a swipe listener `SwipeToAction.SwipeListener`

    ```java

      recyclerView = (RecyclerView) findViewById(R.id.recycler);

      LinearLayoutManager layoutManager = new LinearLayoutManager(this);

      recyclerView.setLayoutManager(layoutManager);

      recyclerView.setHasFixedSize(true);

    

      adapter = new BooksAdapter(this.books);

      recyclerView.setAdapter(adapter);

    

      swipeToAction = new SwipeToAction(recyclerView, new SwipeToAction.SwipeListener() {

        @Override

        public boolean swipeLeft(final Book itemData) {

            //do something

            return true; //true will move the front view to its starting position

        }

    

        @Override

        public boolean swipeRight(Book itemData) {

            //do something

            return true;

        }

    

        @Override

        public void onClick(Book itemData) {

            //do something

        }

    

        @Override

        public void onLongClick(Book itemData) {

            //do something

        }

      });

    ```

# License

    Copyright (C) 2015 Dift.co

    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.