Skip to main content

How to implement swipe to refresh in a RecyclerView in Kotlin Android

How to implement swipe to refresh in a RecyclerView in Kotlin Android.

Here's a detailed step-by-step tutorial on how to implement swipe to refresh in a RecyclerView in Kotlin Android.

Step 1: Set up your project​

  • Create a new Android project in Kotlin.
  • Open the build.gradle file (Module: app) and add the following dependency:
implementation 'androidx.recyclerview:recyclerview:1.2.1'

Step 2: Create a RecyclerView​

  • Open the layout file (activity_main.xml) and add a RecyclerView element:
<androidx.recyclerview.widget.RecyclerView
    android:id="@+id/recyclerView"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:layoutManager="androidx.recyclerview.widget.LinearLayoutManager" />

Step 3: Create a ViewHolder​

  • Create a new Kotlin file called MyViewHolder.kt.
  • Define a class called MyViewHolder that extends RecyclerView.ViewHolder:
class MyViewHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
    // Define your view components here
}

Step 4: Create an Adapter​

  • Create a new Kotlin file called MyAdapter.kt.
  • Define a class called MyAdapter that extends RecyclerView.Adapter<MyViewHolder>:
class MyAdapter(private val data: List<String>) : RecyclerView.Adapter<MyViewHolder>() {

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

    override fun onBindViewHolder(holder: MyViewHolder, position: Int) {
        val item = data[position]
        // Bind your data to the view components in the ViewHolder
    }

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

Step 5: Implement SwipeRefreshLayout​

  • Open the layout file (activity_main.xml) and wrap the RecyclerView with a SwipeRefreshLayout:
<androidx.swiperefreshlayout.widget.SwipeRefreshLayout
    android:id="@+id/swipeRefreshLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <androidx.recyclerview.widget.RecyclerView
        android:id="@+id/recyclerView"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:layoutManager="androidx.recyclerview.widget.LinearLayoutManager" />
</androidx.swiperefreshlayout.widget.SwipeRefreshLayout>

Step 6: Initialize RecyclerView and SwipeRefreshLayout​

  • Open the MainActivity file (MainActivity.kt).
  • Inside the onCreate method, initialize the RecyclerView and SwipeRefreshLayout:
val recyclerView: RecyclerView = findViewById(R.id.recyclerView)
val swipeRefreshLayout: SwipeRefreshLayout = findViewById(R.id.swipeRefreshLayout)

val data = listOf("Item 1", "Item 2", "Item 3") // Replace with your data

val adapter = MyAdapter(data)
recyclerView.adapter = adapter

swipeRefreshLayout.setOnRefreshListener {
    // Perform your refresh logic here
}

Step 7: Implement the refresh logic​

  • Inside the setOnRefreshListener block, add the logic to refresh the RecyclerView data:
swipeRefreshLayout.setOnRefreshListener {
    // Perform your refresh logic here

    // For example, you can simulate a network request delay using a Handler
    Handler().postDelayed({
        val newData = listOf("Updated Item 1", "Updated Item 2", "Updated Item 3") // Replace with your updated data
        adapter.notifyDataSetChanged()
        swipeRefreshLayout.isRefreshing = false
    }, 2000) // Delay in milliseconds
}

That's it! You have successfully implemented swipe to refresh in a RecyclerView in Kotlin Android.