Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lopspower/hfrecyclerview
Add Header and/or Footer in your RecyclerView in the simplest way possible.
https://github.com/lopspower/hfrecyclerview
java kotlin recyclerview recyclerviewadapter
Last synced: about 13 hours ago
JSON representation
Add Header and/or Footer in your RecyclerView in the simplest way possible.
- Host: GitHub
- URL: https://github.com/lopspower/hfrecyclerview
- Owner: lopspower
- License: apache-2.0
- Created: 2016-02-17T16:54:18.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T16:07:12.000Z (over 3 years ago)
- Last Synced: 2025-01-16T15:07:43.994Z (8 days ago)
- Topics: java, kotlin, recyclerview, recyclerviewadapter
- Language: Kotlin
- Homepage:
- Size: 2.36 MB
- Stars: 169
- Watchers: 9
- Forks: 40
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
HFRecyclerView
=================
[](http://developer.android.com/index.html)
[](https://search.maven.org/artifact/com.mikhaellopez/hfrecyclerview)
[](https://android-arsenal.com/api?level=14)
[](http://twitter.com/lopezmikhael)
This is an Android library allowing to add **Header** and/or **Footer** in your RecyclerView in the simplest way possible.
USAGE
-----
To add Header and/or Footer in your RecyclerView you need to add **HFRecyclerView** library in your project or you can also grab it from Gradle:
```groovy
implementation 'com.mikhaellopez:hfrecyclerview:1.2.0'
```
KOTLIN
-----
1. You need to create a custom `RecyclerView.Adapter` for your RecyclerView which `HFRecyclerView` with the object type of your choice (in my example, my object type is `MyDataObject`). The first param in `HFRecyclerView` constructor is a flag to determine if you want to add a header, and the last to add a footer.
```kotlin
class ExampleAdapter : HFRecyclerView(true, true) {
//...
}
```
2. After that, override 3 methods and create 3 class which extend `RecyclerView.ViewHolder` in order to add the viewHolder for your Item, your Header and your Footer:
```kotlin
class ExampleAdapter : HFRecyclerView(true, true) {
//...
//region Override Get ViewHolder
override fun getItemView(inflater: LayoutInflater, parent: ViewGroup): RecyclerView.ViewHolder =
ViewHolder.ItemViewHolder(inflater.inflate(R.layout.item_example, parent, false))
override fun getHeaderView(inflater: LayoutInflater, parent: ViewGroup): RecyclerView.ViewHolder =
ViewHolder.HeaderViewHolder(inflater.inflate(R.layout.item_header, parent, false))
override fun getFooterView(inflater: LayoutInflater, parent: ViewGroup): RecyclerView.ViewHolder =
ViewHolder.FooterViewHolder(inflater.inflate(R.layout.item_footer, parent, false))
//endregion
//region ViewHolder Header and Footer
sealed class ViewHolder(view: View) : RecyclerView.ViewHolder(view) {
class ItemViewHolder(view: View) : ViewHolder(view) {
fun bind(item: String) {
itemView.run { text.text = item }
}
}
class HeaderViewHolder(view: View) : ViewHolder(view)
class FooterViewHolder(view: View) : ViewHolder(view)
}
//endregion
}
```
:information_source: If you doesn't have a footer (same for header) you need to override `getFooterView` like this:
```kotlin
override fun getFooterView(inflater: LayoutInflater, parent: ViewGroup): RecyclerView.ViewHolder? = null
```
3. You must override `onBindViewHolder` method to manage your views as you like:
```kotlin
class ExampleAdapter : HFRecyclerView(true, true) {
//...
override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
when (holder) {
is ViewHolder.ItemViewHolder -> holder.bind(getItem(position))
is ViewHolder.HeaderViewHolder -> { }
is ViewHolder.FooterViewHolder -> { }
}
}
//...
}
```
4. Finally, you can used your adapter and set yout data like this:
```kotlin
val adapter = ExampleAdapter()
adapter.data = youtDataList
recyclerview.adapter = adapter
```
:information_source: You can see a full example here : [**ExampleAdapter**](/hfrecyclerview-example/src/main/java/com/mikhaellopez/hfrecyclerviewexample/ExampleAdapter.kt) and [**MainActivity**](/hfrecyclerview-example/src/main/java/com/mikhaellopez/hfrecyclerviewexample/MainActivity.kt)
LICENCE
-----
HFRecyclerView by [Lopez Mikhael](http://mikhaellopez.com/) is licensed under a [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).