Ecosyste.ms: Awesome

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

https://github.com/jaychang0917/SimpleRecyclerView

A RecyclerView extension for building list more easily.
https://github.com/jaychang0917/SimpleRecyclerView

android diff-utils drag-drop multi-type recyclerview section-header snappy swipe-to-dismiss

Last synced: 1 day ago
JSON representation

A RecyclerView extension for building list more easily.

Lists

README 

        
# SimpleRecyclerView

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

[![Android Weekly](http://img.shields.io/badge/Android%20Weekly-%23243-2CB3E5.svg)](http://androidweekly.net/issues/issue-243)



A RecyclerView extension for building list more easily.



## [Screenshot](https://github.com/jaychang0917/SimpleRecyclerView/blob/master/art/screenshot.md)



## Table of Contents

* [Basic Usage](#basic_usage)

  * [Kotlin android extensions support](#kotlin_support)   

* [Multiple Types](#multi_types)

* [Cell Operations](#cell_ops) 

* [Divider](#divider)

* [Spacing](#spacing)

* [Empty State View](#empty_view) 

* [Section Header](#section_header) 

* [Auto Load More](#auto_load_more)

  * [Load more threshold](#load_more_threshold)

  * [Load more view](#load_more_view)

  * [Load more to top](#load_more_top)

* [Drag & Drop](#drag_drop)

* [Swipe To Dismiss](#swipe_dismiss)

* [Snappy](#snappy)

* [References](#refs)

  * [Attributes](#attr)

  * [Cell Operations](#cell_ops_list)



## Sample Project



    Get it on Google Play




## Installation

In your app level build.gradle :



```java

dependencies {

    implementation 'com.jaychang:simplerecyclerview:2.0.5'

    // for kotlin android extensions

    implementation 'com.jaychang:simplerecyclerview-kotlin-android-extensions:2.0.5'

}

```

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

---



## Basic Usage

Basically, there are three steps to build your list.

#### 1. Configure the SimpleRecyclerView

>[Full attributes list](#attr)



```xml



```

#### 2. Define the cell by extending `SimpleCell`

```java

/**

 * Accept two type arguments,

 * 1st is the data model this cell represents, 2nd is the view holder.

 * */

public class BookCell extends SimpleCell {



  /** 

   * Mandatory constructor, pass your data model as argument 

   * */

  public BookCell(Book item) {

    super(item);

  }



  /**

   * Define the layout resource of this cell

   * */

  @Override

  protected int getLayoutRes() {

    return R.layout.cell_book;

  }



  @NonNull

  @Override

  protected ViewHolder onCreateViewHolder(ViewGroup parent, View cellView) {

    return new ViewHolder(cellView);

  }



  @Override

  protected void onBindViewHolder(ViewHolder holder, int position, Context context, Object payload) {

    holder.textView.setText(getItem().getTitle());

  }

  

  /**

   * Optional

   * */

  @Override

  protected void onUnbindViewHolder(ViewHolder holder) {

    // do your cleaning jobs here when the item view is recycled.

  }



  /**

   * Define your view holder, which must extend SimpleViewHolder.

   * */

  static class ViewHolder extends SimpleViewHolder {

    TextView textView;



    ViewHolder(View itemView) {

      super(itemView);

      textView = itemView.findViewById(R.id.textView);

    }

  }



}

```

##### Kotlin android extensions support

If you are using Kotlin android extensions, the cell can be simplified as following:

```kotlin

class BookCell(item: Book) : SimpleCell(item) {

  override fun getLayoutRes(): Int {

    return R.layout.cell_book

  }



  override fun onBindViewHolder(holder: SimpleViewHolder, position: Int, context: Context, payload: Any) {

    holder.textView.text = item.title

  }

}

```

#### 3. Create cell(s) and add them to the SimpleRecyclerView

```java

List books = DataUtils.getBooks();

List cells = new ArrayList<>();



for (Book book : books) {

  BookCell cell = new BookCell(book);

  // There are two default cell listeners: OnCellClickListener and OnCellLongClickListener

  cell.setOnCellClickListener(new SimpleCell.OnCellClickListener() {

    @Override

    public void onCellClicked(Book item) {

      ...

    }

  });

  cell.setOnCellLongClickListener(new SimpleCell.OnCellLongClickListener() {

    @Override

    public void onCellLongClicked(Book item) {

      ...

    }

  });

  cells.add(cell);

}



simpleRecyclerView.addCells(cells);

```

Then, there you go!



## Multiple Types

SimpleRecyclerView supports multiple cell types. You can add different type of cells to it just like adding different type of objects to a list. The SimpleRecyclerView will handle the rest for you.

```java

List books = DataUtils.getBooks();

List ads = DataUtils.getAds();

List cells = new ArrayList<>();



for (Book book : books) {

  BookCell cell = new BookCell(book);

  cells.add(cell);

}



for (Ad ad : ads) {

  BookAdCell cell = new BookAdCell(ad);

  int position = (ads.indexOf(ad) + 1) * 3;

  // take up full row

  cell.setSpanSize(simpleRecyclerView.getGridSpanCount());

  cells.add(position, cell);

}



simpleRecyclerView.addCells(cells);

```



## Cell Operations

SimpleRecyclerView provides basic CRUD cell operations. 

>[Full cell operations list](#cell_ops_list)



It is common that loading cache data first and then fetch new data from network to update the list. The library provides `addOrUpdateCell()` and `addOrUpdateCells()` operation to achieve that (It uses [DiffUtils][1] under the hood). The cells will not be updated (i.e. receive `onBindViewHolder()` callback) if their bounded data models are the same, otherwsie they will be added to the end of list. 

To enable this feature, the cells must be implemented `Updatable` interface.

```java

public interface Updatable {



  boolean areContentsTheSame(T newItem);



  Object getChangePayload(T newItem);



}

```

```java

public class BookCell extends SimpleCell

  implements Updatable {



  ...



  @Override

  protected void onBindViewHolder(ViewHolder holder, int position, Context context, Object payload) {

    if (payload != null) {

      // partial update

      if (payload instanceof Bundle) {

        Bundle bundle = ((Bundle) payload);

        for (String key : bundle.keySet()) {

          if (KEY_TITLE.equals(key)) {

            holder.textView.setText(bundle.getString(key));

          }

        }

      }

      return;

    }

    ...

  }

  

  /**

   * If the titles of books are same, no need to update the cell, onBindViewHolder() will not be called.

   */

  @Override

  public boolean areContentsTheSame(Book newItem) {

    return getItem().getTitle().equals(newItem.getTitle());

  }



  /**

   * If getItem() is the same as newItem (i.e. their return value of getItemId() are the same)

   * and areContentsTheSame()  return false, then the cell need to be updated,

   * onBindViewHolder() will be called with this payload object.

   * */

  @Override

  public Object getChangePayload(Book newItem) {

    Bundle bundle = new Bundle();

    bundle.putString(KEY_TITLE, newItem.getTitle());

    return bundle;

  }

  

  ...

}

```



## Divider

```xml



```



## Spacing

```xml



```



## Empty State View

The empty state view will be shown automatically when there is no data. If you want to show the empty state view explicitly, you can set `srv_showEmptyStateView` attribute to `true` (Default `false`). 

```xml



```



## Section Header

You can group cells together by providing a [`SectionHeaderProvider`][2] to `setSectionHeader(provider)`. A shorthand method [`SimpleSectionHeaderProvider`][3] is also provided. **The section header is not interative (e.g. can't be clicked)**

```java

SectionHeaderProvider sectionHeaderProvider = new SimpleSectionHeaderProvider() {

  // Your section header view here

  @NonNull

  @Override

  public View getSectionHeaderView(Book item, int position) {

    View view = LayoutInflater.from(SectionHeaderActivity.this).inflate(R.layout.view_section_header, null, false);

    TextView textView = (TextView) view.findViewById(R.id.textView);

    textView.setText(String.format(getString(R.string.category), item.getCategoryName()));

    return view;

  }

  // Your grouping logic here

  @Override

  public boolean isSameSection(Book item, Book nextItem) {

    return item.getCategoryId() == nextItem.getCategoryId();

  }



  // Optional, whether the header is sticky, default false

  @Override

  public boolean isSticky() {

    return stickyCheckbox.isChecked();

  }



  // Optional, top margin of each section header

  @Override

  public int getSectionHeaderMarginTop(Book item, int position) {

    return position == 0 ? 0 : Utils.dp2px(SectionHeaderActivity.this, 16);

  }

};



simpleRecyclerView.setSectionHeader(sectionHeaderProvider);

```



## Auto Load More

#### Load more threshold

```java

// if the total beneath hidden cells count <= 4 and shouldLoadMore() is true, onLoadMore() will be called. Default threshold is 0.

simpleRecyclerView.setAutoLoadMoreThreshold(4);



simpleRecyclerView.setOnLoadMoreListener(new OnLoadMoreListener() {

  @Override

  public boolean shouldLoadMore() {

    return hasMoreData;

  }

  

  @Override

  public void onLoadMore() {

    loadBooks();

  }

});

```



#### Load more view

```xml



```

#### Load more to top

If you are going to build a list like chatting, i.e. the cells are added to top of the list, you should set `setLoadMoreToTop(true)`. This instructs the SimpleRecyclerView to check threshold for the top hidden cells.

```java

simpleRecyclerView.setLoadMoreToTop(true);

```



## Drag & Drop

You can enable drag and drop by providing a [`DragAndDropCallback`][4] for `enableDragAndDrop(callback)` or `enableDragAndDrop(dragHandleResId, callback)`, the latter one accepts a drag handle view resource id, only pressing this view will trigger drag behavior. Default long press to trigger drag behavior. Also, all callback methods of `DragAndDropCallback` are optional.

```java

DragAndDropCallback dragAndDropCallback = new DragAndDropCallback() {

  // Optional, return false if you manipulate custom drag effect in the rest of callbacks.

  @Override

  public boolean enableDefaultRaiseEffect() {

    // default return true

    return super.enableDefaultRaiseEffect();

  }



  // Optional

  @Override

  public void onCellDragStarted(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int position) {

    resultView.setText("Started dragging " + item);

  }



  // Optional

  @Override

  public void onCellMoved(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int fromPosition, int toPosition){

    resultView.setText("Moved " + item + " from " + fromPosition + " to " + toPosition);

  }



  // Optional

  @Override

  public void onCellDropped(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int fromPosition, int toPosition) {

    resultView.setText("Dragged " + item + " from " + fromPosition + " to " + toPosition);

  }



  // Optional

  @Override

  public void onCellDragCancelled(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int currentPosition) {

    resultView.setText("Cancelled dragging " + item);

  }

};



simpleRecyclerView.enableDragAndDrop(R.id.dragHandle, dragAndDropCallback); 

// or

simpleRecyclerView.enableDragAndDrop(dragAndDropCallback);

```



## Swipe To Dismiss

You can enable swipe to dismiss by providing a [`SwipeToDismissCallback`][5] to `enableSwipeToDismiss(callback, swipeDirections)`. All callback methods of `SwipeToDismissCallback` are optional.

```java

SwipeToDismissCallback swipeToDismissCallback = new SwipeToDismissCallback() {

  // Optional, return false if you manipulate custom swipe effect in the rest of callbacks.

  @Override

  public boolean enableDefaultFadeOutEffect() {

    // default return true

    return super.enableDefaultFadeOutEffect();

  }



  // Optional

  @Override

  public void onCellSwiping(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int position, Canvas canvas, float dX, float dY, boolean isControlledByUser) {

    resultView.setText("Item " + item + " is swiping.");

  }



  // Optional

  @Override

  public void onCellSettled(SimpleRecyclerView simpleRecyclerView, View itemView, Book item, int position) {

    resultView.setText("Item " + item + " is settled.");

  }



  // Optional

  @Override

  public void onCellDismissed(SimpleRecyclerView simpleRecyclerView, Book item, int position) {

    resultView.setText("Item: " + item + " is dismissed.");

  }

};



// enable swipe left or right to dismiss

simpleRecyclerView.enableSwipeToDismiss(swipeToDismissCallback, LEFT, RIGHT);

```



## Snappy

```xml



```

---



## Reference



### Attributes



>All attrs have coressponding java method.



| attr                         | Description                                     |

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

| srv_layoutMode | Set which layout mode to be used. Support `linearVertical`, `linearHorizontal` and `grid`. Default `linearVertical` |

| srv_gridSpanCount | Set span count for `grid` layout mode |

| srv_gridSpanSequence | Set span sequence for `grid` layout mode |

| srv_spacing | Cell spacing, if `srv_verticalSpacing` or `srv_horizontalSpacing` are also set, this takes precedence over them |

| srv_verticalSpacing | Vertical cell spacing for `grid` layout mode |

| srv_horizontalSpacing | Horizontal cell spacing for `grid` layout mode |

| srv_isSpacingIncludeEdge | If set to true, spacing will be included in the edges of recyclerview. i.e. top & bottom for linear, all edges for grid. Default `false`  | 

| srv_showDivider | If set to true, add dividers between cells. Default `false` |

| srv_showLastDivider | If set to true, show last divider. Default `false` |

| srv_dividerOrientation | Divider orientation, works with `grid` layout mode. Support `vertical`, `horizontal` and `both`. Default `both` |

| srv_dividerColor | Divider color. Default `#e0e0e0` |

| srv_dividerPaddingLeft | Divider padding left |

| srv_dividerPaddingRight | Divider padding right |

| srv_dividerPaddingTop | Divider padding top |

| srv_dividerPaddingBottom | Divider padding bottom |

| srv_emptyStateView | Layout resource of empty state view to be shown when there is no data. |

| srv_showEmptyStateView | Show empty state view explicitly. Default `false` |

| srv_loadMoreView | Layout resource of load more view to be shown when loading more. |

| srv_snappy | If set to true, snappy mode is enabled. Default `false` |

| srv_snap_alignment | Snap alignment. Support `center` and `start`. Default `center` |



### Cell Operations

| Operation                         | Remark                                |

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

| addCell(SimpleCell cell)                       | Add the cell to the end of list|

| addCell(int atPosition, SimpleCell cell) | Add the cell to a specific position of list |

| addCells(List extends SimpleCell> cells) | Add the cells to the end of list |

| addCells(SimpleCell... cells) | Same as above |

| addCells(int fromPosition, List extends SimpleCell> cells) | Add the cells to list from a specific position |

| addCells(int fromPosition, SimpleCell... cells) | Same as above |

| addOrUpdateCell(T cell) | Add or udpate the cell. The cell should be implemented `Updatable` interface |

| addOrUpdateCells(List cells) | Add or update the cells. The cells should be implemented `Updatable` interface |

| addOrUpdateCells(T... cells) | Same as above |

| removeCell(SimpleCell cell) | Remove the cell from list |

| removeCell(int atPosition) | Remove the cell at specific position |

| removeCells(int fromPosition, int toPosition) | Remove range of cells `[fromPosition..toPosition]` from list |

| removeCells(int fromPosition) | Remove range of cells `[fromPosition..end]` from list |

| removeAllCells() | Remove all cells from list |

| removeAllCells(boolean showEmptyStateView) | Remove all cells from list and tell the SimpleRecyclerView if need to show empty state view. Default `true` |

| updateCell(int atPosition, Object payload) | Update the specific cell with payload. |

| updateCells(int fromPosition, int toPosition, List payloads) | Update the range of cells `[fromPosition..toPosition]` with payloads.｜

| getCell(int atPosition) | Get the cell at specific postion |

| getCells(int fromPosition, int toPosition) | Get a range of cells `[fromPosition..toPosition]` |

| getAllCells() | Get all cells |



[1]: https://goo.gl/AB43P4

[2]: https://github.com/jaychang0917/SimpleRecyclerView/blob/master/library/src/main/java/com/jaychang/srv/decoration/SectionHeaderProvider.java

[3]: https://github.com/jaychang0917/SimpleRecyclerView/blob/master/library/src/main/java/com/jaychang/srv/decoration/SimpleSectionHeaderProvider.java

[4]: https://github.com/jaychang0917/SimpleRecyclerView/blob/master/library/src/main/java/com/jaychang/srv/behavior/DragAndDropCallback.java

[5]: https://github.com/jaychang0917/SimpleRecyclerView/blob/master/library/src/main/java/com/jaychang/srv/behavior/SwipeToDismissCallback.java



## License

```

Copyright 2017 Jay Chang



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.

```