docs(progress): 完善了进度条progressStyle的回调方法描述文档

antvis · Sep 19, 2021 · f4e4237 · f4e4237
1 parent 5678aa4
commit f4e4237
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 5 deletions.
diff --git a/docs/api/plots/progress.en.md b/docs/api/plots/progress.en.md
@@ -21,16 +21,31 @@ order: 20
 
 <description>**optional** _number_ _default:_ `0.5`</description>
 
-条形图宽度占比 [0-1]。
+进度条宽度占比 [0-1]。
 
 #### progressStyle
 
 <description>**optional** _StyleAttr | Function_</description>
 
-柱子样式配置。
+进度条样式配置。
 
 `markdown:docs/common/shape-style.en.md`
 
+使用回调方法获得样式配置
+
+```ts
+({ percent, type }) => {
+  if (type === 'current') {
+    return {
+      // 进度条百分比部分样式
+    };
+  }
+  return {
+    // 进度条背景部分样式
+  };
+};
+```
+
 `markdown:docs/common/color.en.md`
 
 ### Plot Component

diff --git a/docs/api/plots/progress.zh.md b/docs/api/plots/progress.zh.md
@@ -9,7 +9,7 @@ order: 20
 
 ### 数据映射
 
-#### percent 
+#### percent
 
 <description>**required** _number_</description>
 
@@ -21,16 +21,31 @@ order: 20
 
 <description>**optional** _number_ _default:_ `0.5`</description>
 
-条形图宽度占比 [0-1]。
+进度条宽度占比 [0-1]。
 
 #### progressStyle
 
 <description>**optional** _StyleAttr | Function_</description>
 
-柱子样式配置。
+进度条样式配置。
 
 `markdown:docs/common/shape-style.zh.md`
 
+使用回调方法获得样式配置
+
+```ts
+({ percent, type }) => {
+  if (type === 'current') {
+    return {
+      // 进度条百分比部分样式
+    };
+  }
+  return {
+    // 进度条背景部分样式
+  };
+};
+```
+
 `markdown:docs/common/color.zh.md`
 
 ### 图表组件