RecyclerViewEnhanced
Android Library to provide swipe, click and other functionality to RecyclerView
Usage
Add this to your build.gradle file
dependencies {
compile 'com.nikhilpanju.recyclerviewenhanced:recyclerviewenhanced:1.1.0'
}
Features
- Supports API 14+ (Earlier APIs not tested
- Supports any view for "Swipe Options"
- Doesn't require any new adapters or new views. Works with any existing RecyclerViews.
- Requires adding
OnItemTouchListener
to the RecyclerView - Supports clicking and swiping functionalities.
- Supports disabling clicking and swiping for particular items/rows.
- Supports
independentViews
in your items/rows (Read below for more information) - Supports
fadeViews
in your items/rows (Read below for more information)
Demo
Build the sample application to try RecyclerViewEnhanced
Configuring
-
Create an instance ofRecyclerTouchListener
onTouchListener = new RecyclerTouchListener(this, mRecyclerView);
-
SetIndependentViews
andFadeViews
(If required)IndependentViews
are views which can be clicked separately from the entire row. Their clicks have different functionality from row clicks.FadeViews
are views which fade in and out as the rows are swiped closed and opened respectively.onTouchListener.setIndependentViews(R.id.rowButton) .setViewsToFade(R.id.rowButton)
-
ImplementOnRowClickListener
usingsetClickable()
setClickable()
will enable clicks for the recycler view items and theIndependentViews
.setClickable(new RecyclerTouchListener.OnRowClickListener() { @Override public void onRowClicked(int position) { // Do something } @Override public void onIndependentViewClicked(int independentViewID, int position) { // Do something } } )
-
Enable Swipe Functionality
Set the views for which you require a click listener and enable swiping by using
setSwipeable()
.setSwipeOptionViews(R.id.add, R.id.edit, R.id.change) .setSwipeable(R.id.rowFG, R.id.rowBG, new RecyclerTouchListener.OnSwipeOptionsClickListener() { @Override public void onSwipeOptionClicked(int viewID, int position) { if (viewID == R.id.add) { // Do something } else if (viewID == R.id.edit) { // Do something } else if (viewID == R.id.change) { // Do something } } } );
-
Adding the listener to the RecyclerView
In
onResume()
add the listener:mRecyclerView.addOnItemTouchListener(onTouchListener);
In
onPause()
remove the listener:mRecyclerView.removeOnItemTouchListener(onTouchListener);
Additional Functionality
-
Use
onRowLongClickListener
to receive long click events.setLongClickable(true, new RecyclerTouchListener.OnRowLongClickListener() { @Override public void onRowLongClicked(int position) { ToastUtil.makeToast(getApplicationContext(), "Row " + (position + 1) + " long clicked!"); } } )
-
Use
setUnSwipeableRows()
to disable certain rows from swiping. Using this also displays an "difficult-to-slide" animation when trying to slide an unswipeable row. -
Use
setUnClickableRows()
to disable click actions for certain rows. (Note: This also prevents the independentViews from being clicked). -
openSwipeOptions()
opens the swipe options for a specific row. -
closeVisibleBG()
closes any open options. -
Implement
OnSwipeListener
to getonSwipeOptionsClosed()
andonSwipeOptionsOpened()
events.
Closing swipe options when clicked anywhere outside of the recyclerView:
- Make your Activity implement
RecyclerTouchListener.RecyclerTouchListenerHelper
and store the touchListener
private OnActivityTouchListener touchListener; @Override public void setOnActivityTouchListener(OnActivityTouchListener listener) {
this.touchListener = listener;
}
- Override
dispatchTouchEvent()
of your Activity and pass theMotionEvent
variable to thetouchListener
@Override public boolean dispatchTouchEvent(MotionEvent ev) {
if (touchListener != null) touchListener.getTouchCoordinates(ev);
return super.dispatchTouchEvent(ev);
}
Author
- Nikhil Panju ( Github)
License
Copyright 2016 Nikhil Panju
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.