# stateful.layout

**Repository Path**: milkcoder/stateful.layout

## Basic Information

- **Project Name**: stateful.layout
- **Description**: 方便Android开发者根据不同的状态切换布局的自定义布局，基于FrameLayout，可同时存在多个同状态的子布局，可方便的自定义默认状态的而已，可自定义切换动画。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-28
- **Last Updated**: 2021-11-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# StatefulLayout
方便Android开发者根据不同的状态切换布局的自定义布局，基于FrameLayout，可同时存在多个同状态的子布局，可方便的自定义默认状态的而已，可自定义切换动画。

# 当前最新版本号：[![](https://jitpack.io/v/com.gitee.numeron/stateful.svg)](https://jitpack.io/#com.gitee.numeron/stateful)

### StatefulLayout
* 通过设置`state`的值切换不同的布局，共有4种状态：Empty, Loading, Failure, Success：
```kotlin
try {
    statefulLayout.state = State.Loading
    val list = getDateList()
    adapter.submitList(list)
    statefulLayout.state = if(list.isEmpty) State.Empty else State.Success
} catch (throwable: Throwable) {
    statefulLayout.state = State.Failure
}
```
* 设置页面中不同状态下的布局：

```xml
<!--引用failure状态下的视图，需要在该视图的根布局中添加app:layout_state="failure"属性-->
<!--同理，也可以引用empty、loading状态的布局，注意添加app:layout_state属性并指定对应的值-->
<StatefulLayout
    android:id="@+id/statefulLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:stateful_failure_layout="@layout/state_failure_layout">
    <!--注意上方的stateful_failure_layout属性，它引用了另外一个布局作为自己的failure状态下的视图-->

    <!--没有指定state，则默认是success状态-->
    <RecyclerView
        android:layout_width="match_parent"
        android:layout_height="match_parent" />
    
    <!--设置empty状态下的视图-->
    <ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent" 
        app:layout_state="empty" />
    
    <!--设置loading状态下的视图-->
    <!--可单独设置某个视图显示或隐藏的动画-->
    <ConstraintLayout
        android:layout_width="match_parent"
        android:layout_height="match_parent" 
        app:stateful_animation_show="@anim/stateful_loading_show"
        app:stateful_animation_hide="@anim/stateful_loading_hide"
        app:layout_state="loading" />

</StatefulLayout>
```
*  如果想统一修改除success以外所有状态的默认视图，可在当前正在应用的主题资源中添加以下属性并指定新的`Style`:
```xml
<style name="...">
    ...
    <!--为statefulLayoutStyle属性设置新的样式-->
    <item name="statefulLayoutStyle">@style/ExampleStatefulLayoutStyle</item>
</style>

<!--添加新的样式，继承自默认的样式-->
<style name="ExampleStatefulLayoutStyle" parent="StatefulLayoutStyle">
    <!--修改默认视图-->
    <item name="stateful_empty_layout">@layout/empty_layout</item>
    <item name="stateful_loading_layout">@layout/loading_layout</item>
    <item name="stateful_failure_layout">@layout/failure_layout</item>
    <!--修改默认动画效果-->
    <item="stateful_animation_show">@layout/state_show_anim</item>
    <item="stateful_animation_hide">@layout/state_hide_anim</item>
</style>
```

### 引入
1.  在你的android工程的根目录下的build.gradle文件中的适当的位置添加以下代码：
```groovy
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
```
2. 在你的android工程中对应的android模块的build.gradle文件中的适当位置添加以下代码：
```groovy
implementation 'cn.numeron:stateful.layout:latest_version'
```