Detach ItemTouchHelper from RecyclerView

Question

I have a RecyclerView with a working ItemTouchHelper. Everything works great, but I am wondering if there is a way I can detach the ItemTouchHelper from the RecyclerView without re-creating the list? For fun, this is the code I'm using to attach:

ItemTouchHelper.Callback callback = new ItemTouchHelper.SimpleCallback(0, ItemTouchHelper.LEFT | ItemTouchHelper.RIGHT)
{
    ...
};
mItemTouchHelper = new ItemTouchHelper(callback);
mItemTouchHelper.attachToRecyclerView(mPasswordList);

Ideally, I'd like to check a preference in say onResume() of the Activity this RecyclerView lives in and detach the ItemTouchHelper based on that.

score 38 · Answer 1 · answered Mar 27 '16 at 11:23

38

You can detach the ItemTouchHelper from the RecyclerView by setting recyclerview to null:

mItemTouchHelper.attachToRecyclerView(null);

answered Mar 27 '16 at 11:23

Andy Cheng

1,167
10
11

Nice trick. But, beware of this limitation : https://issuetracker.google.com/issues/37092256 Google claims they fix the bug. However, at the time for this comment being written, the fix isn't released to public yet. – Cheok Yan Cheng Jan 31 '18 at 20:31
2

@CheokYanCheng, I've checked Android docs, [they say](https://developer.android.com/reference/androidx/recyclerview/widget/ItemTouchHelper#attachToRecyclerView(androidx.recyclerview.widget.RecyclerView)) that `mItemTouchHelper.attachToRecyclerView(null)` can be used for detaching. – Yamashiro Rion Apr 20 '20 at 08:00

score 27 · Accepted Answer · answered Feb 11 '16 at 17:24

27

My original motivation for this was to allow the user the ability to disable swipe actions on list items if they so choose. I assumed the way to do this was to detach the ItemTouchHelper from the RecyclerView. I have now found the ItemTouchHelper.SimpleCallback has the following method available to override:

@Override
public boolean isItemViewSwipeEnabled()
{
    return mSwipable;
}

So, returning the correct state here effectively turns off the swipe handling. I hope this helps someone in the future.

answered Feb 11 '16 at 17:24

nverbeek

1,882
17
20

4

You save my day (..or my week). Thank you! – Fabrizio Billeci Mar 30 '17 at 15:39
Perfect solution ! – King of Masses Feb 01 '18 at 11:55
This works perfect for me, i can set mSwipable to true or false depends the case thanks alot! – finalpets Jun 06 '19 at 00:42

score 1 · Answer 3 · answered May 14 '21 at 12:44

1

For me, to disable the entire ItemTouchHelper that attached to the RecyclerView just set it to null

mItemTouchHelper = null;

And to re-enable, set it to its value

mItemTouchHelper = new ItemTouchHelper(callback);

answered May 14 '21 at 12:44

Zain

37,492
7
60
84

Detach ItemTouchHelper from RecyclerView

3 Answers3