{"id":13494345,"url":"https://github.com/skydoves/BaseRecyclerViewAdapter","last_synced_at":"2025-03-28T14:31:02.522Z","repository":{"id":48139995,"uuid":"126610160","full_name":"skydoves/BaseRecyclerViewAdapter","owner":"skydoves","description":"⚡ Fast way to bind RecyclerView adapter and ViewHolder for implementing clean sections.","archived":false,"fork":false,"pushed_at":"2021-02-05T15:41:52.000Z","size":216,"stargazers_count":167,"open_issues_count":3,"forks_count":15,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-22T04:22:44.706Z","etag":null,"topics":["baseadapter","endless-scroll","paging","recyclerview","recyclerview-adapter","recyclerview-multi-type","skydoves","viewholder"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skydoves.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null},"funding":{"github":"skydoves","custom":["https://www.paypal.me/skydoves","https://www.buymeacoffee.com/skydoves"]}},"created_at":"2018-03-24T14:58:55.000Z","updated_at":"2025-03-18T07:40:41.000Z","dependencies_parsed_at":"2022-08-27T21:11:29.695Z","dependency_job_id":null,"html_url":"https://github.com/skydoves/BaseRecyclerViewAdapter","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skydoves%2FBaseRecyclerViewAdapter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skydoves%2FBaseRecyclerViewAdapter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skydoves%2FBaseRecyclerViewAdapter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skydoves%2FBaseRecyclerViewAdapter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skydoves","download_url":"https://codeload.github.com/skydoves/BaseRecyclerViewAdapter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246045857,"owners_count":20714858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["baseadapter","endless-scroll","paging","recyclerview","recyclerview-adapter","recyclerview-multi-type","skydoves","viewholder"],"created_at":"2024-07-31T19:01:24.158Z","updated_at":"2025-03-28T14:31:01.951Z","avatar_url":"https://github.com/skydoves.png","language":"Kotlin","readme":"# BaseRecyclerViewAdapter \u003cbr\u003e\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)\n[![Build Status](https://travis-ci.org/skydoves/BaseRecyclerViewAdapter.svg?branch=master)](https://travis-ci.org/skydoves/BaseRecyclerViewAdapter)\n[![Javadoc](https://img.shields.io/badge/Javadoc-BaseRecyclerViewAdapter-yellow.svg)](https://skydoves.github.io/libraries/baserecyclerviewadapter/javadoc/baserecyclerviewadapter/com.skydoves.baserecyclerviewadapter/index.html)\u003cbr\u003e\nBaseAdapter and BaseViewHolder for binding each other fastly and implementing multi-sectioned rows easily.\u003cbr\u003e\nAnd lets you implement paging and endless-scrolling for RecyclerView easily.\u003cbr\u003e\n\n![demo0](https://user-images.githubusercontent.com/24237865/37874830-b05ad8ea-3071-11e8-906e-670f56d6912b.png)\n![demo1](https://user-images.githubusercontent.com/24237865/37874865-16e6bb42-3072-11e8-9c6c-aa739cb05410.png)\n\n## Including in your project\n[![Maven Central](https://img.shields.io/maven-central/v/com.github.skydoves/baserecyclerviewadapter.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22com.github.skydoves%22%20AND%20a:%22baserecyclerviewadapter%22)\n[![JitPack](https://jitpack.io/v/skydoves/BaseRecyclerViewAdapter.svg)](https://jitpack.io/#skydoves/BaseRecyclerViewAdapter)\u003c/br\u003e\n#### Gradle\nAdd below codes to your **root** `build.gradle` file (not your module build.gradle file).\n```gradle\nallprojects {\n    repositories {\n        mavenCentral()\n    }\n}\n```\nAnd add a dependency code to your **module**'s `build.gradle` file.\n```gradle\ndependencies {\n    implementation \"com.github.skydoves:baserecyclerviewadapter:1.0.4\"\n}\n```\n\n## Usage\n1. Create a custom ViewHolder class extending `BaseViewHolder` by your custom layout.\u003cbr\u003e\n`bindData` method receives an item model what \"Any\" type in Kotlin or \"object\" type in Java.\u003cbr\u003e\nand you can implement `onClickItem` listener about the item or whatever.\n\n```java\nclass SampleViewHolder(view: View, private val delegate: Delegate) : BaseViewHolder(view) {\n\n    private lateinit var sampleItem: SampleItem\n\n    interface Delegate {\n        fun onItemClick(sampleItem: SampleItem)\n    }\n\n    override fun bindData(data: Any) {\n        if(data is SampleItem) {\n            sampleItem = data\n            drawItem()\n        }\n    }\n\n    private fun drawItem() {\n        itemView.run {\n            sample0_avatar.image = sampleItem.image\n            sample0_name.text = sampleItem.name\n            sample0_content.text = sampleItem.content\n        }\n    }\n\n    override fun onClick(v: View?) {\n        delegate.onItemClick(this.sampleItem)\n    }\n\n    override fun onLongClick(v: View?) = false\n}\n```\n\n2. Create a custom Adapter class extending `BaseAdapter`.\n\n```java\nclass SampleAdapter0(private val delegate: SampleViewHolder.Delegate) : BaseAdapter() {\n\n    private val section_item = 0\n\n    init {\n        addSection(ArrayList\u003cSampleItem\u003e())\n    }\n\n    fun addItems(sampleItems: List\u003cSampleItem\u003e) {\n        addItemsOnSection(section_item, sampleItems)\n        notifyDataSetChanged()\n    }\n\n    override fun layout(sectionRow: SectionRow): Int {\n        return R.layout.item_sample\n    }\n\n    override fun viewHolder(layout: Int, view: View): BaseViewHolder {\n        return SampleViewHolder(view, delegate)\n    }\n}\n```\n\n3. And use at Activities or Fragments.\n```java\nclass SampleActivity0 : AppCompatActivity(), SampleViewHolder.Delegate {\n\n    private val adapter by lazy { SampleAdapter0(this) }\n\n    override fun onCreate(savedInstanceState: Bundle?) {\n        super.onCreate(savedInstanceState)\n        setContentView(R.layout.activity_sample0)\n\n        sample0_recyclerView.adapter = adapter\n        sample0_recyclerView.layoutManager = LinearLayoutManager(this)\n        mockItems()\n    }\n\n    private fun mockItems() {\n        adapter.addItems(MockSamples.mockSampleItems(this, 15))\n    }\n\n    override fun onItemClick(sampleItem: SampleItem) {\n        toast(sampleItem.name)\n    }\n}\n```\n\n### Multi-Type Rows\nIf you want to implement multi-sections or rows on a RecyclerView, you should create more than two custom ViewHolders.\u003cbr\u003e\nAnd you can handle multi-layout like below.\n\n```java\nclass SampleAdapter1(private val delegate: SampleViewHolder.Delegate): BaseAdapter() {\n\n    init {\n        for(i in 0..5) {\n            addSection(ArrayList\u003cAny\u003e())\n        }\n    }\n\n    fun addItems(section: Int, items: List\u003cSampleItem\u003e) {\n        addItemOnSection(section, \"Section$section\")\n        addItemsOnSection(section, items)\n        notifyDataSetChanged()\n    }\n\n    override fun layout(sectionRow: SectionRow): Int {\n        when(sectionRow.row()) {\n            0 -\u003e return R.layout.item_sample1_header\n            else -\u003e return R.layout.item_sample\n        }\n    }\n\n    override fun viewHolder(layout: Int, view: View): BaseViewHolder {\n        when(layout) {\n            R.layout.item_sample1_header -\u003e return SampleViewHolder1_Header(view)\n            R.layout.item_sample -\u003e return SampleViewHolder(view, delegate)\n        }\n        throw Resources.NotFoundException(\"not founded layout\")\n    }\n}\n```\n\n### Multi-Type Sections\nOr you can handle multi-layout by sections like below.\u003cbr\u003e\n```java\nclass GithubUserAdapter(val delegate_header: GithubUserHeaderViewHolder.Delegate,\n                        val delegate: GithubUserViewHolder.Delegate) : BaseAdapter() {\n\n    private val section_header = 0\n    private val section_follower = 1\n\n    init {\n        addSection(ArrayList\u003cGithubUser\u003e())\n        addSection(ArrayList\u003cFollower\u003e())\n    }\n\n    fun updateHeader(resource: Resource\u003cGithubUser\u003e) {\n        resource.data?.let {\n            sections[section_header].clear()\n            sections[section_header].add(it)\n            notifyDataSetChanged()\n        }\n    }\n\n    fun addFollowList(followers: List\u003cFollower\u003e) {\n        sections[section_follower].addAll(followers)\n        notifyDataSetChanged()\n    }\n\n    override fun layout(sectionRow: BaseAdapter.SectionRow): Int {\n        when (sectionRow.section()) {\n            section_header -\u003e return R.layout.layout_detail_header\n            else -\u003e return R.layout.item_github_user\n        }\n    }\n\n    override fun viewHolder(layout: Int, view: View): BaseViewHolder {\n        when (layout) {\n            R.layout.layout_detail_header -\u003e return GithubUserHeaderViewHolder(view, delegate_header)\n            else -\u003e return GithubUserViewHolder(view, delegate)\n        }\n    }\n```\n\n### RecyclerViewPaginator\nRecyclerViewPaginator lets you implementation paging and endless-recyclerView easily.\u003cbr\u003e\u003cbr\u003e\n![demo2](https://user-images.githubusercontent.com/24237865/37875097-a49f5f90-3075-11e8-9ece-42ef11aebbb1.gif)\n\nRecylcerViewPaginator performs invoke loadMore when recyclerView needs to load more items.\u003cbr\u003e\nAnd it would not be called when fetching from network or loading ended.\u003cbr\u003e\nThis is an example of endless-recyclerView.\u003cbr\u003e\n\n```java\nprivate val adapter by lazy { SampleAdapter0(this) }\nprivate lateinit var paginator: RecyclerViewPaginator\n\noverride fun onCreate(savedInstanceState: Bundle?) {\n    super.onCreate(savedInstanceState)\n    setContentView(R.layout.activity_sample2)\n\n    sample2_recyclerView.adapter = adapter\n    sample2_recyclerView.layoutManager = LinearLayoutManager(this)\n    paginator = RecyclerViewPaginator(\n            recyclerView = sample2_recyclerView,\n            onLast = { false },\n            loadMore = { loadMore() },\n            isLoading = { false }\n    )\n    loadMore()\n}\n\nprivate fun loadMore() {\n    adapter.addItems(MockSamples.mockSampleItemsRandom(this, paginator.currentPage * 10, 10))\n}\n```\n\nThis is an [example](https://github.com/skydoves/GithubFollows/blob/master/app/src/main/java/com/skydoves/githubfollows/view/ui/main/MainActivity.kt) of RecyclerViewPaginator with ViewModel's network fetching. \u003cbr\u003e\nAnd you can reference more at this [repository](https://github.com/skydoves/GithubFollows).\n\n```java\noverride fun onCreate(savedInstanceState: Bundle?) {\n    AndroidInjection.inject(this)\n    super.onCreate(savedInstanceState)\n    setContentView(R.layout.activity_main)\n\n    main_recyclerView.adapter = adapter\n    main_recyclerView.layoutManager = LinearLayoutManager(this)\n    paginator = RecyclerViewPaginator(\n            recyclerView = main_recyclerView,\n            isLoading = { viewModel.fetchStatus.isOnLoading },\n            loadMore = { loadMore(it) },\n            onLast = { viewModel.fetchStatus.isOnLast }\n    )\n\n    initializeUI()\n    observeViewModel()\n}\n\nprivate fun loadMore(page: Int) {\n    viewModel.postPage(page)\n}\n\nprivate fun updateGithubUser(resource: Resource\u003cGithubUser\u003e) {\n    when (resource.status) {\n        Status.SUCCESS -\u003e adapter.updateHeader(resource)\n        Status.ERROR -\u003e toast(resource.message.toString())\n        Status.LOADING -\u003e {\n        }\n    }\n}\n```\n\n# License\n```xml\nCopyright 2018 skydoves\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","funding_links":["https://github.com/sponsors/skydoves","https://www.paypal.me/skydoves","https://www.buymeacoffee.com/skydoves"],"categories":["Kotlin"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskydoves%2FBaseRecyclerViewAdapter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskydoves%2FBaseRecyclerViewAdapter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskydoves%2FBaseRecyclerViewAdapter/lists"}