yanzhenjie /SwipeRecyclerView

:melon: RecyclerView侧滑菜单,Item拖拽,滑动删除Item,自动加载更多,HeaderView,FooterView,Item分组黏贴。

★ 5,701⑂ 1,090👁 106⑃ 15● 319▤ 0
JavaApache-2.0Created 2016-08-03github.com/yanzhenjie/SwipeRecyclerView
+0
Daily
5,701
stars
1,090
forks
106
watchers
15
prs
319
issues
0
releases

README

 SwipeRecyclerView

作者的主页:https://www.yanzhenjie.com  
技术交流群:46505645  

----

本库是基于RecyclerView的封装,提供了Item侧滑菜单、Item滑动删除、Item长按拖拽、添加HeaderView/FooterView、加载更多、Item点击监听等基本功能。

 特性
1. Item侧滑菜单,支持水平分布、垂直分布
2. Item长按拖拽、侧滑删除
3. 添加/移除HeaderView/FooterView
4. 自动/点击加载更多的功能
5. 支持二级列表,List形式、Grid形式、Staggered形式
6. Sticky普通布局黏贴和ReyclerView分组黏贴
7. 支持AndroidX

 使用本库只需要使用SwipeRecyclerView即可,用法和原生RecyclerView一模一样,本库比原生的RecyclerView多了几个扩展方法。

 截图
对上面提到的效果基本都有演示,但不是全部,更多效果可以下载Demo查看。

 Item侧滑菜单
  

 Item侧滑删除、拖拽
  

 下拉刷新和加载更多


 HeaderView和FooterView


 Sticky效果和Item分组
  

 和DrawerLayout嵌套


 如何使用
如果你使用的是android support库,那么请添加下述依赖:
groovy
implementation 'com.yanzhenjie.recyclerview:support:1.3.2'


如果你使用的是android x库,那么请添加下述依赖:
groovy
implementation 'com.yanzhenjie.recyclerview:x:1.3.2'


 1. SwipeRecyclerView从1.3.0版本开始支持AndroidX和二级列表,因此相对于低版本的包名和类名有所改动,从低版本升级的开发者需要考量是否要升级。  
2. 为了让开发者方便切换support库和x库,SwipeRecyclerView的support库和x库除了依赖时的名称不一样外,包名、控件名和类名都是一样的,因此两个库不能共存。  

 加入布局
在布局的xml中加入SwipeRecyclerView:
xml



 ItemDecoration
也就是分割线,支持Grid形式和Linear形式,可以选择某个ViewType不画分割线:
java
// 默认构造,传入颜色即可。
ItemDecoration itemDecoration = new DefaultDecoration(color);

// 或者:颜色,宽,高,最后一个参数是不画分割线的ViewType,可以传入多个。
itemDecoration = new DefaultDecoration(color, width, height, excludeViewType);

// 或者:例如下面的123都是不画分割线的ViewType:
itemDecoration = new DefaultDecoration(color, width, height, 1, 2, 3);

SwipeRecyclerView recyclerView = ...;
recyclerView.setDecoration(itemDecoration);


 Item点击监听
java
recyclerView.setOnItemClickListener(new OnItemClickListener() {
    @Override
    public void onItemClick(View view, int position) {
        // TODO...
    }
});


 侧滑菜单
java
// 设置监听器。
swipeRecyclerView.setSwipeMenuCreator(mSwipeMenuCreator);

// 创建菜单:
SwipeMenuCreator mSwipeMenuCreator = new SwipeMenuCreator() {
    @Override
    public void onCreateMenu(SwipeMenu leftMenu, SwipeMenu rightMenu, int position) {
        SwipeMenuItem deleteItem = new SwipeMenuItem(mContext)
            ...; // 各种文字和图标属性设置。
        leftMenu.addMenuItem(deleteItem); // 在Item左侧添加一个菜单。

        SwipeMenuItem deleteItem = new SwipeMenuItem(mContext)
            ...; // 各种文字和图标属性设置。
        leftMenu.addMenuItem(deleteItem); // 在Item右侧添加一个菜单。
        
        // 注意:哪边不想要菜单,那么不要添加即可。
    }
};

// 菜单点击监听。
swipeRecyclerView.setOnItemMenuClickListener(mItemMenuClickListener);

OnItemMenuClickListener mItemMenuClickListener = new OnItemMenuClickListener() {
    @Override
    public void onItemClick(SwipeMenuBridge menuBridge, int position) {
        // 任何操作必须先关闭菜单,否则可能出现Item菜单打开状态错乱。
        menuBridge.closeMenu();
        
        // 左侧还是右侧菜单:
        int direction = menuBridge.getDirection();
        // 菜单在Item中的Position:
        int menuPosition = menuBridge.getPosition();
    }
};


注意:菜单需要设置高度,关于菜单高度:
1. MATCH_PARENT,自动适应Item高度,保持和Item一样高,比较推荐;
2. 指定具体的高,比如80;
3. WRAP_CONTENT,自身高度,极不推荐;

 侧滑删除和拖拽
拖拽和侧滑删除的功能默认关闭的,所以先要打开功能:
java
recyclerView.setLongPressDragEnabled(true); // 拖拽排序,默认关闭。
recyclerView.setItemViewSwipeEnable

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON