Optimize docs

Author: DylanCaiCoding

docs/README.md

@@ -2,6 +2,7 @@
 
 [![](https://www.jitpack.io/v/DylanCaiCoding/LoadingStateView.svg)](https://www.jitpack.io/#DylanCaiCoding/LoadingLoadingStateView) 
 [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/LICENSE)
+[![GitHub Repo stars](https://img.shields.io/github/stars/DylanCaiCoding/LoadingStateView?style=social)](https://github.com/DylanCaiCoding/LoadingStateView)
 
 `LoadingStateView` 是一个深度解耦加载界面和标题栏的工具，只用了一个 Kotlin 文件实现，不算上注释少于 300 行代码。不仅能在请求网络数据时**显示加载中、加载成功、加载失败、无数据的视图或自定义视图**，还可以**对标题栏进行管理**。
 
@@ -21,18 +22,17 @@
 
 动态添加加载状态的布局：
 
-| [Activity(error)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/ActErrorActivity.java) | [View(placeholder)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/ViewPlaceholderActivity.java) | [ViewPager(timeout)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/ViewPagerActivity.java) | [RecyclerView(cool loading)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/RecyclerViewActivity.java) |
+| [Activity(error)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/ActErrorActivity.java) | [View(placeholder)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/ViewPlaceholderActivity.java) | [ViewPager(timeout)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/ViewPagerActivity.java) | [RecyclerView(cool loading)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/RecyclerViewActivity.java) |
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
 |                 ![](gif/activity_error.gif)                  |                ![](gif/view_placeholder.gif)                 |                ![](gif/viewpager_timeout.gif)                |              ![](gif/recyclerview_loading.gif)               |
 
 动态添加标题栏或装饰容器：
 
-| [SpecialHeader(custom)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/CustomHeaderActivity.java) | [MultipleHeader(search)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/MultipleHeaderActivity.java) | [SpecialDecorView(scrolling)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/ScrollingToolbarActivity.java) | [BottomDecorView(editor)](app/src/main/java/com/dylanc/loadingstateview/sample/ui/BottomEditorActivity.java) |
+| [SpecialHeader(custom)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/CustomHeaderActivity.java) | [MultipleHeader(search)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/MultipleHeaderActivity.java) | [SpecialDecorView(scrolling)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/ScrollingToolbarActivity.java) | [BottomDecorView(editor)](https://github.com/DylanCaiCoding/LoadingStateView/blob/master/sample-java/src/main/java/com/dylanc/loadingstateview/sample/java/ui/BottomEditorActivity.java) |
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
 |              ![](gif/special_header_custom.gif)              |             ![](gif/multiple_header_search.gif)              |             ![](gif/special_decor_scrolling.gif)             |               ![](gif/bottom_decor_editor.gif)               |
 
-
-## 开始使用
+## Gradle
 
 在根目录的 `build.gradle` 添加:
 
@@ -49,152 +49,14 @@ allprojects {
 
 ```groovy
 dependencies {
-  implementation 'com.github.DylanCaiCoding:LoadingStateView:3.0.1'
-}
-```
-
-### 基础用法
-
-第一步，创建一个类继承  `LoadingStateView.ViewDelegate<VH extends ViewHolder>`，写法与 `RecyclerView.Adapter` 类似。如果需要实现点击重新请求数据，可以在点击事件调用 holder.getOnReloadListener.onReload() 方法。
-
-```java
-public class LoadingViewDelegate extends LoadingStateView.ViewDelegate<LoadingStateView.ViewHolder> {
-
-  @NonNull
-  @Override
-  public LoadingStateView.ViewHolder onCreateViewHolder(@NonNull LayoutInflater inflater, @NonNull ViewGroup parent) {
-    return new LoadingStateView.ViewHolder(inflater.inflate(R.layout.layout_loading_view, parent, false));
-  }
-
-  @Override
-  public void onBindViewHolder(@NonNull LoadingStateView.ViewHolder holder) {
-  }
-}
-```
-
-第二步，注册 `ViewDelegate`，关联一个视图类型。有五个默认类型，也可以传任意类型数据进行注册。
-
-```java
-LoadingStateView loadingStateView = new LoadingStateView(this); // 可传 Activity 或 View
-loadingStateView.register(ViewType.LOADING, new LoadingViewDelegate());
-// 当需要支持点击重新请求数据时
-loadingStateView.setOnReloadListener(() -> {})
-```
-
-如果需要注册成全局的 `ViewDelegate`。
-
-```java
-loadingStateView.setViewDelegatePool(pool -> {
-  pool.register(ViewType.LOADING, new LoadingViewDelegate());
-  return null;
-});
-```
-
-第三步，显示对应类型的视图。
-
-```java
-loadingStateView.showView(viewType);
-loadingStateView.showLoadingView(); // 对应视图类型 ViewType.LOADING
-loadingStateView.showContentView(); // 对应视图类型 ViewType.CONTENT
-loadingStateView.showErrorView(); // 对应视图类型 ViewType.ERROR
-loadingStateView.showEmptyView(); // 对应视图类型 ViewType.EMPTY
-```
-
-**动态更新已显示视图**
-
-在显示了视图之后，可以对视图进行更改刷新。和 `RecyclerView.Adapter` 类似，会执行适配器的 `onBindViewHolder()` 方法。
-
-```java
-loadingStateView.updateView(ViewType.ERROR, (ErrorViewDelegate delegate) -> {
-   delegate.msg = "服务器繁忙，请稍后重试";
-});
-```
-
-### 高级用法
-
-#### 添加标题栏
-
-如果是**普通的标题栏**，就是简单地在内容的上方添加标题栏：
-
-和前面的用法类似，先创建一个继承  `LoadingStateView.ViewDelegate<VH extends ViewHolder>` 的标题栏适配器，然后就能在内容的上方添加标题栏了，可以添加多个头部。
-
-```java
-loadingStateView.setDecorHeader(new TitleViewDelegate("标题名"), new SearchHeaderViewDelegate());
-```
-
-如果是**特殊的标题栏**，比如有联动效果，就不能直接使用上面的方式了。这时我们要给内容增加个装饰的容器。
-
-先实现一个不含内容的布局。
-
-```xml
-<?xml version="1.0" encoding="utf-8"?>
-<androidx.coordinatorlayout.widget.CoordinatorLayout xmlns:android="http://schemas.android.com/apk/res/android"
-  xmlns:app="http://schemas.android.com/apk/res-auto"
-  android:layout_width="match_parent"
-  android:layout_height="match_parent"
-  android:fitsSystemWindows="true">
-
-  <com.google.android.material.appbar.AppBarLayout
-    android:id="@+id/app_bar"
-    android:layout_width="match_parent"
-    android:layout_height="@dimen/app_bar_height"
-    android:fitsSystemWindows="true"
-    android:theme="@style/AppTheme.AppBarOverlay">
-
-    <com.google.android.material.appbar.CollapsingToolbarLayout
-      android:id="@+id/toolbar_layout"
-      android:layout_width="match_parent"
-      android:layout_height="match_parent"
-      android:fitsSystemWindows="true"
-      app:contentScrim="?attr/colorPrimary"
-      app:layout_scrollFlags="scroll|exitUntilCollapsed"
-      app:toolbarId="@+id/toolbar">
-
-      <androidx.appcompat.widget.Toolbar
-        android:id="@+id/toolbar"
-        android:layout_width="match_parent"
-        android:layout_height="?attr/actionBarSize"
-        app:layout_collapseMode="pin"
-        app:popupTheme="@style/AppTheme.PopupOverlay" />
-    </com.google.android.material.appbar.CollapsingToolbarLayout>
-  </com.google.android.material.appbar.AppBarLayout>
-
-  <FrameLayout
-    android:id="@+id/content_parent"
-    android:layout_width="match_parent"
-    android:layout_height="match_parent"
-    app:layout_behavior="@string/appbar_scrolling_view_behavior" />
-</androidx.coordinatorlayout.widget.CoordinatorLayout>
-```
-
-创建一个类继承 `LoadingStateView.DecorViewDelegate` ，加载实现的布局，并指定一个添加内容的容器。
-
-```java
-class ScrollingDecorViewDelegate : LoadingStateView.DecorViewDelegate() {
-  @NotNull
-  override fun onCreateDecorView(@NotNull inflater: LayoutInflater): View {
-    return inflater.inflate(R.layout.layout_scrolling, null)
-  }
-
-  @NotNull
-  fun getContentParent(@NotNull decorView: View): ViewGroup {
-    return decorView.findViewById(R.id.content_parent)
-  }
+    // java
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview:4.0.0'
+    
+    // kotlin
+    implementation 'com.github.DylanCaiCoding.LoadingStateView:loadingstateview-ktx:4.0.0'
 }
 ```
 
-最后设置一下就可以了。
-
-```java
-loadingStateView.setDecorView(new ScrollingDecorViewDelegate());
-```
-
-上述的两种使用方式都是可以进行多次设置，不过每次设置会把上一次设置的样式给替换掉。
-
-## LoadingHelper 迁移指南
-
-本库原名是 `LoadingHelper`，后面对部分类名和方法名进行修改。老用户可以查看[迁移指南](https://github.com/DylanCaiCoding/LoadingHelper/blob/main/README_CN.md)改为最新的用法，如果觉得麻烦并且不是强迫症患者，也可以不迁移。
-
 ## 作者其它的库
 
 | 库                                                           | 简介                                           |

docs/_sidebar.md

@@ -2,4 +2,5 @@
 * [基础用法](/zh/basic-usage)
 * [Kotlin 委托用法](/zh/delegate)
 * [结合 ViewBinding 使用](/zh/viewbinding)
+* [老版本迁移指南](/zh/migration-guide)
 * [Q&A](/zh/q&a)

docs/img/base_activity_code.png

@@ -1,6 +1,6 @@
 # 基础用法
 
-使用 Kotlin 开发的话推荐用委托的用法，不过建议先把基础的 `LoadingStateView` 用法看了。
+使用 Kotlin 开发推荐用[委托用法](/zh/delegate)。
 
 ## 显示加载中、加载失败等缺省页
 
@@ -128,9 +128,7 @@ loadingStateView.showEmptyView(); // 对应视图类型 ViewType.EMPTY
 
 ## 更新视图样式
 
-需要在 `ViewDelegate` 自行增加更新的方法，然后获取到对应的 `ViewDelegate` 进行更新。
-
-比如在 `ErrorViewDelegate` 增加了 `updateMsg(msg)` 方法修改请求失败的文字：
+需要在 `ViewDelegate` 自行增加更新的方法，然后更新对应的 `ViewDelegate`。比如在 `ErrorViewDelegate` 增加了 `updateMsg(msg)` 方法修改请求失败的文字：
 
 <!-- tabs:start -->
 
@@ -171,11 +169,11 @@ loadingStateView.setHeaders(new ToolbarViewDelegate("消息"), new SearchViewDel
 
 <!-- tabs:end -->
 
-## 给内容的外层增加装饰布局
+## 给内容增加装饰
 
-可以给内容布局添加一层装饰，实现更复杂的样式，非简单地在头部增加控件，比如带联动效果的标题栏、DrawerLayout、底部输入框等布局。
+可以给内容布局外层添加一层装饰，实现更复杂的样式，非简单地在内容上方增加控件，比如带联动效果的标题栏、DrawerLayout、底部输入框等布局。
 
-我们来实现滑动隐藏标题栏的效果，写一个带联动效果的标题栏布局，其中有个 FragmentLayout 是用于填充内容和切换缺省页。
+接下来以滑动隐藏标题栏的效果为例，先写一个带联动效果的标题栏布局，其中有个 FragmentLayout 是用于填充内容和显示缺省页。
 
 ```xml
 <?xml version="1.0" encoding="utf-8"?>
@@ -218,15 +216,16 @@ loadingStateView.setHeaders(new ToolbarViewDelegate("消息"), new SearchViewDel
 #### **Kotlin**
 
 ```kotlin
-class ScrollingDecorViewDelegate(private val title: String) : LoadingStateView.DecorViewDelegate() {
+class ScrollingDecorViewDelegate(
+  private val activity: Activity,
+  private val title: String
+) : LoadingStateView.DecorViewDelegate() {
 
   override fun onCreateDecorView(context: Context, inflater: LayoutInflater): View {
     val view = inflater.inflate(R.layout.layout_scrolling_toolbar, null)
     val toolbar: Toolbar = view.findViewById(R.id.toolbar)
     toolbar.title = title
-    toolbar.setNavigationOnClickListener {
-      if (context is Activity) context.finish()
-    }
+    toolbar.setNavigationOnClickListener { activity.finish() }
     return view
   }
 
@@ -240,17 +239,18 @@ class ScrollingDecorViewDelegate(private val title: String) : LoadingStateView.D
 
 ```java
 public class ScrollingDecorViewDelegate extends LoadingStateView.DecorViewDelegate {
+  private final Activity activity;
   private final String title;
 
-  public ScrollingDecorViewDelegate(String title) {
+  public ScrollingDecorViewDelegate(Activity activity, String title) {
+    this.activity = activity;
     this.title = title;
   }
 
   @NotNull
   @Override
   public View onCreateDecorView(@NonNull Context context, @NotNull LayoutInflater inflater) {
     View view = inflater.inflate(R.layout.layout_scrolling_toolbar, null);
-    Activity activity = (Activity) inflater.getContext();
     Toolbar toolbar = view.findViewById(R.id.toolbar);
     toolbar.setTitle(title);
     toolbar.setNavigationOnClickListener(v -> activity.finish());
@@ -277,13 +277,13 @@ public class ScrollingDecorViewDelegate extends LoadingStateView.DecorViewDelega
 #### **Kotlin**
 
 ```kotlin
-loadingStateView.setDecorView(ScrollingDecorViewDelegate("Test"))
+loadingStateView.setDecorView(ScrollingDecorViewDelegate(this, "title"))
 ```
 
 #### **Java**
 
 ```java
-loadingStateView.setDecorView(new ScrollingDecorViewDelegate("Test"));
+loadingStateView.setDecorView(new ScrollingDecorViewDelegate(this, "title"));
 ```
 
 <!-- tabs:end -->