浏览代码

docs: update component usage sub title, remove duplicate component descriptions

pointhalo 3 年之前
父节点
当前提交
5b12ec8efc
共有 33 个文件被更改,包括 28 次插入119 次删除
  1. 1 1
      content/basic/layout/index-en-US.md
  2. 1 1
      content/basic/layout/index.md
  3. 1 8
      content/feedback/popconfirm/index-en-US.md
  4. 1 6
      content/feedback/popconfirm/index.md
  5. 2 7
      content/feedback/progress/index-en-US.md
  6. 1 6
      content/feedback/progress/index.md
  7. 0 4
      content/input/datepicker/index-en-US.md
  8. 0 4
      content/input/datepicker/index.md
  9. 1 1
      content/input/inputnumber/index-en-US.md
  10. 1 6
      content/input/inputnumber/index.md
  11. 1 1
      content/input/rating/index.md
  12. 1 1
      content/input/slider/index-en-US.md
  13. 1 1
      content/input/slider/index.md
  14. 0 4
      content/input/timepicker/index-en-US.md
  15. 0 3
      content/input/timepicker/index.md
  16. 2 1
      content/input/treeselect/index-en-US.md
  17. 1 5
      content/input/treeselect/index.md
  18. 0 1
      content/navigation/backtop/index-en-US.md
  19. 0 1
      content/navigation/backtop/index.md
  20. 0 5
      content/navigation/navigation/index-en-US.md
  21. 0 4
      content/navigation/navigation/index.md
  22. 1 5
      content/navigation/steps/index-en-US.md
  23. 1 6
      content/navigation/steps/index.md
  24. 1 1
      content/show/calendar/index-en-US.md
  25. 1 1
      content/show/calendar/index.md
  26. 1 5
      content/show/list/index-en-US.md
  27. 1 5
      content/show/list/index.md
  28. 1 6
      content/show/overflowlist/index-en-US.md
  29. 1 5
      content/show/overflowlist/index.md
  30. 2 2
      content/show/sidesheet/index-en-US.md
  31. 1 1
      content/show/sidesheet/index.md
  32. 1 6
      content/show/table/index-en-US.md
  33. 1 5
      content/show/table/index.md

+ 1 - 1
content/basic/layout/index-en-US.md

@@ -6,7 +6,7 @@ title:  Layout
 subTitle: Layout
 icon: doc-layout
 dir: column
-brief: Assist in the overall layout of a page.
+brief: Used to quickly divide the overall layout of the page
 ---
 
 

+ 1 - 1
content/basic/layout/index.md

@@ -5,7 +5,7 @@ category: 基础
 title: Layout 布局
 icon: doc-layout
 dir: column
-brief: 协助进行页面级整体布局。
+brief: 用于快捷划分页面整体布局
 ---
 
 ## 概述

+ 1 - 8
content/feedback/popconfirm/index-en-US.md

@@ -5,19 +5,12 @@ category: Feedback
 title:  Popconfirm
 subTitle: Popconfirm
 icon: doc-popconfirm
-brief: Click on the element to pop up the bubble confirmation box.
+brief: Used when the operation of the target element requires further confirmation from the user. Compared with Popover, it has a built-in series of configurable action buttons. Compared with Modal, it does not force full-screen centering, and the interaction is lighter.
 ---
 
 
-## When to Use
-
-When the operation of the target element requires further confirmation by the user, a floating layer prompt pops up near the target element to ask the user.
-
-and `Modal.confirm` Compared with the pop-up full-screen centered mode dialog box, the interactive form is lighter.
-
 ## Demos
 
-
 ### How to import
 
 ```jsx import

+ 1 - 6
content/feedback/popconfirm/index.md

@@ -4,14 +4,9 @@ order: 64
 category: 反馈类
 title:  Popconfirm 气泡确认框
 icon: doc-popconfirm
-brief: 点击元素,弹出气泡式的确认框。
+brief: 目标元素的操作需要用户进一步的确认时使用。与 Popover 相比它内置了一系列可配置的操作按钮,与 Modal 相比它不强制全屏居中显示,交互也更轻量
 ---
 
-
-## 使用场景
-
-目标元素的操作需要用户进一步的确认时使用。与 Popover 相比它内置了一系列可配置的操作按钮,与 Modal 相比它不强制全屏居中显示,交互也更轻量
-
 ## 代码演示
 
 ### 如何引入

+ 2 - 7
content/feedback/progress/index-en-US.md

@@ -6,13 +6,8 @@ title: Progress
 subTitle: Progress
 icon: doc-progress
 width: 60%
-brief: Show the current progress of the operation.
+brief: Used to display the current progress and status of the user operation, and is generally used when the operation takes a long time. Can also be used to indicate the degree of completion of a task/object
 ---
-
-## When to use
-
-Display the current progress and state of the operation for the user when the operation takes a long time to complete
-
 ## Demos
 
 ### How to import
@@ -35,7 +30,7 @@ import { Progress } from '@douyinfe/semi-ui';
 
 () => (
     <div style={{ width: 200 }}>
-       <Progress percent={10} stroke="var(--semi-color-warning)" aria-label="disk usage" />
+        <Progress percent={10} stroke="var(--semi-color-warning)" aria-label="disk usage" />
         <br />
         <Progress percent={25} stroke="var(--semi-color-danger)" aria-label="disk usage" />
         <br />

+ 1 - 6
content/feedback/progress/index.md

@@ -5,13 +5,8 @@ category: 反馈类
 title: Progress 进度条
 icon: doc-progress
 width: 60%
-brief: 展示操作的当前进度。
+brief: 用于展示用户操作的当前进度和状态,一般在操作耗时较长时使用也可用来表示任务/对象的完成度
 ---
-
-## 使用场景
-
-用于展示用户操作的当前进度和状态,一般在操作耗时较长时使用。也可用来表示任务/对象的完成度
-
 ## 代码演示
 
 ### 如何引入

+ 0 - 4
content/input/datepicker/index-en-US.md

@@ -8,10 +8,6 @@ icon: doc-datepicker
 brief: The date selector is used to help the user select a compliant, formatted date (time) or date (time) range.
 ---
 
-## When to Use
-
-When the user needs to enter a date, you can click on the standard input box and pop up the date panel to select.
-
 ## Demos
 
 ### How to import

+ 0 - 4
content/input/datepicker/index.md

@@ -7,10 +7,6 @@ icon: doc-datepicker
 brief: 日期选择器用于帮助用户选择一个符合要求的、格式化的日期(时间)或日期(时间)范围
 ---
 
-## 使用场景
-
-日期选择器用于帮助用户选择一个符合要求的、格式化的日期(时间)或日期(时间)范围
-
 ## 代码演示
 
 ### 如何引入

+ 1 - 1
content/input/inputnumber/index-en-US.md

@@ -5,7 +5,7 @@ category: Input
 title:  InputNumber
 subTitle: InputNumber
 icon: doc-inputnumber
-brief: Enter values within range through a mouse or keyboard.
+brief: Through the mouse or keyboard, input the value in the range. Unlike Input, it has a stepper operation area for digital scenes, and it can display more complex content formats when used with Parser.
 ---
 
 

+ 1 - 6
content/input/inputnumber/index.md

@@ -4,14 +4,9 @@ order: 24
 category: 输入类
 title: InputNumber 数字输入框
 icon: doc-inputnumber
-brief: 通过鼠标或键盘,输入范围内的数值
+brief: 通过鼠标或键盘,输入范围内的数值,与 Input 不同的是它带有针对数字场景的步进器操作区,配合 Parser 使用可以展示更复杂的内容格式
 ---
 
-
-## 使用场景
-
-通过鼠标或键盘,输入范围内的数值,与 Input 不同的是它带有针对数字场景的步进器操作区,配合 Parser 使用可以展示更复杂的内容格式
-
 ## 代码演示
 
 ### 如何引入

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

@@ -4,7 +4,7 @@ order: 26
 category: 输入类
 title:  Rating 评分
 icon: doc-rating
-brief: 展示评分的组件
+brief: 展示评分的组件
 ---
 
 

+ 1 - 1
content/input/slider/index-en-US.md

@@ -5,7 +5,7 @@ category: Input
 title:  Slider
 subTitle: Slider
 icon: doc-slider
-brief: Slider is used to help users quickly enter a numeric value or range.
+brief: Selector to quickly select a number or range of values using drag interaction, more intuitive than InputNumber
 ---
 
 

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

@@ -4,7 +4,7 @@ order: 28
 category: 输入类
 title:  Slider 滑动选择器
 icon: doc-slider
-brief: 滑动选择器帮助用户快速输入连续或离散的数值,或由这些数值组成的一段数值范围。
+brief: 滑动选择器,使用拖动交互快速选择数值或数值范围,与 InputNumber 相比更直观
 ---
 
 

+ 0 - 4
content/input/timepicker/index-en-US.md

@@ -8,10 +8,6 @@ icon: doc-timepicker
 brief: Users can easily select a compliant, formatted point of time using the time selector.
 ---
 
-## When to Use
-
-When users need to enter a time, they can click on the standard input box and pop up the time panel to select.
-
 ## Demos
 
 ### How to import

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

@@ -8,9 +8,6 @@ brief: 用户使用时间选择器可以方便地选择某一符合要求的、
 ---
 
 
-## 使用场景
-
-时间选择器用于帮助用户选择一个符合要求的、格式化的时间(范围)
 ## 代码演示
 
 ### 如何引入

+ 2 - 1
content/input/treeselect/index-en-US.md

@@ -5,7 +5,8 @@ category: Input
 title:  TreeSelect
 subTitle: TreeSelect
 icon: doc-treeselect
-brief: A tree view component for selection.
+brief: TreeSelector is used for structured display & selection of multi-level tree data, such as displaying a list of folders and files, displaying a list of organizational structure members, and so on.
+---
 ---
 
 

+ 1 - 5
content/input/treeselect/index.md

@@ -4,13 +4,9 @@ order: 33
 category: 输入类
 title: TreeSelect 树选择器
 icon: doc-treeselect
-brief: 树型选择组件
+brief: 树选择器用于多层级树形数据的结构化展示 & 选取,例如显示文件夹与文件的列表、显示组织架构成员列表等等
 ---
 
-## 使用场景
-
-树选择器用于多层级树形数据的结构化展示 & 选取,例如显示文件夹与文件的列表、显示组织架构成员列表等等。
-
 ## 代码演示
 
 ### 如何引入

+ 0 - 1
content/navigation/backtop/index-en-US.md

@@ -5,7 +5,6 @@ category: Navigation
 title: BackTop
 subTitle: BackTop
 icon: doc-backtop
-brief: The BackTop component is a button used to return to the top of the page.
 ---
 
 ## Demos

+ 0 - 1
content/navigation/backtop/index.md

@@ -4,7 +4,6 @@ order: 36
 category: 导航类
 title: BackTop 回到顶部
 icon: doc-backtop
-brief: 返回页面顶部的操作按钮。
 ---
 
 ## 代码演示

+ 0 - 5
content/navigation/navigation/index-en-US.md

@@ -10,11 +10,6 @@ dir: column
 brief: A menu list that provides navigation for pages and features.
 ---
 
-
-## When to Use
-
-The navigation menu is the soul of a website, and users rely on navigation to jump in various pages. It is generally divided into top navigation and side navigation, top navigation provides global categories and functions, and side navigation provides a multi-level structure to accommodate and arrange the website architecture.
-
 ## Demos
 
 ### How to import

+ 0 - 4
content/navigation/navigation/index.md

@@ -10,10 +10,6 @@ brief: 为页面和功能提供导航的菜单列表。
 ---
 
 
-## 使用场景
-
-为页面和功能提供导航的菜单列表。
-
 ## 代码演示
 
 ### 如何引入

+ 1 - 5
content/navigation/steps/index-en-US.md

@@ -6,13 +6,9 @@ title: Steps
 subTitle: Steps
 icon: doc-steps
 dir: column
-brief: When a long process needs to be step by step, use the step component to let the user know its current progress
+brief: Decompose complex tasks or tasks with prior relationships, use step components to guide users to operate according to the prescribed process, and let them know their current progress
 ---
 
-## When to use
-
-When the task is complex or has a sequential relationship, it is broken down into a series of steps to simplify the task.
-
 ## Demos
 
 ### How to import

+ 1 - 6
content/navigation/steps/index.md

@@ -5,14 +5,9 @@ category: 导航类
 title:  Steps 步骤
 icon: doc-steps
 dir: column
-brief: 当一个长流程需要分步时,使用步骤组件来让用户知道其当前的进度
+brief: 将复杂任务或存在先后关系的任务分解,使用步骤组件引导用户按规定流程操作,并让其知道其当前的进度
 ---
 
-
-## 使用场景
-
-将复杂任务或存在先后关系的任务分解,使用步骤组件引导用户按规定流程操作,并让其知道其当前的进度,
-
 ## 代码演示
 
 ### 如何引入

+ 1 - 1
content/show/calendar/index-en-US.md

@@ -6,7 +6,7 @@ title:  Calendar
 subTitle: Calendar
 icon: doc-calendar
 dir: column
-brief: A container that displays data in calendar form.
+brief: Calendar component that allows to display corresponding events in day/week/month view
 ---
 
 ## Demos

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

@@ -5,7 +5,7 @@ category: 展示类
 title: Calendar 日历
 icon: doc-calendar
 dir: column
-brief: 按照日历形式展示数据的容器。
+brief: 日历组件,允许以日/周/月视图展示对应事件
 ---
 
 ## 代码演示

+ 1 - 5
content/show/list/index-en-US.md

@@ -6,13 +6,9 @@ title: List
 subTitle: List
 icon: doc-list
 dir: column
-brief: Lists display a set of related contents.
+brief: Lists display a set of related contents
 ---
 
-## When to Use
-
-Lists display a set of texts, lists, images, paragraphs, etc. It is commonly used in data display pages.
-
 ## Demos
 
 ### How to import

+ 1 - 5
content/show/list/index.md

@@ -6,13 +6,9 @@ title: List 列表
 icon: doc-list
 dir: column
 noInline: true
-brief: 基础列表组件
+brief: 基础列表组件
 ---
 
-## 使用场景
-
-最基础的列表展示,可展现文字、列表、图片、段落等,常用于后台数据展示页面。
-
 ## 代码演示
 
 ### 如何引入

+ 1 - 6
content/show/overflowlist/index-en-US.md

@@ -5,13 +5,8 @@ category: Show
 title: OverflowList
 subTitle: OverflowList
 icon: doc-overflowList
-brief: The OverflowList component is a container component used to take list of items and display as many items as can fit inside itself.
+brief: `OverflowList` is a behavior component used to take list of items and display as many items as can fit inside itself. Overflowed items that do not fit are collected and rendered by callback function. The visible items will be recomputed when a resize is detected.
 ---
-
-## When to use
-
-`OverflowList` is a behavior component used to take list of items and display as many items as can fit inside itself. Overflowed items that do not fit are collected and rendered by callback function. The visible items will be recomputed when a resize is detected.
-
 ## Demos
 
 ### How to import

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

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

+ 2 - 2
content/show/sidesheet/index-en-US.md

@@ -5,13 +5,13 @@ category: Show
 title: SideSheet
 subTitle: SideSheet
 icon: doc-sidesheet
-brief: SideSheet is a panel which slides in from the edge of the screen.
+brief: An overlay panel that slides out from the edge of the screen, typically used to host secondary action pages.
 ---
 
 ## Demos
 
 ### How to import
-
+.
 ```jsx import
 import { SideSheet } from '@douyinfe/semi-ui';
 ```

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

@@ -4,7 +4,7 @@ order: 57
 category: 展示类
 title: SideSheet 滑动侧边栏
 icon: doc-sidesheet
-brief: 屏幕边缘滑出的浮层面板。
+brief: 可从屏幕边沿滑出的浮层面板,通常用于承载二级操作页面
 ---
 
 ## 代码演示

+ 1 - 6
content/show/table/index-en-US.md

@@ -6,14 +6,9 @@ title: Table
 subTitle: Table
 icon: doc-table
 dir: column
-brief: Show row data.
+brief: Tables are used to present structured data content, usually accompanied by the ability to manipulate the data (sort, search, paginate...).
 ---
 
-## When to Use
-
--   When there is a large amount of structured data to be presented;
--   When complex behaviors such as sorting, searching, paging and customizing data need to be performed.
-
 ## How to Use
 
 Into the header. `columns` And data. `DataSource` To render.

+ 1 - 5
content/show/table/index.md

@@ -4,14 +4,10 @@ order: 58
 category: 展示类
 title:  Table 表格
 icon: doc-table
-brief: 展示行列数据
+brief: 表格用于呈现结构化的数据内容,通常会伴随提供对数据进行操作(排序、搜素、分页……)的能力
 ---
 
 
-## 使用场景
-
-表格用于呈现结构化的数据内容,通常会伴随提供对数据进行操作(排序、搜素、分页……)的能力。
-
 ## 如何使用
 
 往 Table 传入表头 `columns` 和数据 `dataSource` 进行渲染。