瀏覽代碼

Merge branch 'docs-usageDescription'

pointhalo 3 年之前
父節點
當前提交
70a3e1cf70

+ 2 - 4
content/feedback/popconfirm/index.md

@@ -8,11 +8,9 @@ brief: 点击元素,弹出气泡式的确认框。
 ---
 
 
-## 何时使用
+## 使用场景
 
-目标元素的操作需要用户进一步的确认时,在目标元素附近弹出浮层提示,询问用户。
-
-和 `Modal.confirm` 弹出的全屏居中模态对话框相比,交互形式更轻量。
+目标元素的操作需要用户进一步的确认时使用。与 Popover 相比它内置了一系列可配置的操作按钮,与 Modal 相比它不强制全屏居中显示,交互也更轻量
 
 ## 代码演示
 

+ 2 - 2
content/feedback/progress/index.md

@@ -8,9 +8,9 @@ width: 60%
 brief: 展示操作的当前进度。
 ---
 
-## 何时使用
+## 使用场景
 
-在操作需要较长时间才能完成时,为用户显示该操作的当前进度和状态
+用于展示用户操作的当前进度和状态,一般在操作耗时较长时使用。也可用来表示任务/对象的完成度
 
 ## 代码演示
 

+ 1 - 1
content/input/autocomplete/index.md

@@ -7,7 +7,7 @@ icon: doc-autocomplete
 brief: 输入框自动填充。
 ---
 
-## 何时使用
+## 使用场景
 
 用于对输入框提供输入建议,进行自动补全的操作
 

+ 3 - 3
content/input/checkbox/index.md

@@ -8,10 +8,10 @@ brief: 复选框允许用户选中多个选项
 ---
 
 
-## 何时使用
+## 使用场景
 
-- 在一组可选项中进行多项选择时;
-- 单独使用可以表示两种状态之间的切换,和 Switch 类似。区别在于切换 Switch 会直接触发状态改变,而 Checkbox 一般用于状态标记,需要和提交操作配合。
+- 勾选框可以让用户在两种相反的状态、行为或取值之间选择;
+- 适用于在列表中选择单个或多个选项,开启或关闭某个选项
 
 ## 代码演示
 

+ 2 - 2
content/input/datepicker/index.md

@@ -7,9 +7,9 @@ icon: doc-datepicker
 brief: 日期选择器用于帮助用户选择一个符合要求的、格式化的日期(时间)或日期(时间)范围
 ---
 
-## 何时使用
+## 使用场景
 
-当用户需要输入一个日期,可以点击标准输入框,弹出日期面板进行选择。
+日期选择器用于帮助用户选择一个符合要求的、格式化的日期(时间)或日期(时间)范围
 
 ## 代码演示
 

+ 2 - 2
content/input/inputnumber/index.md

@@ -8,9 +8,9 @@ brief: 通过鼠标或键盘,输入范围内的数值。
 ---
 
 
-## 何时使用
+## 使用场景
 
-当需要获取标准数值时。
+通过鼠标或键盘,输入范围内的数值,与 Input 不同的是它带有针对数字场景的步进器操作区,配合 Parser 使用可以展示更复杂的内容格式
 
 ## 代码演示
 

+ 3 - 3
content/input/radio/index.md

@@ -7,10 +7,10 @@ icon: doc-radio
 brief: 用户使用单选框来从少量的选项集合中选择单个选项
 ---
 
-## 何时使用
+## 使用场景
 
--   用于在多个备选项中选中单个状态。
--   和 Select 的区别是,Radio 所有选项默认可见,方便用户在比较中选择,因此选项不宜过多
+单选框(Radio)也叫单选按钮,它允许用户在一组选项中选择其中一个。  
+当选项很多时,单选下拉菜单(Select)可能比较适合,因为它所占用的画面空间比单选按钮来得要少
 
 ## 代码演示
 ### 如何引入

+ 2 - 3
content/input/timepicker/index.md

@@ -8,10 +8,9 @@ brief: 用户使用时间选择器可以方便地选择某一符合要求的、
 ---
 
 
-## 何时使用
-
-当用户需要输入一个时间,可以点击标准输入框,弹出时间面板进行选择。
+## 使用场景
 
+时间选择器用于帮助用户选择一个符合要求的、格式化的时间(范围)
 ## 代码演示
 
 ### 如何引入

+ 2 - 3
content/input/treeselect/index.md

@@ -7,10 +7,9 @@ icon: doc-treeselect
 brief: 树型选择组件。
 ---
 
-## 何时使用
-
-类似 Select 的选择控件,可选择的数据结构是一个树形结构时,可以使用 TreeSelect,例如公司层级、学科系统、分类目录等等。
+## 使用场景
 
+树选择器用于多层级树形数据的结构化展示 & 选取,例如显示文件夹与文件的列表、显示组织架构成员列表等等。
 
 ## 代码演示
 

+ 2 - 2
content/navigation/navigation/index.md

@@ -10,9 +10,9 @@ brief: 为页面和功能提供导航的菜单列表。
 ---
 
 
-## 何时使用
+## 使用场景
 
-导航菜单是一个网站的灵魂,用户依赖导航在各个页面中进行跳转。一般分为顶部导航和侧边导航,顶部导航提供全局性的类目和功能,侧边导航提供多级结构来收纳和排列网站架构
+为页面和功能提供导航的菜单列表
 
 ## 代码演示
 

+ 2 - 2
content/navigation/steps/index.md

@@ -9,9 +9,9 @@ brief: 当一个长流程需要分步时,使用步骤组件来让用户知道
 ---
 
 
-## 何时使用
+## 使用场景
 
-当任务复杂或者存在先后关系时,将其分解成一系列步骤,从而简化任务。
+将复杂任务或存在先后关系的任务分解,使用步骤组件引导用户按规定流程操作,并让其知道其当前的进度,
 
 ## 代码演示
 

+ 1 - 1
content/show/collapsible/index.md

@@ -7,7 +7,7 @@ icon: doc-collapsible
 brief: 行为组件,是一个用于展开或折叠内容的容器。
 ---
 
-## 何时使用
+## 使用场景
 
 -   `Collapsible` 是一个行为组件,默认开启动画效果。它被用于 Semi 的各种组件中,如:`Navigation`, `Collapse`, `Tree`, `TreeSelect`,以及 `Typography` 中。
 -   当上述组件不能满足需求或者需要自定义一些折叠行为时,可以使用 `Collapsible` 来包裹需要展开或者折叠的内容。

+ 1 - 1
content/show/overflowlist/index.md

@@ -7,7 +7,7 @@ icon: doc-overflowList
 breif: 用于自动折叠过长内容的容器。
 ---
 
-## 何时使用
+## 使用场景
 
 `OverflowList` 是一个行为组件,用于展示列表,并支持自适应来展示尽可能多的项目。因过长而溢出项目将折叠为一个元素。当检测到调整大小时,可见项将被重新计算。
 

+ 3 - 3
content/show/popover/index.md

@@ -7,11 +7,11 @@ icon: doc-popover
 brief: 点击/鼠标移入元素,弹出气泡式的卡片浮层。
 ---
 
-## 何时使用
+## 使用场景
 
-当目标元素有进一步的描述和相关操作时,可以收纳到卡片中,根据用户的操作行为进行展现
+Popover 气泡卡片是由用户自主打开的临时性浮层卡片,能够承载一些额外内容和交互行为而不影响原页面
 
-和 Tooltip 的区别是,用户可以对浮层上的元素进行操作,因此它可以承载更复杂的内容,比如链接或按钮等
+和 Tooltip 的区别是,它可以承载更复杂的内容,而不仅仅是提示文本
 
 ## 代码演示
 

+ 2 - 3
content/show/table/index.md

@@ -8,10 +8,9 @@ brief: 展示行列数据。
 ---
 
 
-## 何时使用
+## 使用场景
 
--   当有大量结构化的数据需要展现时;
--   当需要对数据进行排序、搜索、分页、自定义操作等复杂行为时。
+表格用于呈现结构化的数据内容,通常会伴随提供对数据进行操作(排序、搜素、分页……)的能力。
 
 ## 如何使用