https://github.com/thibseisel/recyclerfragment
An Android Fragment that displays a set of items in a RecyclerView.
https://github.com/thibseisel/recyclerfragment
android-library android-ui jcenter recyclerview
Last synced: 8 months ago
JSON representation
An Android Fragment that displays a set of items in a RecyclerView.
- Host: GitHub
- URL: https://github.com/thibseisel/recyclerfragment
- Owner: thibseisel
- License: mit
- Created: 2017-04-30T17:50:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T08:01:46.000Z (about 8 years ago)
- Last Synced: 2025-04-20T20:16:27.517Z (about 1 year ago)
- Topics: android-library, android-ui, jcenter, recyclerview
- Language: Java
- Size: 322 KB
- Stars: 14
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[  ](https://bintray.com/nihilus/android/recyclerfragment/_latestVersion)
RecyclerFragment is a small Android library that allow you to
display `RecyclerView` data in a `Fragment`. Easy to use, it is similar to
the framework's `ListFragment` with additional features.
# Download #
The library is available through jCenter.
You just have to include the dependency in your build.gradle file :
```gradle
dependencies {
compile 'fr.nihilus:recyclerfragment:x.y.z'
}
```
# Features #
- Fragment with a `RecyclerView` and a hideable `ProgressBar` out of the box
- Ability to show the `ProgressBar` when waiting for asynchronous data
- Customizable layout
- Support for an "empty view" to be displayed automatically in place
of RecyclerView when the adapter contains no data.
# How to use #
The preferred way to use RecyclerFragment is to extend it to add
your behavior in `onActivityCreated(Bundle)`.
The following example show you how to use RecyclerFragment when loading
data asynchronously :
```java
public class MyFragment extends RecyclerFragment {
private MyAdapter mAdapter;
@Override
public void onActivityCreated(@Nullable Bundle savedInstanceState) {
super.onActivityCreated(savedInstanceState);
mAdapter = new MyAdapter();
// You have to set your adapter with the following method
setAdapter(adapter);
// Like ListFragment, the RecyclerView is hidden by default.
// Setting the adapter with setAdapter(adapter) will display it.
// Since we load data asynchronously, we want to show
// the progress indicator while loading.
setRecyclerShown(false);
// Load some data asynchronously
new AsyncTask() {
@Override
protected String[] doInBackground(Void... params) {
return dataLoadedFromNetwork();
}
@Override
protected void onPostExecute(String[] result) {
// Update data in our adapter
mAdapter.setData(result);
mAdapter.notifyDataSetChanged();
// Stop showing the progress indicator
setRecyclerShown(true);
}
}.execute();
}
}
```
Note that the progress indicator won't we shown if your data is loaded
in less than 500 ms. This is an expected behavior: similarly to
`ContentLoadingProgressBar`, the progress indicator is only shown if it
will be displayed a sufficient amount of time to avoid UI "flashes".
# Using a custom layout #
You may need to customize the layout of RecyclerFragment.
All you have to do is to override `onCreateView` and inflate
your custom view hierarchy. Howether, your layout has to meet
the following criterias:
- It must contain a `RecyclerView` with id `@id/recycler`
- It must contain any `View` with id `@id/progress` to be displayed
when the `RecyclerView` is hidden by `setRecyclerShown(false)`.
You may optionally specify a `View` to be automatically displayed
in place of the `RecyclerView` when the adapter is empty:
just mark it with the id `@id/empty`.
The following is an example of custom layout for RecyclerFragment:
### fragment_custom.xml ###
```xml
```
### MyFragment.java ###
```java
public class MyFragment extends RecyclerFragment {
@NonNull
@Override
public View onCreateView(LayoutInflater inflater, @Nullable ViewGroup container,
@Nullable Bundle savedInstanceState) {
return inflater.inflate(R.layout.fragment_custom, container, false);
}
}
```
Don't forget to set your LayoutManager in XML or via
`setLayoutManager(RecyclerView.LayoutManager)`,
as only the default implementation uses a `LinearLayoutManager` when
no other is provided.
# License #
MIT