chore: update website readme (#1301)

Tencent · Dec 28, 2022 · 39731f8 · 39731f8
1 parent ae11352
commit 39731f8
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 11 deletions.
diff --git a/src/empty/README.md b/src/empty/README.md
@@ -1,5 +1,5 @@
 ---
-title: Empty 空内容
+title: Empty 空状态
 description: 用于空状态时的占位提示。
 spline: data
 isComponent: true

diff --git a/src/fab/README.md b/src/fab/README.md
@@ -1,5 +1,5 @@
 ---
-title: Fab
+title: Fab 悬浮按钮
 description: 当功能使用图标即可表意清楚时，可使用纯图标悬浮按钮，例如：添加、发布。
 spline: form
 isComponent: true

diff --git a/src/indexes/README.md b/src/indexes/README.md
@@ -22,7 +22,11 @@ isComponent: true
 ### 基础索引
 
 
-{{ display }}
+{{ base }}
+
+### 自定义索引
+
+{{ custom }}
 
 ### API
 ### Indexes Props

diff --git a/src/notice-bar/README.md b/src/notice-bar/README.md
@@ -1,5 +1,5 @@
 ---
-title: NoticeBar 消息通知
+title: NoticeBar 公告栏
 description: 在导航栏下方，用于给用户显示提示消息。
 spline: message
 isComponent: true

diff --git a/src/progress/README.md b/src/progress/README.md
@@ -1,6 +1,6 @@
 ---
-title: Progress
-description: 进度条。
+title: Progress 进度条
+description: 用于展示任务当前的进度。
 spline: message
 isComponent: true
 ---
@@ -21,6 +21,7 @@ isComponent: true
 ## 代码演示
 
 ### 01 组件类型
+
 基础进度条
 
 {{ base }}
@@ -33,8 +34,6 @@ isComponent: true
 
 {{ custom }}
 
-
-
 ### 02 组件状态
 
 线性进度条

diff --git a/src/steps/README.md b/src/steps/README.md
@@ -25,20 +25,33 @@ isComponent: true
 
 #### 水平步骤条
 
+支持三种类型：序号、图标、简略
+
 {{ horizontal }}
 
-#### 竖向只读步骤条
+#### 垂直步骤条
+
+支持三种类型：序号、图标、简略
 
 {{ vertical }}
 
 ### 组件状态
 
 #### 选项卡状态
 
+共支持 4 种状态：未完成（default）、已完成（finish）、进行中（process）、错误（error）
+
 {{ status }}
 
 ### 特殊类型
 
+通过已有特性，改造出两种常见类型：
+
+- 垂直自定义（在 Cascader 中使用）
+- 纯展示步骤条
+
+可以参考以下代码实现
+
 {{ special }}
 
 ## API

diff --git a/src/steps/__test__/__snapshots__/demo.test.js.snap b/src/steps/__test__/__snapshots__/demo.test.js.snap
@@ -105,7 +105,7 @@ exports[`Steps Steps special demo works fine 1`] = `
   <wx-view
     class="demo-desc"
   >
-    纵向自定义步骤条
+    垂直自定义步骤条
   </wx-view>
   <wx-view
     class="block"

diff --git a/src/steps/_example/special/index.wxml b/src/steps/_example/special/index.wxml
@@ -3,7 +3,7 @@
   return'当前步骤'; return '未完成步骤'; }
 </wxs>
 
-<view class="demo-desc">纵向自定义步骤条</view>
+<view class="demo-desc">垂直自定义步骤条</view>
 
 <view class="block">
   <t-steps layout="vertical" theme="dot" current="{{count - 1}}" bind:change="onCascader">