Skip to content

Commit

Permalink
docs: markdown grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
liuxy0551 committed Jun 19, 2024
1 parent f58244f commit 1bef077
Show file tree
Hide file tree
Showing 21 changed files with 77 additions and 42 deletions.
6 changes: 4 additions & 2 deletions components/breadcrumb/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ subtitle: 面包屑

## 设计规范

面包屑文字大小 12px,当前页字体颜色#3D446E Regular,非当前页字体颜色为#8B8FA8 Regular,分隔符填充颜色为#B1B4C5,整体面包屑行高(文本行高)20px
- 面包屑文字大小 12px
- 当前页字体颜色#3D446E Regular,非当前页字体颜色为#8B8FA8 Regular
- 分隔符填充颜色为#B1B4C5,整体面包屑行高(文本行高)20px

## 何时使用

- 当系统拥有超过两级以上的层级结构时;
- 当需要告知用户『你在哪里』时;
- 当需要向上导航的功能时。
- 当需要向上导航的功能时。
4 changes: 3 additions & 1 deletion components/button/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ subtitle: 按钮

## 设计规范

按钮圆角半径统一为4px(常规尺寸)和2px(小尺寸),文字大小12px,左右上下居中对齐,左右间距固定16px(常规尺寸)和8px(小尺寸),宽度随着文字的长度变化而变化,高度分为32px(常规尺寸)和24px(小尺寸)两种。
- 按钮圆角半径统一为 4px(常规尺寸)和 2px(小尺寸),文字大小 12px;
- 左右上下居中对齐,左右间距固定 16px(常规尺寸)和 8px(小尺寸);
- 宽度随着文字的长度变化而变化,高度分为 32px(常规尺寸)和 24px(小尺寸)两种;

## API

Expand Down
10 changes: 4 additions & 6 deletions components/card/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,12 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/NqXt8DJhky/Card.svg

## 设计规范

卡片式列表的标题字体16px #3D446E 居左 Medium,副标题文本字体12px #8B8FA8 居左 Regular ;

卡片背景填充#FFFFFF,边1px#EBECF0,圆角: 4px;

典型卡片边1px#EAF0FC,投影 0px 2px 30px 0px #EAECF4;
- 卡片式列表的标题字体 16px #3D446E 居左 Medium,副标题文本字体 12px #8B8FA8 居左 Regular;
- 卡片背景填充 #FFFFFF,边 1px#EBECF0,圆角 4px;
- 典型卡片边 1px/#EAF0FC,投影 0px 2px 30px 0px #EAECF4;

## API

|类名 |说明 |使用示例 |
|---------|---------|---------|
|.dt-card-shadow | 设置典型卡片的边框和投影 | 典型卡片 |
|.dt-card-shadow | 设置典型卡片的边框和投影 | 典型卡片 |
4 changes: 3 additions & 1 deletion components/checkbox/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ cols: 1

## 设计规范

- 复选框占位高度32px,上下间距6px,字体12px,行高20px,字体颜色#3D446E; 失效状态字体12px,字体颜色B1B4C5;
- 复选框占位高度32px,上下间距6px
- 字体12px,行高20px,字体颜色#3D446E;
- 失效状态字体12px,字体颜色B1B4C5;

## API

Expand Down
6 changes: 5 additions & 1 deletion components/collapse/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ cols: 1
用于将复杂的内容区域分组和隐藏,可折叠或展开,默认可以展开多个面板,也可以只展开某几个面板。

## 设计规范
单列面板默认高度40px,一级面板背景色#FFFFFF,边框颜色1px/#EBECF0,字体颜色14px/#3D446E;二级面板距离边缘40px,背景色#F9F9FA,边框颜色1px/#EBECF0,字体颜色14px/#3D446E;里层内容背景色#FFFFFF,边框颜色1px/#EBECF0;边缘线之间重叠;

- 单列面板默认高度 40px,一级面板背景色 #FFFFFF,边框颜色 1px/#EBECF0,字体颜色 14px/#3D446E;
- 二级面板距离边缘 40px,背景色 #F9F9FA,边框颜色 1px/#EBECF0,字体颜色 14px/#3D446E;
- 里层内容背景色 #FFFFFF,边框颜色 1px/#EBECF0;
- 边缘线之间重叠;

## API

Expand Down
8 changes: 4 additions & 4 deletions components/datepicker/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ title: DatePicker

## 设计规范

- 日期选择框常规高度为 32px ,小尺寸的高度为 24px ,边框颜色 #D8DAE2 , 填充色 #FFFFFF, 4px 圆角,提示字 12px,颜色 #B1B4C5 ,输入颜色 #3D446E ;
- hover状态边框颜色 #1D78FF ;
- 点击状态边框颜色 #005CE6,下划线 #005CE6,2px ;
- 禁用状态底色 #EBECF0,文字 #B1B4C5 ;
- 日期选择框常规高度为 32px小尺寸的高度为 24px边框颜色 #D8DAE2填充色 #FFFFFF,4px 圆角,提示字 12px,颜色 #B1B4C5输入颜色 #3D446E;
- hover状态边框颜色 #1D78FF
- 点击状态边框颜色 #005CE6,下划线 #005CE6,2px
- 禁用状态底色 #EBECF0,文字 #B1B4C5

## API

Expand Down
2 changes: 1 addition & 1 deletion components/dropdown/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ subtitle: 下拉菜单

## 设计规范

上下间距8px;
- 上下间距8px;

## 何时使用

Expand Down
9 changes: 5 additions & 4 deletions components/input-number/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ title: InputNumber

## 设计规范

默认宽度100px,边框颜色#D8DAE2,4px圆角;hover 状态边框颜色#1D78FF;点击状态边框颜色#005CE6;

前后缀单位背景#F9F9FA,边框#D8DAE2,左右边距16px,字体12px/#3D446E居中,默认宽度208px;
- 默认宽度 100px,边框颜色 #D8DAE2,4px 圆角;
- hover 状态边框颜色 #1D78FF;
- 点击状态边框颜色 #005CE6;
- 前后缀单位背景 #F9F9FA,边框 #D8DAE2,左右边距 16px,字体 12px/#3D446E 居中,默认宽度 208px;

## 何时使用

Expand All @@ -21,4 +22,4 @@ title: InputNumber

|类名 |说明 |使用示例 |
|---------|---------|---------|
|.dt-input-number-disabled | 禁用状态的颜色 | 禁用状态 |
|.dt-input-number-disabled | 禁用状态的颜色 | 禁用状态 |
10 changes: 8 additions & 2 deletions components/input/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ title: Input

#### 默认主题

输入框常规高度为 32px,小尺寸的高度为 24px,边框颜色#D8DAE2,填充色#FFFFFF,4px 圆角; 提示文字 12px,颜色#B1B4C5,输入颜色#3D446E;hover 状态边框颜色#1D78FF;点击状态边框颜色#005CE6;禁用状态底色#EBECF0,文字#B1B4C5;错误样式边框颜色#F96C5B;
- 输入框常规高度为 32px,小尺寸的高度为 24px,边框颜色#D8DAE2,填充色#FFFFFF,4px 圆角;
- 提示文字 12px,颜色 #B1B4C5,输入颜色 #3D446E;
- hover 状态边框颜色#1D78FF;
- 点击状态边框颜色 #005CE6;
- 禁用状态底色 #EBECF0,文字 #B1B4C5;
- 错误样式边框颜色 #F96C5B;

#### 暗黑主题

输入框常规高度为 32px ,小尺寸的高度为 28px ,边框颜色 #2C3047 , 4px 圆角,提示字颜色 #666666 ,输入颜色 #BFBFBF ,宽度根据具体情况而定。
- 输入框常规高度为 32px,小尺寸的高度为 28px,边框颜色 #2C3047,4px 圆角,宽度根据具体情况而定;
- 提示字颜色 #666666,输入颜色 #BFBFBF;

## API

Expand Down
9 changes: 4 additions & 5 deletions components/notification/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,10 @@ title: Notification

## 设计规范

弹窗标题字体 14px/#3D446E/居左 Medium,副文本内容 12/#8B8FA8/居左/Regular;提醒框在内容的基础上留有适当的边距,建议左右边距为 16px,上下边距 16px;

背景#FFFFFF,投影#3D446E 20%,Y5px,模糊度 22

注意: 通知弹窗的宽度 360px。默认 4.5 秒后自动关闭
- 弹窗标题字体 14px/#3D446E/居左 Medium,副文本内容 12/#8B8FA8/居左/Regular;
- 提醒框在内容的基础上留有适当的边距,建议左右边距为 16px,上下边距 16px;
- 背景#FFFFFF,投影#3D446E 20%,Y5px,模糊度 22;
- 注意: 通知弹窗的宽度 360px。默认 4.5 秒后自动关闭

## 何时使用

Expand Down
3 changes: 2 additions & 1 deletion components/pagination/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ cols: 1

## 设计规范

最多显示 5 页内容,当数量多时默认显示前 5 页以及最后 1 页。若选中的是中间的页数,则除了固定显示第 1 页和最后 1 页之外,显示以选中的页数为中间数,向前和向后各 2 页。
- 最多显示 5 页内容,当数量多时默认显示前 5 页以及最后 1 页;
- 若选中的是中间的页数,则除了固定显示第 1 页和最后 1 页之外,显示已选中的页数为中间数,向前和向后各 2 页;

## API

Expand Down
9 changes: 6 additions & 3 deletions components/popover/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ title: Popover
-点击/鼠标移入元素,弹出气泡式的卡片浮层。

## 设计规范
标题字体大小14px,Medium,字体颜色#3D446E;辅助文本12px,字体颜色#8B8FA8;气泡框在内容的基础上留有适当的边距,建议左右边距为16px,上下边距16px;
气泡提示默认280,最长宽度为 400px。同一业务内建议采用统一的尺寸。
背景#FFFFFF,投影#3D446E 20%,Y5px,模糊度22;

- 标题字体大小 14px,Medium,字体颜色 #3D446E;
- 辅助文本 12px,字体颜色 #8B8FA8;
- 气泡框在内容的基础上留有适当的边距,建议左右边距为 16px,上下边距 16px;
- 气泡提示默认 280,最长宽度为 400px。同一业务内建议采用统一的尺寸;
- 背景 #FFFFFF,投影 #3D446E 20%,Y5px,模糊度 22;


## 何时使用
Expand Down
3 changes: 2 additions & 1 deletion components/select/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ title: Select

#### 暗黑主题

下拉框常规高度为 32px,小尺寸的高度为 24px ,边框颜色 #2C3047 , 4px 圆角,提示字颜色 #666666 ,输入颜色 #BFBFBF ,宽度根据具体情况而定。
- 下拉框常规高度为 32px,小尺寸的高度为 24px,边框颜色 #2C3047,4px 圆角,宽度根据具体情况而定;
- 提示字颜色 #666666,输入颜色 #BFBFBF;

## API

Expand Down
8 changes: 6 additions & 2 deletions components/steps/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,13 @@ subtitle: 标准导航步骤页

## 设计规范

标准导航步骤页分为步骤条头部、内容区域、尾部操作栏。
标准导航步骤页分为步骤条头部、内容区域、尾部操作栏。其中:

其中,步骤条头部未处理流程底颜色为 `#EEEEEE`,正在处理流程底颜色为 `#3F87FF`,已处理流程底颜色为 `#FFFFFF`,内容区域和尾部操作栏底颜色 `#FAFAFA`,尾部操作栏高度为 56 px。
- 步骤条头部未处理流程底颜色为 `#EEEEEE`
- 正在处理流程底颜色为 `#3F87FF`
- 已处理流程底颜色为 `#FFFFFF`
- 内容区域和尾部操作栏底颜色 `#FAFAFA`
- 尾部操作栏高度为 56 px。

## API

Expand Down
2 changes: 1 addition & 1 deletion components/tab/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ cover: https://gw.alipayobjects.com/zos/antfincdn/lkI2hNEDr2V/Tabs.svg

## 设计规范

每个标签文字最多 6 个字,标签数量最多 7 个,建议出现 4 个以内。
- 每个标签文字最多 6 个字,标签数量最多 7 个,建议出现 4 个以内。

## API

Expand Down
5 changes: 4 additions & 1 deletion components/tag/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ cols: 1

用于标记事物的属性和维度

边框#EBECF0,底色#F9F9FA,字号 12px,字体颜色#3D446E

## 设计规范

- 边框 #EBECF0,底色 #F9F9FA,字号 12px,字体颜色 #3D446E;


## API
Expand Down
3 changes: 2 additions & 1 deletion components/timepicker/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ title: TimePicker

## 设计规范

时间选择框常规高度为 32px ,小尺寸的高度为 24px ,边框颜色 #D8DAE2 , 4px 圆角,提示字颜色 #B1B4C5 ,输入颜色 #3D446E ,宽度根据具体情况而定。
- 时间选择框常规高度为 32px,小尺寸的高度为 24px,边框颜色 #D8DAE2,4px 圆角,宽度根据具体情况而定;
- 提示字颜色 #B1B4C5,输入颜色 #3D446E;

## API

Expand Down
9 changes: 6 additions & 3 deletions components/tooltip/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ cover: https://gw.alipayobjects.com/zos/alicdn/Vyyeu8jq2/Tooltp.svg
鼠标悬停、聚焦或点击在某个组件时,弹出的文字提示。

## 设计规范
字体大小 12px,字体颜色#FFFFFF;提示框在内容的基础上留有适当的边距,建议左右边距为 8px,单行高度默认为 32px,上下边距 6px;同一业务内建议采用统一的尺寸。
底色#000000,75%;

- 字体大小 12px,字体颜色 #FFFFFF;
- 提示框在内容的基础上留有适当的边距,建议左右边距为 8px,单行高度默认为 32px,上下边距 6px;
- 底色 #000000,75%;
- 同一业务内建议采用统一的尺寸;

## 何时使用

Expand All @@ -20,4 +23,4 @@ cover: https://gw.alipayobjects.com/zos/alicdn/Vyyeu8jq2/Tooltp.svg

注意:
- 不要将完成任务所需的重要信息放在文字气泡内,重要的信息不应隐藏,应当始终直接展示在页面中;
- 文字气泡不应承载可交互的操作信息。当需要展示操作时,可考虑使用气泡卡片。
- 文字气泡不应承载可交互的操作信息。当需要展示操作时,可考虑使用气泡卡片。
3 changes: 2 additions & 1 deletion components/tree/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ subtitle: 树形控件

## 何时使用

文件夹、组织架构、生物分类、国家地区等等,世间万物的大多数结构都是树形结构。使用 `树控件` 可以完整展现其中的层级关系,并具有展开收起选择等交互功能。
- 文件夹、组织架构、生物分类、国家地区等等,世间万物的大多数结构都是树形结构;
- 使用 `树控件` 可以完整展现其中的层级关系,并具有展开收起选择等交互功能;
3 changes: 2 additions & 1 deletion components/treeselect/index.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ title: TreeSelect

## 设计规范

树型选择控件。常规高度为 32px ,小尺寸的高度为 24px ,边框颜色 #D8DAE2 , 4px 圆角,提示字颜色 #B1B4C5 ,输入颜色 #3D446E ,宽度根据具体情况而定。
- 树型选择控件。常规高度为 32px,小尺寸的高度为 24px,边框颜色 #D8DAE2,4px 圆角,宽度根据具体情况而定;
- 提示字颜色 #B1B4C5,输入颜色 #3D446E;

## API

Expand Down
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,8 @@
},
"publishConfig": {
"registry": "https://registry.npmjs.org/"
},
"engines": {
"node": "<=16"
}
}

0 comments on commit 1bef077

Please sign in to comment.