Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gturedi/statefullayout
Android layout to show template for loading, empty, error etc. states
https://github.com/gturedi/statefullayout
android android-layout android-library anroid-layout custom-view layout loader loading stateful
Last synced: 6 days ago
JSON representation
Android layout to show template for loading, empty, error etc. states
- Host: GitHub
- URL: https://github.com/gturedi/statefullayout
- Owner: gturedi
- License: apache-2.0
- Created: 2017-02-16T22:32:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-05T10:37:27.000Z (about 5 years ago)
- Last Synced: 2025-01-18T03:04:38.954Z (13 days ago)
- Topics: android, android-layout, android-library, anroid-layout, custom-view, layout, loader, loading, stateful
- Language: Java
- Size: 1010 KB
- Stars: 802
- Watchers: 18
- Forks: 70
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## StatefulLayout
[](https://android-arsenal.com/details/1/5325) [](https://android-arsenal.com/api?level=14) [](https://oss.sonatype.org/content/repositories/releases/com/github/gturedi/stateful-layout/) [](https://travis-ci.org/gturedi/StatefulLayout) [](http://www.apache.org/licenses/LICENSE-2.0.html)
Android layout to show most common state templates like loading, empty, error etc. To do that all you need to is wrap
the target area(view) with StatefulLayout.
## Usage
You can download it from jitpack.io
```groovy
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
dependencies {
compile 'com.github.gturedi:StatefulLayout:1.2.2'
}
```
Alternatively you can use Sonatype Repository, add dependecy to app/build.gradle
```groovy
dependencies {
compile 'com.github.gturedi:stateful-layout:1.2.1'
}
```
Snapshots of the development version are available in [Sonatype's `snapshots` repository](https://oss.sonatype.org/content/repositories/snapshots/com/github/gturedi)
```
Then wrap a view which target area(view) to show states with StatefulLayout
```xml
...
```
Finally in your activity/fragment get StatefulLayout reference and call showXXX methods
```java
StatefulLayout stateful = (StatefulLayout) findViewById(R.id.stateful);
stateful.showLoading();
//stateful.showEmpty(getString(R.string.testMessage));
//stateful.showError(getString(R.string.testMessage), clickListener);
//etc.
```
## API
State methods have overloads for customization. If you pass clickListener parameter as null, relevant state button
will be hided. More customization please look [CustomStateOptions.java](library/src/main/java/com/gturedi/views/CustomStateOptions.java)
- setAnimationEnabled(boolean animationEnabled)
- setInAnimation(@AnimRes int inAnimation)
- setOutAnimation(@AnimRes int outAnimation)
- showContent()
- showLoading(String message)
- showEmpty(String message)
- showError(String message, OnClickListener clickListener)
- showOffline(String message, OnClickListener clickListener)
- showLocationOff(String message, OnClickListener clickListener)
- showCustom(CustomStateOptions options)
## Xml Attributes
| Name | Type | Default | Description |
|:----:|:----:|:-------:|:-----------:|
| stfAnimationEnabled | boolean | true | Indicates whether to place the animation on state changes |
| stfInAnimation | anim | @android:anim/fade_in | Animation started begin of state change |
| stfOutAnimation | anim | @android:anim/fade_out | Animation started end of state change |
## Customization
Just override relevant resource in your app to customize state views appearance
- To Override **strings** [strings.xml variables](library/src/main/res/values/strings.xml)
- To Override **styles** [styles.xml](library/src/main/res/values/styles.xml)
- To Override **layout** [stf_template.xml](library/src/main/res/layout/stf_template.xml)
## License
Copyright 2017 Gökhan Türedi ([email protected])
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.