From 26104c250195e8dd7166361f862cff0da56a2106 Mon Sep 17 00:00:00 2001 From: chongjuzhang Date: Wed, 20 Oct 2021 15:18:29 +0800 Subject: [PATCH] =?UTF-8?q?fix=EF=BC=9Aupdate=20Chinese=20description=20of?= =?UTF-8?q?=20components?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/docs/zh/components/Alert.mdx | 29 ++-- docs/docs/zh/components/Badge.mdx | 24 +-- docs/docs/zh/components/Banner.mdx | 28 ++-- docs/docs/zh/components/Card.mdx | 2 +- docs/docs/zh/components/Checkbox.mdx | 9 +- docs/docs/zh/components/Descriptions.mdx | 4 +- docs/docs/zh/components/Divider.mdx | 11 +- docs/docs/zh/components/Form.mdx | 2 - docs/docs/zh/components/Grid.mdx | 196 ++++++++++++++--------- docs/docs/zh/components/Group.mdx | 52 +++--- docs/docs/zh/components/Input.mdx | 4 +- docs/docs/zh/components/InputNumber.mdx | 4 +- docs/docs/zh/components/Menu.mdx | 2 +- docs/docs/zh/components/Navs.mdx | 2 +- docs/docs/zh/components/Radio.mdx | 6 +- docs/docs/zh/components/StatusDot.mdx | 2 - docs/docs/zh/components/Tabs.mdx | 2 +- docs/docs/zh/components/Tag.mdx | 6 +- docs/docs/zh/components/Text.mdx | 28 ++-- docs/docs/zh/components/Tooltip.mdx | 6 +- 20 files changed, 230 insertions(+), 189 deletions(-) diff --git a/docs/docs/zh/components/Alert.mdx b/docs/docs/zh/components/Alert.mdx index 8bf4b46d..4f6147b8 100644 --- a/docs/docs/zh/components/Alert.mdx +++ b/docs/docs/zh/components/Alert.mdx @@ -9,11 +9,10 @@ order: 1 ## 基础用法 警告提示,展现需要关注的信息。当某个页面或页面局部表单需要向用户显示警告当信息时使用,非浮层当静态展现形式,始终展现,不会自动消失,用户可以点击关闭。 -代码演示 ```js live=true - Kubesphere.io is an upstream project of the KubeSphere container management platform. + Kubesphere.io is an upstream project of the KubeSphere container management platform. ``` @@ -23,17 +22,17 @@ order: 1 ```js live=true - - Kubesphere.io is an upstream project of the KubeSphere container management platform. - - - Kubesphere.io is an upstream project of the KubeSphere container management platform. - - - Kubesphere.io is an upstream project of the KubeSphere container management platform. - - - Kubesphere.io is an upstream project of the KubeSphere container management platform. - - + + Kubesphere.io is an upstream project of the KubeSphere container management platform. + + + Kubesphere.io is an upstream project of the KubeSphere container management platform. + + + Kubesphere.io is an upstream project of the KubeSphere container management platform. + + + Kubesphere.io is an upstream project of the KubeSphere container management platform. + + ``` diff --git a/docs/docs/zh/components/Badge.mdx b/docs/docs/zh/components/Badge.mdx index 4ab01970..7b0acf88 100644 --- a/docs/docs/zh/components/Badge.mdx +++ b/docs/docs/zh/components/Badge.mdx @@ -8,35 +8,40 @@ order: 1 ## 基础用法 -状态提示,单纯的 count 值 +状态提示,单纯的 count 值。 ```js live=true - +() => ( + 3 12 - + +) ``` ## 不同颜色标记 -徽标内容可以是文本,也可以是数字,通过设置 color 属性可以设置组件的颜色 +徽标内容可以是文本,也可以是数字,通过设置 color 属性可以设置组件的颜色。 ```js live=true - +() => ( + KubeSphere #12 KubeSphere KubeSphere 9 - + +) ``` ## 带阴影标记 -可以设置 shadow,给徽标增加阴影效果。 +可以设置 shadow 给徽标增加阴影效果。 ```js live=true - +() => ( + KubeSphere @@ -52,7 +57,8 @@ order: 1 9 - + +) ``` diff --git a/docs/docs/zh/components/Banner.mdx b/docs/docs/zh/components/Banner.mdx index 24938171..ba60ab4e 100644 --- a/docs/docs/zh/components/Banner.mdx +++ b/docs/docs/zh/components/Banner.mdx @@ -8,7 +8,7 @@ order: 1 ## 何时使用 -Banner 是整个展示页面重要的组成部分,一般介绍产品的名称和简介。 +Banner 是展示整个页面重要的组成部分,一般介绍产品的名称和简介。 ## 代码演示 @@ -16,19 +16,19 @@ Banner 可以展示产品图标和简介,BannerTip 可以展示子条目。 ```js live=true () => { - const data = [ - { - label: 'KubeSphere', - value: 'KubeSphere', - }, - { - label: 'Jenkins', - value: 'Jenkins', - }, - { - label: 'Kubernetes', - value: 'Kubernetes', - }, + const data = [ + { + label: 'KubeSphere', + value: 'KubeSphere', + }, + { + label: 'Jenkins', + value: 'Jenkins', + }, + { + label: 'Kubernetes', + value: 'Kubernetes', + }, ]; const { Cluster } = KubeIcon; return ( diff --git a/docs/docs/zh/components/Card.mdx b/docs/docs/zh/components/Card.mdx index 2b5f7c77..86afe733 100644 --- a/docs/docs/zh/components/Card.mdx +++ b/docs/docs/zh/components/Card.mdx @@ -37,7 +37,7 @@ order: 1 ``` -## 带hover状态 +## 带 hover 状态 ```js live=true () => ( diff --git a/docs/docs/zh/components/Checkbox.mdx b/docs/docs/zh/components/Checkbox.mdx index b50a1fbc..4d85bbb5 100644 --- a/docs/docs/zh/components/Checkbox.mdx +++ b/docs/docs/zh/components/Checkbox.mdx @@ -8,12 +8,11 @@ order: 1 ## 何时使用 -单独使用可以表示两种状态之间的切换,checkbox 一般用于状态标记,需要和提交的操作配合; -用于在一组可选项中进行多项选择时。 +单独使用可以表示两种状态之间的切换,checkbox 一般用于状态标记,需要和提交的操作配合,或者用于在一组可选项中进行多项选择时。 ## 基础用法 -通过 defaultChecked 属性来设置默认勾选。 +通过 defaultChecked 属性来设置默认勾选,通过 onChange 可以添加事件回调函数 ```js live=true () => { @@ -31,7 +30,7 @@ order: 1 ## 禁用状态 -多选框不可用状态 +添加disabled 属性即可让按钮处于不可用状态,同时按钮样式也会发生改变。 ```js live=true () => { @@ -54,7 +53,7 @@ order: 1 ## Indeterminate状态 -indeterminate 属性用来表示 checkbox 的不确定状态,一般用于实现全选的效果 +indeterminate 属性用来表示 checkbox 的不确定状态,一般用于实现全选的效果。 ```js live=true () => { diff --git a/docs/docs/zh/components/Descriptions.mdx b/docs/docs/zh/components/Descriptions.mdx index 40f80628..57f16b53 100644 --- a/docs/docs/zh/components/Descriptions.mdx +++ b/docs/docs/zh/components/Descriptions.mdx @@ -8,9 +8,7 @@ order: 1 ## 基础用法 -列表形式展示多个字段 - -## 代码演示 +列表形式展示字段 ```js live=true () => ( diff --git a/docs/docs/zh/components/Divider.mdx b/docs/docs/zh/components/Divider.mdx index 1a602c4d..ed750aea 100644 --- a/docs/docs/zh/components/Divider.mdx +++ b/docs/docs/zh/components/Divider.mdx @@ -6,12 +6,13 @@ description: '间隔内容的分割线' order: 1 --- -## 基础用法 +## 何时使用 对不同章节对文本段落进行分割 对行内文字/链接进行分割 +## 基础用法 ```js live=true @@ -20,9 +21,11 @@ order: 1 ``` ## 分割线的样式 -使用variant可以设置分割线的显示形式,默认为 solid (实线),dotted (点线),dashed (虚线) -当分割线为垂直方向时,使用margins设置分割线左右的外边距 -当分割线为水平方向时,使用margins设置分割线上下左右的外边距 +使用 variant 可以设置分割线的显示形式,默认为 solid (实线),dotted (点线),dashed (虚线) + +当分割线为垂直方向时,使用 margins 设置分割线左右的外边距 + +当分割线为水平方向时,使用 margins 设置分割线上下左右的外边距 ```js live=true diff --git a/docs/docs/zh/components/Form.mdx b/docs/docs/zh/components/Form.mdx index d9f0e5b1..7abeacb6 100644 --- a/docs/docs/zh/components/Form.mdx +++ b/docs/docs/zh/components/Form.mdx @@ -10,8 +10,6 @@ order: 1 表单控件,用于创建一个实体或收集信息,需要对输入对数据类型进行校验时。 -## 代码演示 - ```js live=true () => { const onFinish = (values) => { diff --git a/docs/docs/zh/components/Grid.mdx b/docs/docs/zh/components/Grid.mdx index 1a2967c1..f552c521 100644 --- a/docs/docs/zh/components/Grid.mdx +++ b/docs/docs/zh/components/Grid.mdx @@ -1,8 +1,8 @@ --- group: 'components' category: 'state' -title: Grid 栅格 -description: '基于Flexbox的12栅格系统' +title: Grid +description: '基于 Flexbox 的12栅格系统' order: 1 --- @@ -11,17 +11,24 @@ order: 1 布局的栅格化系统,是基于行(row)和列(col)来定义信息区块的外部框架,以保证页面的每个区域能够稳健地排布起来。 ```js live=true - - -
col-4
- - -
col-4
- - -
col-4
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-4 + + + col-4 + + + col-4 + + + ) +} ``` ## 设置栅格间距 @@ -29,17 +36,24 @@ order: 1 Gutter 用于设置栅格间距,使用数组形式同时设置[水平间距,垂直间距] ```js live=true - - -
1
- - -
2
- - -
3
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-4 + + + col-4 + + + col-4 + + + ) +} ``` ## 多行 @@ -47,75 +61,103 @@ Gutter 用于设置栅格间距,使用数组形式同时设置[水平间距, 多行排列,栅格系统默认当栅格数是十二,当没有自定义栅格数且一行当栅格超过了十二,那么剩余当栅格将会换行排列。 ```js live=true - - -
1
- - -
2
- - -
3
- - -
4
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-4 + + + col-4 + + + col-4 + + + col-4 + + + ) +} ``` ## Grow自适应 -栅格自适应宽度,在一行中,栅格数超过12时,剩余栅格占满一行。 +栅格自适应宽度,在一行中,栅格数超过 12 时,剩余栅格占满一行。 ```js live=true - - -
col-4
- - -
col-4
- - -
col-4
- - -
col-4
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-4 + + + col-4 + + + col-4 + + + col-4 + + + ) +} ``` ## Offset偏移 -通过给col组件设置 offset,可以控制栅格偏移的距离。 +通过给 col 组件设置 offset,可以控制栅格偏移的距离。 ```js live=true - - -
col-3
- - -
col-3
- - -
col-3
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-3 + + + col-3 + + + col-3 + + + ) +} ``` ## Column大小 -默认是十二栅格,通过给Row组件设置 columns,可以自定义栅格数。 +默认是十二栅格,通过给 Row 组件设置 columns,可以自定义栅格数。 ```js live=true - - -
col-12
- - -
col-6
- - -
col-6
- -
+() => { + const PlaceHolder = ({ children }) => ( +
{children}
+ ); + return ( + + + col-12 + + + col-6 + + + col-6 + + + ) +} ``` diff --git a/docs/docs/zh/components/Group.mdx b/docs/docs/zh/components/Group.mdx index e7eaecb7..afecfbe2 100644 --- a/docs/docs/zh/components/Group.mdx +++ b/docs/docs/zh/components/Group.mdx @@ -12,9 +12,9 @@ order: 1 ```js live=true - - - + + + ``` @@ -25,14 +25,14 @@ order: 1 ```js live=true <> - - - + + + - - - + + + ``` @@ -43,16 +43,16 @@ order: 1 ```js live=true <> - - - - - - - - - - + + + + + + + + + + ``` @@ -66,20 +66,20 @@ order: 1 ```js live=true - - - + + + ``` ## Grow自适应宽度 -grow设置元素占满整个行。 +grow 设置元素占满整个行。 ```js live=true - - - + + + ``` diff --git a/docs/docs/zh/components/Input.mdx b/docs/docs/zh/components/Input.mdx index 8bba837d..85a0bb09 100644 --- a/docs/docs/zh/components/Input.mdx +++ b/docs/docs/zh/components/Input.mdx @@ -11,7 +11,7 @@ order: 1 通过鼠标或键盘输入字符 ```js live=true -() => +() => ``` ## 搜索框 @@ -31,7 +31,7 @@ return ( ## 输入框禁用状态 ```js live=true -() => +() => ``` ## 前置/后置标签 diff --git a/docs/docs/zh/components/InputNumber.mdx b/docs/docs/zh/components/InputNumber.mdx index 191ff974..85a6db00 100644 --- a/docs/docs/zh/components/InputNumber.mdx +++ b/docs/docs/zh/components/InputNumber.mdx @@ -8,7 +8,7 @@ order: 1 ## 基础用法 -通过鼠标或键盘输入范围内的数值 +通过鼠标或键盘输入范围内的数值。 ```js live=true () => @@ -16,6 +16,8 @@ order: 1 ## 禁用数字输入框 +禁用后输入框不能再输入数值。 + ```js live=true () => ``` diff --git a/docs/docs/zh/components/Menu.mdx b/docs/docs/zh/components/Menu.mdx index 555774dd..e34a693a 100644 --- a/docs/docs/zh/components/Menu.mdx +++ b/docs/docs/zh/components/Menu.mdx @@ -12,7 +12,7 @@ order: 1 ## 基础用法 -在Menu组件中嵌套MenuItem组件。 +在 Menu 组件中嵌套 MenuItem 组件。 ```js live=true () => { diff --git a/docs/docs/zh/components/Navs.mdx b/docs/docs/zh/components/Navs.mdx index d9a02d9b..64109925 100644 --- a/docs/docs/zh/components/Navs.mdx +++ b/docs/docs/zh/components/Navs.mdx @@ -17,6 +17,6 @@ order: 1 ] return ( - )33 + ) } ``` diff --git a/docs/docs/zh/components/Radio.mdx b/docs/docs/zh/components/Radio.mdx index 6509c413..05884d04 100644 --- a/docs/docs/zh/components/Radio.mdx +++ b/docs/docs/zh/components/Radio.mdx @@ -8,11 +8,11 @@ order: 1 ## 何时使用 -在一组备选项中进行单选 +在一组备选项中进行单选。 ## 基础用法 -通过value属性设置值,label属性设置按钮标签 +通过value属性设置值,label属性设置按钮标签。 ```js live=true () => @@ -20,7 +20,7 @@ order: 1 ## 默认选中 -设置初始值 +通过 defaultChecked 设置默认选中。 ```js live=true () => diff --git a/docs/docs/zh/components/StatusDot.mdx b/docs/docs/zh/components/StatusDot.mdx index 4bc87208..c09690fd 100644 --- a/docs/docs/zh/components/StatusDot.mdx +++ b/docs/docs/zh/components/StatusDot.mdx @@ -10,8 +10,6 @@ order: 1 状态点,表示任务进行状态 -## 代码演示 - ```js live=true () => ( diff --git a/docs/docs/zh/components/Tabs.mdx b/docs/docs/zh/components/Tabs.mdx index 6602eca7..454e2845 100644 --- a/docs/docs/zh/components/Tabs.mdx +++ b/docs/docs/zh/components/Tabs.mdx @@ -1,7 +1,7 @@ --- group: 'components' category: 'state' -title: Radio +title: Tabs description: '选项卡切换组件' order: 1 --- diff --git a/docs/docs/zh/components/Tag.mdx b/docs/docs/zh/components/Tag.mdx index cffbd50b..3fd05f44 100644 --- a/docs/docs/zh/components/Tag.mdx +++ b/docs/docs/zh/components/Tag.mdx @@ -6,11 +6,7 @@ description: '用于标记和给事物分类,也可用作独立内容的展示 order: 1 --- -## 何时使用 - -用于标记事物的属性和维度;进行分类;展示独立内容。 - -## 基本用法 +## 基础用法 ```js live=true () => ( diff --git a/docs/docs/zh/components/Text.mdx b/docs/docs/zh/components/Text.mdx index d01f2a62..adffa431 100644 --- a/docs/docs/zh/components/Text.mdx +++ b/docs/docs/zh/components/Text.mdx @@ -20,9 +20,9 @@ order: 1 ```js live=true - text warning - text error - text success + text warning + text error + text success ``` @@ -32,11 +32,11 @@ order: 1 ```js live=true - text underline - text delete - text italic - text weight - text weight + text underline + text delete + text italic + text weight + text weight ``` @@ -46,11 +46,11 @@ order: 1 ```js live=true - h1 title - h2 title - h3 title - h4 title - h5 title - h6 title + h1 title + h2 title + h3 title + h4 title + h5 title + h6 title ``` diff --git a/docs/docs/zh/components/Tooltip.mdx b/docs/docs/zh/components/Tooltip.mdx index c4cf12cb..74b9d9a2 100644 --- a/docs/docs/zh/components/Tooltip.mdx +++ b/docs/docs/zh/components/Tooltip.mdx @@ -7,11 +7,11 @@ order: 1 --- -## 基础用法 +## 何时使用 -进行标记和分类带小标签 +鼠标移入则显示提示,移出消失,气泡浮层不承载复杂文本和操作。可用来代替系统默认的 title 提示,提供一个按钮/文字/操作的文案解释。 -## 代码演示 +## 基础用法 ```js live=true () => (