docs(update): update documents (#4453)
Co-authored-by: zhangxuelin@xd.com <zhangxuelin@xd.com>pull/4454/head
parent
6953698385
commit
66219e2b86
|
@ -5,7 +5,7 @@ import WithText from './with-text';
|
||||||
import CN from '../index.zh-CN.md';
|
import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 分割线
|
cn: `# Divider 分割线
|
||||||
区隔内容的分割线。
|
区隔内容的分割线。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
- 对不同章节的文本段落进行分割。
|
- 对不同章节的文本段落进行分割。
|
||||||
|
|
|
@ -11,7 +11,7 @@ import Trigger from './trigger';
|
||||||
import CN from '../index.zh-CN.md';
|
import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 下拉菜单
|
cn: `# Dropdown 下拉菜单
|
||||||
向下弹出的列表。
|
向下弹出的列表。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
当页面上的操作命令过多时,用此组件可以收纳操作元素。点击或移入触点,会出现一个下拉菜单。可在列表中进行选择,并执行相应的命令。
|
当页面上的操作命令过多时,用此组件可以收纳操作元素。点击或移入触点,会出现一个下拉菜单。可在列表中进行选择,并执行相应的命令。
|
||||||
|
|
|
@ -9,7 +9,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 空状态
|
cn: `# Empty 空状态
|
||||||
空状态时的展示占位图。
|
空状态时的展示占位图。
|
||||||
|
|
||||||
空状态时的展示占位图。
|
空状态时的展示占位图。
|
||||||
|
|
|
@ -8,7 +8,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 数字输入框
|
cn: `# InputNumber 数字输入框
|
||||||
通过鼠标或键盘,输入范围内的数值。
|
通过鼠标或键盘,输入范围内的数值。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
当需要获取标准数值时。
|
当需要获取标准数值时。
|
||||||
|
|
|
@ -13,7 +13,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 布局
|
cn: `# Layout 布局
|
||||||
协助进行页面级整体布局。
|
协助进行页面级整体布局。
|
||||||
|
|
||||||
## 设计规则
|
## 设计规则
|
||||||
|
|
|
@ -12,7 +12,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 列表
|
cn: `# List 列表
|
||||||
通用列表。
|
通用列表。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
最基础的列表展示,可承载文字、列表、图片、段落,常用于后台数据展示页面。
|
最基础的列表展示,可承载文字、列表、图片、段落,常用于后台数据展示页面。
|
||||||
|
|
|
@ -8,7 +8,7 @@ import Update from './update';
|
||||||
import CN from '../index.zh-CN.md';
|
import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 全局提示
|
cn: `# Message 全局提示
|
||||||
全局展示操作反馈信息。
|
全局展示操作反馈信息。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
- 可提供成功、警告和错误等反馈信息。
|
- 可提供成功、警告和错误等反馈信息。
|
||||||
|
|
|
@ -11,7 +11,7 @@ import Update from './update';
|
||||||
import CN from '../index.zh-CN.md';
|
import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 通知提醒框
|
cn: `# Notification 通知提醒框
|
||||||
全局展示通知提醒信息。
|
全局展示通知提醒信息。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
在系统四个角显示通知提醒信息。经常用于以下情况:
|
在系统四个角显示通知提醒信息。经常用于以下情况:
|
||||||
|
|
|
@ -8,7 +8,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# Popconfirm
|
cn: `# Popconfirm 气泡确认框
|
||||||
|
|
||||||
点击元素,弹出气泡式的确认框。
|
点击元素,弹出气泡式的确认框。
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# Popover
|
cn: `# Popover 气泡卡片
|
||||||
|
|
||||||
点击/鼠标移入元素,弹出气泡式的卡片浮层。
|
点击/鼠标移入元素,弹出气泡式的卡片浮层。
|
||||||
|
|
||||||
|
|
|
@ -13,7 +13,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 单选框
|
cn: `# Radio 单选框
|
||||||
单选框。
|
单选框。
|
||||||
|
|
||||||
## 何时使用
|
## 何时使用
|
||||||
|
|
|
@ -9,7 +9,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# Rate
|
cn: `# Rate 评分
|
||||||
|
|
||||||
评分组件。
|
评分组件。
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 加载占位图
|
cn: `# Skeleton 加载占位图/骨架屏
|
||||||
|
|
||||||
在需要等待加载内容的位置提供一个占位图。
|
在需要等待加载内容的位置提供一个占位图。
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# Steps
|
cn: `# Steps 步骤条
|
||||||
|
|
||||||
引导用户按照流程完成任务的导航条。
|
引导用户按照流程完成任务的导航条。
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 时间轴
|
cn: `# Timeline 时间轴
|
||||||
垂直展示的时间流信息。
|
垂直展示的时间流信息。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
- 当有一系列信息需按时间排列时,可正序和倒序。
|
- 当有一系列信息需按时间排列时,可正序和倒序。
|
||||||
|
|
|
@ -7,7 +7,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# Tooltip
|
cn: `# Tooltip 文字提示
|
||||||
|
|
||||||
简单的文字提示气泡框。
|
简单的文字提示气泡框。
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 穿梭框
|
cn: `# Transfer 穿梭框
|
||||||
双栏穿梭选择框。
|
双栏穿梭选择框。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 树型选择控件
|
cn: `# TreeSelect 树型选择控件
|
||||||
## 何时使用
|
## 何时使用
|
||||||
|
|
||||||
类似 Select 的选择控件,可选择的数据结构是一个树形结构时,可以使用 TreeSelect,例如公司层级、学科系统、分类目录等等。
|
类似 Select 的选择控件,可选择的数据结构是一个树形结构时,可以使用 TreeSelect,例如公司层级、学科系统、分类目录等等。
|
||||||
|
|
|
@ -15,7 +15,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 树形控件
|
cn: `# Tree 树形控件
|
||||||
## 何时使用
|
## 何时使用
|
||||||
|
|
||||||
文件夹、组织架构、生物分类、国家地区等等,世间万物的大多数结构都是树形结构。使用\`树控件\`可以完整展现其中的层级关系,并具有展开收起选择等交互功能。
|
文件夹、组织架构、生物分类、国家地区等等,世间万物的大多数结构都是树形结构。使用\`树控件\`可以完整展现其中的层级关系,并具有展开收起选择等交互功能。
|
||||||
|
|
|
@ -15,7 +15,7 @@ import CN from '../index.zh-CN.md';
|
||||||
import US from '../index.en-US.md';
|
import US from '../index.en-US.md';
|
||||||
|
|
||||||
const md = {
|
const md = {
|
||||||
cn: `# 上传
|
cn: `# Upload 上传
|
||||||
上传是将信息(网页、文字、图片、视频等)通过网页或者上传工具发布到远程服务器上的过程。
|
上传是将信息(网页、文字、图片、视频等)通过网页或者上传工具发布到远程服务器上的过程。
|
||||||
## 何时使用
|
## 何时使用
|
||||||
- 当需要上传一个或一些文件时。
|
- 当需要上传一个或一些文件时。
|
||||||
|
|
Loading…
Reference in New Issue