HeaderRecyclerView is an Android library created to be able to use RecyclerView.Adapter
with a header in a easy way. To use this library create your RecyclerView.Adapter
classes extending from HeaderRecyclerViewAdapter
.
To use HeaderRecyclerView
in your application you have to follow this steps:
- 1 - Create a class extending from
HeaderRecyclerViewAdapter
:
public class DragonBallAdapter extends HeaderRecyclerViewAdapter<RecyclerView.ViewHolder, DragonBallHeader, DragonBallCharacter> {
- 2 - Implement
onCreateHeaderViewHolder
,onCreateItemViewHolder
,onBindItemViewHolder
andonBindViewHolder
to create yourRecyclerView.ViewHolder
instances and draw your rows:
@Override
protected RecyclerView.ViewHolder onCreateHeaderViewHolder(ViewGroup parent, int viewType) {
LayoutInflater inflater = getLayoutInflater(parent);
View headerView = inflater.inflate(R.layout.row_dragon_ball_header, parent, false);
return new HeaderViewHolder(headerView);
}
@Override
protected RecyclerView.ViewHolder onCreateItemViewHolder(ViewGroup parent, int viewType) {
LayoutInflater inflater = getLayoutInflater(parent);
View characterView = inflater.inflate(R.layout.row_dragon_ball_character, parent, false);
return new CharacterViewHolder(characterView);
}
@Override protected void onBindHeaderViewHolder(RecyclerView.ViewHolder holder, int position) {
DragonBallHeader header = getHeader();
HeaderViewHolder headerViewHolder = (HeaderViewHolder) holder;
headerViewHolder.render(header);
}
@Override protected void onBindItemViewHolder(RecyclerView.ViewHolder holder, int position) {
DragonBallCharacter character = getItem(position);
CharacterViewHolder characterViewHolder = (CharacterViewHolder) holder;
characterViewHolder.render(character);
}
- 3 - Configure your
RecyclerView
widget with this layout:
List<DragonBallCharacter> characters = getDragonBallCharacters();
DragonBallHeader header = getHeader(characters);
adapter.setHeader(header);
adapter.setItems(characters);
recyclerView.setAdapter(adapter);
You can use methods like isHeaderType(viewType)
or isHeaderPosition(position)
to return the ViewHolder associated to the header or to draw the view associated to the header. The header instance can be obtained using the method getHeader()
.
- 4 - If you are using a
GridLayoutManager
instead of aLinearLayoutManager
remember you'll have to configure theSpanSizeLookup
used in theLayoutManager
instance. If you are usingHeaderRecyclerView
with aGridLayoutManager
you can create an instance ofHeaderSpanSizeLookup
and configure yourLayoutManager
instance:
GridLayoutManager layoutManager = new GridLayoutManager(this, NUMBER_OF_COLUMNS);
HeaderSpanSizeLookup headerSpanSizeLookup = new HeaderSpanSizeLookup(adapter, layoutManager);
layoutManager.setSpanSizeLookup(headerSpanSizeLookup);
Add HeaderRecyclerView
dependency to your build.gradle
file
dependencies{
compile 'com.karumi:headerrecyclerview:1.0.0'
}
or to your pom.xml
if you are using Maven instead of Gradle
<dependency>
<groupId>com.karumi</groupId>
<artifactId>headerrecyclerview</artifactId>
<version>1.0.0</version>
<type>aar</type>
</dependency>
Please, do it! We'd like to improve this library with your help :)
- FUNimation Productions, Ltd. ©
Copyright 2015 Karumi
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.