Skip to main content

How to implement swipe to reveal options in a RecyclerView in Kotlin Android

How to implement swipe to reveal options in a RecyclerView in Kotlin Android.

Here is a detailed step-by-step tutorial on how to implement swipe to reveal options in a RecyclerView in Kotlin for Android.

Step 1: Set up the project​

Create a new Android project in Android Studio. Make sure you have the latest version of Kotlin plugin installed.

Step 2: Add RecyclerView to the layout file​

Open the layout file for the activity where you want to implement swipe to reveal options. Add a RecyclerView element to the layout file and give it an id.

<androidx.recyclerview.widget.RecyclerView
    android:id="@+id/recyclerView"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    />

Step 3: Create the RecyclerView Adapter​

Create a new Kotlin class for the RecyclerView adapter. This adapter will be responsible for binding the data to the RecyclerView.

class MyAdapter(private val items: List<String>) : RecyclerView.Adapter<MyAdapter.ViewHolder>() {

    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ViewHolder {
        val view = LayoutInflater.from(parent.context).inflate(R.layout.item_layout, parent, false)
        return ViewHolder(view)
    }

    override fun onBindViewHolder(holder: ViewHolder, position: Int) {
        val item = items[position]
        holder.bind(item)
    }

    override fun getItemCount(): Int {
        return items.size
    }

    inner class ViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
        fun bind(item: String) {
            // bind the data to the views
        }
    }
}

Step 4: Create the layout file for each item in the RecyclerView​

Create a new layout file for each item in the RecyclerView. This layout file will define the views for each item.

<LinearLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    android:orientation="horizontal">

    <!-- Add your views here -->

</LinearLayout>

Step 5: Implement swipe to reveal options​

In order to implement swipe to reveal options, we need to add a helper class that extends ItemTouchHelper.Callback. This helper class will handle the swiping gestures and update the RecyclerView accordingly.

class SwipeToDeleteCallback(private val adapter: MyAdapter) : ItemTouchHelper.Callback() {

    override fun getMovementFlags(recyclerView: RecyclerView, viewHolder: RecyclerView.ViewHolder): Int {
        val swipeFlags = ItemTouchHelper.START or ItemTouchHelper.END
        return makeMovementFlags(0, swipeFlags)
    }

    override fun onMove(recyclerView: RecyclerView, viewHolder: RecyclerView.ViewHolder, target: RecyclerView.ViewHolder): Boolean {
        return false
    }

    override fun onSwiped(viewHolder: RecyclerView.ViewHolder, direction: Int) {
        val position = viewHolder.adapterPosition
        adapter.removeItem(position)
    }
}

Step 6: Attach the swipe helper to the RecyclerView​

In the activity where you want to implement swipe to reveal options, initialize the RecyclerView and the adapter, and attach the swipe helper to the RecyclerView.

class MainActivity : AppCompatActivity() {

    private lateinit var recyclerView: RecyclerView
    private lateinit var adapter: MyAdapter

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        recyclerView = findViewById(R.id.recyclerView)
        adapter = MyAdapter(getItems())

        recyclerView.adapter = adapter

        val swipeToDeleteCallback = SwipeToDeleteCallback(adapter)
        val itemTouchHelper = ItemTouchHelper(swipeToDeleteCallback)
        itemTouchHelper.attachToRecyclerView(recyclerView)
    }

    private fun getItems(): List<String> {
        // return your data here
    }
}

That's it! You have successfully implemented swipe to reveal options in a RecyclerView in Kotlin for Android. Now, when you swipe an item in the RecyclerView, it will be removed from the list.

Note: This tutorial assumes that you have basic knowledge of Android development using Kotlin and RecyclerView. If you are new to these concepts, it is recommended to go through some introductory tutorials before proceeding with this tutorial.