README.md
1
2Android SwipeRefreshListFragment Sample
3===================================
4
5A sample which shows how to use `SwipeRefreshLayout` to add
6'swipe-to-refresh' gesture to a ListView, enabling the ability to trigger a refresh
7from swiping down on that view.
8
9Introduction
10------------
11
12A sample which shows how to use
13[SwipeRefreshLayout][1] within a `ListFragment` to add the 'swipe-to-refresh'
14gesture to a `ListView`. The sample provides this functionality by defining a
15re-usable `SwipeRefreshListFragment` class.
16
17The sample displays a list of cheeses. When the user initiates a downward swipe,
18that list refreshes with randomly generated items. Selecting the `Refresh`
19action from the action bar also refreshes the list.
20
21[1]: https://developer.android.com/reference/android/support/v4/widget/SwipeRefreshLayout.html
22
23Pre-requisites
24--------------
25
26- Android SDK 27
27- Android Build Tools v27.0.2
28- Android Support Repository
29
30Screenshots
31-------------
32
33<img src="screenshots/refresh.png" height="400" alt="Screenshot"/>
34
35Getting Started
36---------------
37
38This sample uses the Gradle build system. To build this project, use the
39"gradlew build" command or use "Import Project" in Android Studio.
40
41Support
42-------
43
44- Google+ Community: https://plus.google.com/communities/105153134372062985968
45- Stack Overflow: http://stackoverflow.com/questions/tagged/android
46
47If you've found an error in this sample, please file an issue:
48https://github.com/googlesamples/android-SwipeRefreshListFragment
49
50Patches are encouraged, and may be submitted by forking this project and
51submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
52
53License
54-------
55
56Copyright 2017 The Android Open Source Project, Inc.
57
58Licensed to the Apache Software Foundation (ASF) under one or more contributor
59license agreements. See the NOTICE file distributed with this work for
60additional information regarding copyright ownership. The ASF licenses this
61file to you under the Apache License, Version 2.0 (the "License"); you may not
62use this file except in compliance with the License. You may obtain a copy of
63the License at
64
65http://www.apache.org/licenses/LICENSE-2.0
66
67Unless required by applicable law or agreed to in writing, software
68distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
69WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
70License for the specific language governing permissions and limitations under
71the License.
72
