Optimize docs

Author: DylanCaiCoding

docs/README.md

@@ -1,60 +1,61 @@
 # LoadingStateView
 
-English | [中文](README_ZH_CN.md)
+[![](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)
 
-[![](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)
+`LoadingStateView` 是一个深度解耦加载界面和标题栏的工具，只用了一个 Kotlin 文件实现，不算上注释少于 300 行代码。不仅能在请求网络数据时**显示加载中、加载成功、加载失败、无数据的视图或自定义视图**，还可以**对标题栏进行管理**。
 
-`LoadingStateView` is a highly expandable Android library for showing loading status view on the low-coupling way, it is implemented with a Kotlin code of less than 300 lines without comment statement . it not only **shows different view like loading, content, error, empty and customized view** when loading network data, but also **manages title bar.**
+- 无需在布局添加视图代码
+- 可显示自定义视图
+- 可用于 Activity、Fragment、列表或指定的 View
+- 可管理标题栏和添加多个头部控件
+- 可设置重新请求数据的事件
+- 可动态更新视图样式
+- 可结合绝大部分第三方控件使用
 
-## Feature
+## 示例
 
-- No need to add view code to the layout.
-- Support for show custom views.
-- Support for use for Activity, Fragment, RecyclerView, View.
-- Support for managing the title bar and add multiple headers.
-- Support for set reload event.
-- Support for update views anytime.
-- Support for use with most third-party libraries.
+点击或者扫描二维码下载
 
-## Demo
+[![QR code](https://github.com/DylanCaiCoding/LoadingStateView/img/app_download_qr_code.png)](https://www.pgyer.com/loadinghelper)
 
-Click or scan QR code to download
-
-[![QR code](img/app_download_qr_code.png)](https://www.pgyer.com/loadinghelper)
+动态添加加载状态的布局：
 
 | [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) |
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
 |                 ![](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) |
 | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
 |              ![](gif/special_header_custom.gif)              |             ![](gif/multiple_header_search.gif)              |             ![](gif/special_decor_scrolling.gif)             |               ![](gif/bottom_decor_editor.gif)               |
 
 
-## Getting started
+## 开始使用
 
-Add it in your root `build.gradle` at the end of repositories:
+在根目录的 `build.gradle` 添加:
 
 ```groovy
 allprojects {
     repositories {
-        ...
+        // ...
         maven { url 'https://www.jitpack.io' }
     }
 }
 ```
 
-Add dependencies in your module `build.gradle` :
+在模块的 `build.gradle` 添加依赖：
 
 ```groovy
 dependencies {
-  implementation 'com.github.DylanCaiCoding:LoadingStateView:3.0.0'
+  implementation 'com.github.DylanCaiCoding:LoadingStateView:3.0.1'
 }
 ```
 
-### Usage
+### 基础用法
 
-#### Step 1. Create a class extends `LoadingStateView.ViewDelegate<VH extends ViewHolder>`, for example:
+第一步，创建一个类继承  `LoadingStateView.ViewDelegate<VH extends ViewHolder>`，写法与 `RecyclerView.Adapter` 类似。如果需要实现点击重新请求数据，可以在点击事件调用 holder.getOnReloadListener.onReload() 方法。
 
 ```java
 public class LoadingViewDelegate extends LoadingStateView.ViewDelegate<LoadingStateView.ViewHolder> {
@@ -71,14 +72,16 @@ public class LoadingViewDelegate extends LoadingStateView.ViewDelegate<LoadingSt
 }
 ```
 
-#### Step 2. Register `ViewDelegate` with a view type, for example:
+第二步，注册 `ViewDelegate`，关联一个视图类型。有五个默认类型，也可以传任意类型数据进行注册。
 
 ```java
-LoadingStateView loadingStateView = new LoadingStateView(this);
+LoadingStateView loadingStateView = new LoadingStateView(this); // 可传 Activity 或 View
 loadingStateView.register(ViewType.LOADING, new LoadingViewDelegate());
+// 当需要支持点击重新请求数据时
+loadingStateView.setOnReloadListener(() -> {})
 ```
 
-##### Or if you want to register a global `ViewDelegate`.
+如果需要注册成全局的 `ViewDelegate`。
 
 ```java
 loadingStateView.setViewDelegatePool(pool -> {
@@ -87,53 +90,84 @@ loadingStateView.setViewDelegatePool(pool -> {
 });
 ```
 
-#### Step 3. Show view by view type, for example:
+第三步，显示对应类型的视图。
 
 ```java
 loadingStateView.showView(viewType);
-loadingStateView.showLoadingView(); // view type is ViewType.LOADING
-loadingStateView.showContentView(); // view type is ViewType.CONTENT
-loadingStateView.showErrorView(); // view type is ViewType.ERROR
-loadingStateView.showEmptyView(); // view type is ViewType.EMPTY
+loadingStateView.showLoadingView(); // 对应视图类型 ViewType.LOADING
+loadingStateView.showContentView(); // 对应视图类型 ViewType.CONTENT
+loadingStateView.showErrorView(); // 对应视图类型 ViewType.ERROR
+loadingStateView.showEmptyView(); // 对应视图类型 ViewType.EMPTY
 ```
 
-#### When you need to reload data.
+**动态更新已显示视图**
 
-```java
-loadingStateView.setOnReloadListener(new LoadingStateView.OnReloadListener() {
-  @Override
-  public void onReload() {
-    // request data again
-  }
-});
-
-//In the adapter
-holder.getOnReloadListener.onReload();
-```
-
-#### When you need to change view after view showed.
+在显示了视图之后，可以对视图进行更改刷新。和 `RecyclerView.Adapter` 类似，会执行适配器的 `onBindViewHolder()` 方法。
 
 ```java
-ErrorViewDelegate errorViewDelegate = loadingStateView.getViewDelegate(ViewType.ERROR);
-errorViewDelegate.errorText = "Fail to load, please wait";
-loadingStateView.notifyDataSetChanged(ViewType.ERROR);
+loadingStateView.updateView(ViewType.ERROR, (ErrorViewDelegate delegate) -> {
+   delegate.msg = "服务器繁忙，请稍后重试";
+});
 ```
 
-### Advanced usage
+### 高级用法
 
-#### Add title view
+#### 添加标题栏
 
-If you want to add an ordinary title bar above the content.
+如果是**普通的标题栏**，就是简单地在内容的上方添加标题栏：
 
-Similar to the previous usage, create a class extends `LoadingStateView.ViewDelegate<VH extends ViewHolder>`  and set header.
+和前面的用法类似，先创建一个继承  `LoadingStateView.ViewDelegate<VH extends ViewHolder>` 的标题栏适配器，然后就能在内容的上方添加标题栏了，可以添加多个头部。
 
 ```java
-loadingStateView.setDecorHeader(new TitleViewDelegate("title"), new SearchHeaderViewDelegate());
+loadingStateView.setDecorHeader(new TitleViewDelegate("标题名"), new SearchHeaderViewDelegate());
 ```
 
-If you want to add an special title bar with linkage effect.
+如果是**特殊的标题栏**，比如有联动效果，就不能直接使用上面的方式了。这时我们要给内容增加个装饰的容器。
+
+先实现一个不含内容的布局。
+
+```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>
+```
 
-Create a class extends `LoadingStateView.DecorViewDelegate` to create a decorated view and specify a loading container.
+创建一个类继承 `LoadingStateView.DecorViewDelegate` ，加载实现的布局，并指定一个添加内容的容器。
 
 ```java
 class ScrollingDecorViewDelegate : LoadingStateView.DecorViewDelegate() {
@@ -149,35 +183,35 @@ class ScrollingDecorViewDelegate : LoadingStateView.DecorViewDelegate() {
 }
 ```
 
-Then set it up.
+最后设置一下就可以了。
 
 ```java
 loadingStateView.setDecorView(new ScrollingDecorViewDelegate());
 ```
 
-## LoadingHelper's migration Guide
+上述的两种使用方式都是可以进行多次设置，不过每次设置会把上一次设置的样式给替换掉。
+
+## LoadingHelper 迁移指南
 
-The original name of this library is `LoadingHelper`, and some class and method names should be changed later. Old users can check the [migration guide](https://github.com/DylanCaiCoding/LoadingHelper) and change it to the latest usage. If you feel troublesome and are not obsessive-compulsive, you can also not migrate.
+本库原名是 `LoadingHelper`，后面对部分类名和方法名进行修改。老用户可以查看[迁移指南](https://github.com/DylanCaiCoding/LoadingHelper/blob/main/README_CN.md)改为最新的用法，如果觉得麻烦并且不是强迫症患者，也可以不迁移。
 
-## Author's other libraries
+## 作者其它的库
 
-| Library                                                      | Description                                                  |
-| ------------------------------------------------------------ | ------------------------------------------------------------ |
-| [Longan](https://github.com/DylanCaiCoding/Longan)           | A collection of Kotlin utils which makes Android application development faster and easier. |
-| [ViewBindingKTX](https://github.com/DylanCaiCoding/ViewBindingKTX) | The most comprehensive utils of ViewBinding.                 |
-| [MMKV-KTX](https://github.com/DylanCaiCoding/MMKV-KTX)       | Easier to use the MMKV.                                      |
-| [ActivityResultLauncher](https://github.com/DylanCaiCoding/ActivityResultLauncher) | Perfect replacement for `startActivityForResult()`           |
+| 库                                                           | 简介                                           |
+| ------------------------------------------------------------ | ---------------------------------------------- |
+| [Longan](https://github.com/DylanCaiCoding/Longan)           | 可能是最好用的 Kotlin 工具库                  |
+| [ViewBindingKTX](https://github.com/DylanCaiCoding/ViewBindingKTX) | 最全面的 ViewBinding 工具                      |
+| [MMKV-KTX](https://github.com/DylanCaiCoding/MMKV-KTX)       | 用属性委托的方式使用 MMKV                              |
 
-## Thanks
+## 感谢
 
-- [luckbilly/Gloading](https://github.com/luckybilly/Gloading) Optimize my library standing on the shoulders of giants.
-- [drakeet/MultiType](https://github.com/drakeet/MultiType)  Referenced the usage of multiple adapters.
-- [dinuscxj/LoadingDrawable](https://github.com/dinuscxj/LoadingDrawable) The cool loading effect in the demo.
+- [luckbilly/Gloading](https://github.com/luckybilly/Gloading) 站在了巨人肩膀上优化了本库，非常感谢！
+- [drakeet/MultiType](https://github.com/drakeet/MultiType) 参考了注册配置多适配器的思想和用法
+- [dinuscxj/LoadingDrawable](https://github.com/dinuscxj/LoadingDrawable) 示例中的自定义加载动画
 
 ## License
 
 ```
-
 Copyright (C) 2019. Dylan Cai
 
 Licensed under the Apache License, Version 2.0 (the "License");

docs/_sidebar.md

@@ -1,13 +1,5 @@
 * [介绍](/)
-
-* Kotlin
-  * [基础用法](/kotlin/basicusage)
-  * [Kotlin 委托用法](/kotlin/delegate)
-  * [结合 ViewBinding 使用](/kotlin/viewbinding)
-
-* Java
-  * [基础用法](/java/basicusage)
-  * [结合 ViewBinding 使用](/kotlin/viewbinding)
-
-* 其它
-  * [Q&A](/others/q&a)
+* [基础用法](/zh/basic-usage)
+* [Kotlin 委托用法](/zh/delegate)
+* [结合 ViewBinding 使用](/zh/viewbinding)
+* [Q&A](/zh/q&a)