# MultiStatePage
**Repository Path**: oudengding/MultiStatePage
## Basic Information
- **Project Name**: MultiStatePage
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-07
- **Last Updated**: 2021-12-07
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# MultiStatePage
[](https://jitpack.io/#Zhao-Yan-Yan/MultiStatePage) [](https://github.com/Zhao-Yan-Yan/MultiStatePage/blob/master/LICENSE) 
| [Activity](app/src/main/java/com/zy/multistatepage/MultiStateActivity.kt) | [Fragment](app/src/main/java/com/zy/multistatepage/MultiFragmentActivity.kt) | [View](app/src/main/java/com/zy/multistatepage/MultiViewActivity.kt) | [ViewPager2](app/src/main/java/com/zy/multistatepage/ViewPager2Activity.kt) |
| :-----: | :----: | :----: | :----: |
|  |  |  |  |
| [Lottie拓展（自定义State）](app/src/main/java/com/zy/multistatepage/LottieExtActivity.kt) | [State刷新](app/src/main/java/com/zy/multistatepage/RefreshStateActivity.kt) | [网络请求](app/src/main/java/com/zy/multistatepage/MockNetActivity.kt) | [sample](app/src/main/java/com/zy/multistatepage/ApiActivity.kt) |
| :-----: | :----: | :----: | :-----: |
|  |  |  |  |
## MultiStatePage的功能及特点
- 无需在布局添加视图代码
- 可显示自定义状态视图,任意拓展
- 可用于 Activity、Fragment、或指定的 View
- 自定义重新请求监听
- 支持xml直接嵌套且不限制要展示状态内容
- 可动态更新视图样式
- 可结合第三方控件使用
- 支持状态回调监听
- kotlin开发更易用的API
## 开始
### 添加依赖
Step1. Add the JitPack repository to your build file
```
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
Step2. Add the dependency [](https://jitpack.io/#Zhao-Yan-Yan/MultiStatePage)
```
dependencies {
implementation 'com.github.Zhao-Yan-Yan:MultiStatePage:2.0.2'
}
```
### 1.生成MultiStateContainer
#### 在View上使用
```kotlin
val multiStateContainer = MultiStatePage.bindMultiState(view)
// 或
val multiStateContainer = view.bindMultiState()
```
#### 在Activity根View中使用
```kotlin
val multiStateContainer = MultiStatePage.bindMultiState(this)
// 或
val multiStateContainer = bindMultiState()
```
#### 在Fragment根View中使用
```kotlin
class MultiStateFragment : Fragment {
private lateinit var multiStateContainer: MultiStateContainer
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
val root = inflater.inflate(R.layout.fragment, container, false)
multiStateContainer = MultiStatePage.bindMultiState(root)
// 或
multiStateContainer = root.bindMultiState()
return multiStateContainer
}
}
```
#### xml中引用
```xml
```
### 2.切换状态
```kotlin
multiStateContainer.show()
// 或
multiStateContainer.show(CustomState())
```
#### 更新state信息
```kotlin
multiStateContainer.show{ errorState ->
errorState.setErrorMsg("xxx出错了")
}
```
### 如何添加重试事件（建议自定义State实现）参考 ErrorState
```kotlin
class ErrorState : MultiState() {
private lateinit var tvRetry: TextView
private var retry: OnRetryClickListener? = null
override fun onCreateMultiStateView(context: Context, inflater: LayoutInflater, container: MultiStateContainer
): View {
return inflater.inflate(R.layout.mult_state_error, container, false)
}
override fun onMultiStateViewCreate(view: View) {
tvRetry = view.findViewById(R.id.tv_retry)
tvRetry.setOnClickListener { retry?.retry() }
}
fun retry(retry: OnRetryClickListener) {
this.retry = retry
}
fun interface OnRetryClickListener {
fun retry()
}
}
```
```kotlin
multiStateContainer.show { state->
state.retry { do() }
}
// 或
val state = ErrorState().apply{
retry { do() }
}
multiStateContainer.show(state)
```
### 如何设置默认State
利用kotlin拓展函数可以很轻松的实现
```kotlin
val multiStateActivityRoot = bindMultiState().apply { showEmpty() }
```
### 自定义State
#### 继承`MultiState`
```kotlin
class LottieWaitingState : MultiState() {
override fun onCreateMultiStateView(context: Context, inflater: LayoutInflater, container: MultiStateContainer): View {
// your state view
return inflater.inflate(R.layout.multi_lottie_waiting, container, false)
}
override fun onMultiStateViewCreate(view: View) {
//逻辑处理
}
}
```
结合`ViewBidng` 参考 `demo` [MultiStateBinding](app/src/main/java/com/zy/multistatepage/base/MultiStateBinding.kt) 和 [WithBindingState](app/src/main/java/com/zy/multistatepage/state/WithBindingState.kt)
### 使用内置状态配置
**默认内置3种状态（强烈建议您自定义State）**
```kotlin
val multiStateContainer = MultiStatePage.bindMultiState(view)
//成功页
multiStateContainer.show()
//错误页
multiStateContainer.show()
//空页面
multiStateContainer.show()
//加载状态页
multiStateContainer.show()
```
**更换默认资源**
```kotlin
class App : Application() {
override fun onCreate() {
super.onCreate()
val config = MultiStateConfig.Builder()
.alphaDuration(300)
.errorIcon(R.mipmap.state_error)
.emptyIcon(R.mipmap.state_empty)
.emptyMsg("emptyMsg")
.loadingMsg("loadingMsg")
.errorMsg("errorMsg")
.build()
MultiStatePage.config(config)
}
}
```
| method | 作用 |
| :-----: | :----: |
| `alphaDuration` | alpha动画时长 |
| `errorIcon` | 错误状态默认图标 |
| `emptyIcon` | 空数据状态默认图标 |
| `emptyMsg` | 空数据状态默认提示信息 |
| `errorMsg` | 错误状态默认提示信息 |
| `loadingMsg` | loading状态默认提示信息 |
### 小技巧
可以借助kotlin的拓展函数封装常用的状态
```kotlin
fun MultiStateContainer.showSuccess(callBack: (SuccessState) -> Unit = {}) {
show { callBack.invoke(it) }
}
fun MultiStateContainer.showError(callBack: (ErrorState) -> Unit = {}) {
show { callBack.invoke(it) }
}
fun MultiStateContainer.showEmpty(callBack: (EmptyState) -> Unit = {}) {
show { callBack.invoke(it) }
}
fun MultiStateContainer.showLoading(callBack: (LoadingState) -> Unit = {}) {
show { callBack.invoke(it) }
}
```
```kotlin
val multiStateContainer = bindMultiState()
multiStateContainer.showLoading()
multiStateContainer.showSuccess()
```
## 下载Demo
点击或者扫描二维码下载
[](https://www.pgyer.com/PVAi)
## 更新日志
- 2.0.2(2021/07/05) 移除默认的retryListener
- 2.0.1(2021/03/06) fix 重复状态切换判断异常
- 2.0.0(2021/03/06) 支持xml中引用MultiStatePage, 代码优化
- 1.1.1(2021/01/12) 优化`enableReload`处理
- 1.1.0(2021/01/04) 新增`show(multiState: MultiState)`
- 1.0.9(2020/12/24) demo 包名调整 `enableReload`不强制实现,默认`false`
- 1.0.8(2020/12/09) 修复`LinearLayout`权重异常
- 1.0.7(2020/11/26) 小优化 移除部分`log`打印
- 1.0.6(2020/11/06) 优化`state`切换策略 保留原`view`
- 1.0.5(2020/11/04) `kotlin`函数类型参数更换为`java interface`对`java`的调用更友好
- 1.0.4(2020/11/04) api重命名 `Activity`和`View`统一为`bindMultiState()`
- 1.0.3(2020/10/26) 修复`state`内存泄漏, 移除`register`函数
- 1.0.2(2020/10/23) 支持指定重试`view`, 支持`ViewBinding`
- 1.0.1(2020/09/22) 支持内置状态页信息配置, 支持`alpha`动画时长配置
## Thanks
- [DylanCaiCoding/LoadingHelper](https://github.com/DylanCaiCoding/LoadingHelper/)
- [KingJA/LoadSir](https://github.com/KingJA/LoadSir)
- [airbnb/lottie-android](https://github.com/airbnb/lottie-android)
- [lottie动画资源社区](https://lottiefiles.com/featured)
- [玩Android](https://www.wanandroid.com/)
## License
```
Copyright (C) 2020. ZhaoYan
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.
```