Skip to content

Commit 208b8d3

Browse files
FungYuuFungYuu
authored
docs: unify the default value of none to - (#7636)
1 parent f41fec2 commit 208b8d3

File tree

11 files changed

+44
-44
lines changed

11 files changed

+44
-44
lines changed

‎components/calendar/index.zh-CN.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -28,25 +28,25 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*-p-wQLik200AAA
2828

2929
| 参数 | 说明 | 类型 | 默认值 | 版本 |
3030
| --- | --- | --- | --- | --- |
31-
| dateCellRender | 作用域插槽，用来自定义渲染日期单元格，返回内容会被追加到单元格, | v-slot:dateCellRender="{current: dayjs}" | 无 | |
32-
| dateFullCellRender | 作用域插槽，自定义渲染日期单元格，返回内容覆盖单元格 | v-slot:dateFullCellRender="{current: dayjs}" | 无 | |
33-
| disabledDate | 不可选择的日期 | (currentDate: dayjs) => boolean | 无 | |
31+
| dateCellRender | 作用域插槽，用来自定义渲染日期单元格，返回内容会被追加到单元格, | v-slot:dateCellRender="{current: dayjs}" | - | |
32+
| dateFullCellRender | 作用域插槽，自定义渲染日期单元格，返回内容覆盖单元格 | v-slot:dateFullCellRender="{current: dayjs}" | - | |
33+
| disabledDate | 不可选择的日期 | (currentDate: dayjs) => boolean | - | |
3434
| fullscreen | 是否全屏显示 | boolean | true | |
3535
| headerRender | 自定义头部内容 | v-slot:headerRender="{value: dayjs, type: string, onChange: f(), onTypeChange: f()}" | - | |
3636
| locale | 国际化配置 | object | [默认配置](https://github.com/vueComponent/ant-design-vue/blob/main/components/date-picker/locale/example.json) | |
3737
| mode | 初始模式，`month/year` | string | month | |
38-
| monthCellRender | 作用域插槽，自定义渲染月单元格，返回内容会被追加到单元格 | v-slot:monthCellRender="{current: dayjs}" | 无 | |
39-
| monthFullCellRender | 作用域插槽，自定义渲染月单元格，返回内容覆盖单元格 | v-slot:monthFullCellRender="{current: dayjs}" | 无 | |
40-
| validRange | 设置可以显示的日期 | \[[dayjs](https://day.js.org/), [dayjs](https://day.js.org/)] | 无 | |
38+
| monthCellRender | 作用域插槽，自定义渲染月单元格，返回内容会被追加到单元格 | v-slot:monthCellRender="{current: dayjs}" | - | |
39+
| monthFullCellRender | 作用域插槽，自定义渲染月单元格，返回内容覆盖单元格 | v-slot:monthFullCellRender="{current: dayjs}" | - | |
40+
| validRange | 设置可以显示的日期 | \[[dayjs](https://day.js.org/), [dayjs](https://day.js.org/)] | - | |
4141
| value(v-model) | 展示日期 | [dayjs](https://day.js.org/) | 当前日期 | |
4242
| valueFormat | 可选，绑定值的格式，对 value、defaultValue 起作用。不指定则绑定值为 dayjs 对象 | string，[具体格式](https://day.js.org/docs/zh-CN/display/format) | - | |
4343

4444
### 事件
4545

4646
| 事件名称 | 说明 | 回调参数 | |
4747
| --- | --- | --- | --- | --- |
48-
| change | 日期变化时的回调, 面板变化有可能导致日期变化 | function(date: dayjs \| string） | 无 |
49-
| panelChange | 日期面板变化回调 | function(date: dayjs \| string, mode: string) | 无 |
48+
| change | 日期变化时的回调, 面板变化有可能导致日期变化 | function(date: dayjs \| string） | - |
49+
| panelChange | 日期面板变化回调 | function(date: dayjs \| string, mode: string) | - |
5050
| select | 选择日期回调，包含来源信息 | function(date: Dayjs, info: { source: 'year' \| 'month' \| 'date' \| 'customize' }) | - | |
5151

5252
### 如何仅获取来自面板点击的日期？

‎components/collapse/index.zh-CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,6 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*sir-TK0HkWcAAA
4242
| collapsible | 是否可折叠或指定可折叠触发区域 | `header` \| `disabled` | - | 3.0 |
4343
| extra | 自定义渲染每个面板右上角的内容 | VNode \| slot | - | 1.5.0 |
4444
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false | |
45-
| header | 面板头内容 | string\|slot | 无 | |
46-
| key | 对应 activeKey | string \| number | 无 | |
45+
| header | 面板头内容 | string\|slot | - | |
46+
| key | 对应 activeKey | string \| number | - | |
4747
| showArrow | 是否展示当前面板上的箭头 | boolean | `true` | |

‎components/dropdown/index.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5qm4S4Zgh2QAAA
2222

2323
| 参数 | 说明 | 类型 | 默认值 | |
2424
| --- | --- | --- | --- | --- |
25-
| align | 该值将合并到 placement 的配置中，设置参考 [dom-align](https://github.com/yiminghe/dom-align) | Object | 无 | |
25+
| align | 该值将合并到 placement 的配置中，设置参考 [dom-align](https://github.com/yiminghe/dom-align) | Object | - | |
2626
| arrow | 下拉框箭头是否显示 | boolean \| { pointAtCenter: boolean } | false | 3.3.0 |
2727
| destroyPopupOnHide | 关闭后是否销毁 Dropdown | boolean | false | 3.0 |
2828
| disabled | 菜单是否禁用 | boolean | - | |

‎components/input-number/index.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*1uH-R5kLAMIAAA
3434
| parser | 指定从 formatter 里转换回数字的方式，和 formatter 搭配使用 | function( string): number | - | |
3535
| precision | 数值精度 | number | - | |
3636
| prefix | 带有前缀图标的 input | slot | - | 3.0 |
37-
| size | 输入框大小 | string | 无 | |
37+
| size | 输入框大小 | string | - | |
3838
| status | 设置校验状态 | 'error' \| 'warning' | - | 3.3.0 |
3939
| step | 每次改变步数，可以为小数 | number\|string | 1 | |
4040
| stringMode | 字符值模式，开启后支持高精度小数。同时 `change` 事件将返回 string 类型 | boolean | false | 3.0 |

‎components/modal/index.zh-CN.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fBrgSJBmavgAAA
1919

2020
| 参数 | 说明 | 类型 | 默认值 | 版本 |
2121
| --- | --- | --- | --- | --- |
22-
| afterClose | Modal 完全关闭后的回调 | function | 无 | |
22+
| afterClose | Modal 完全关闭后的回调 | function | - | |
2323
| bodyStyle | Modal body 样式 | object | {} | |
2424
| cancelButtonProps | cancel 按钮 props | [ButtonProps](/components/button/#api) | - | |
2525
| cancelText | 取消按钮文字 | string\| slot | 取消 | |
2626
| centered | 垂直居中展示 Modal | boolean | `false` | |
2727
| closable | 是否显示右上角的关闭按钮 | boolean | true | |
2828
| closeIcon | 自定义关闭图标 | VNode \| slot | - | |
29-
| confirmLoading | 确定按钮 loading | boolean | 无 | |
29+
| confirmLoading | 确定按钮 loading | boolean | - | |
3030
| destroyOnClose | 关闭时销毁 Modal 里的子元素 | boolean | false | |
3131
| footer | 底部内容，当不需要默认底部按钮时，可以设为 `:footer="null"` | string\|slot | 确定取消按钮 | |
3232
| forceRender | 强制渲染 Modal | boolean | false | |
@@ -38,8 +38,8 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fBrgSJBmavgAAA
3838
| okButtonProps | ok 按钮 props | [ButtonProps](/components/button/#api) | - | |
3939
| okText | 确认按钮文字 | string\|slot | 确定 | |
4040
| okType | 确认按钮类型 | string | primary | |
41-
| title | 标题 | string\|slot | 无 | |
42-
| open(v-model) | 对话框是否可见 | boolean | 无 | |
41+
| title | 标题 | string\|slot | - | |
42+
| open(v-model) | 对话框是否可见 | boolean | - | |
4343
| width | 宽度 | string\|number | 520 | |
4444
| wrapClassName | 对话框外层容器的类名 | string | - | |
4545
| zIndex | 设置 Modal 的 `z-index` | number | 1000 | |
@@ -76,7 +76,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fBrgSJBmavgAAA
7676
| centered | 垂直居中展示 Modal | boolean | `false` | |
7777
| class | 容器类名 | string | - | |
7878
| closable | 是否显示右上角的关闭按钮 | boolean | `false` | |
79-
| content | 内容 | string \|VNode \|function() | 无 | |
79+
| content | 内容 | string \|VNode \|function() | - | |
8080
| footer | 底部内容，当不需要默认底部按钮时，可以设为 `footer: null` | string \|VNode \|function() | - | 4.0.0 |
8181
| icon | 自定义图标（1.14.0 新增） | VNode \| ()=>VNode | - | |
8282
| keyboard | 是否支持键盘 esc 关闭 | boolean | true | |
@@ -85,12 +85,12 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fBrgSJBmavgAAA
8585
| okButtonProps | ok 按钮 props | [ButtonProps](/components/button) | - | |
8686
| okText | 确认按钮文字 | string | 确定 | |
8787
| okType | 确认按钮类型 | string | primary | |
88-
| title | 标题 | string\|VNode \|function() | 无 | |
88+
| title | 标题 | string\|VNode \|function() | - | |
8989
| width | 宽度 | string\|number | 416 | |
9090
| wrapClassName | 对话框外层容器的类名 | string | - | 3.2.3 |
9191
| zIndex | 设置 Modal 的 `z-index` | number | 1000 | |
92-
| onCancel | 取消回调，参数为关闭函数，返回 promise 时 resolve 后自动关闭 | function | 无 | |
93-
| onOk | 点击确定回调，参数为关闭函数，返回 promise 时 resolve 后自动关闭 | function | 无 | |
92+
| onCancel | 取消回调，参数为关闭函数，返回 promise 时 resolve 后自动关闭 | function | - | |
93+
| onOk | 点击确定回调，参数为关闭函数，返回 promise 时 resolve 后自动关闭 | function | - | |
9494

9595
以上函数调用后，会返回一个引用，可以通过该引用更新和关闭弹窗。
9696

‎components/popconfirm/index.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*HrFtQ6jJJFQAAA
2727
| okText | 确认按钮文字 | string\|slot | 确定 | |
2828
| okType | 确认按钮类型 | string | primary | |
2929
| showCancel | 是否显示取消按钮 | boolean | true | 3.0 |
30-
| title | 确认框的描述 | string\|slot | 无 | |
30+
| title | 确认框的描述 | string\|slot | - | |
3131
| description | 确认内容的详细描述 | string\|slot | - | 4.0 |
3232
| open (v-model) | 是否显示 | boolean | - | 4.0 |
3333

‎components/segmented/index.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ tag: New
2121

2222
| 参数 | 说明 | 类型 | 默认值 | 版本 |
2323
| --- | --- | --- | --- | --- |
24-
| block | 将宽度调整为父元素宽度的选项 | boolean | 无 | |
24+
| block | 将宽度调整为父元素宽度的选项 | boolean | - | |
2525
| disabled | 是否禁用 | boolean | false | |
2626
| options | 数据化配置选项内容 | string[] \| number[] \| SegmentedOption[] | [] | |
2727
| size | 控件尺寸 | `large` \| `middle` \| `small` | - | |

‎components/select/index.zh-CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*5oPiTqPxGAUAAA
111111
| 参数 | 说明 | 类型 | 默认值 |
112112
| ----- | ---- | ------------------------- | ------ |
113113
| key | | string | - |
114-
| label | 组名 | string\|function(h)\|slot | 无 |
114+
| label | 组名 | string\|function(h)\|slot | - |
115115

116116
## FAQ
117117

‎components/tabs/index.zh-CN.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ Ant Design 依次提供了三级选项卡，分别用于不同的场景。
2525

2626
| 参数 | 说明 | 类型 | 默认值 | 版本 | |
2727
| --- | --- | --- | --- | --- | --- |
28-
| activeKey(v-model) | 当前激活 tab 面板的 key | string | 无 | | |
28+
| activeKey(v-model) | 当前激活 tab 面板的 key | string | - | | |
2929
| animated | 是否使用动画切换 Tabs，在 tabPosition=`"top"` \| `"bottom"` 时有效 | boolean \| {inkBar:boolean, tabPane:boolean} | true, 当 type="card" 时为 false | |
3030
| centered | 标签居中展示 | boolean | false | 3.0 | |
3131
| destroyInactiveTabPane | 被隐藏时是否销毁 DOM 结构 | boolean | false | | |
3232
| hideAdd | 是否隐藏加号图标，在 `type="editable-card"` 时有效 | boolean | false | | |
3333
| size | 大小，提供 `large` `middle` 和 `small` 三种大小 | string | `middle` | | |
34-
| tabBarGutter | tabs 之间的间隙 | number | 无 | | |
34+
| tabBarGutter | tabs 之间的间隙 | number | - | | |
3535
| tabBarStyle | tab bar 的样式对象 | CSSProperties | - | | |
3636
| tabPosition | 页签位置，可选值有 `top` `right` `bottom` `left` | string | `top` | | |
3737
| type | 页签的基本样式，可选 `line`、`card` `editable-card` 类型 | string | `line` | | |
@@ -60,8 +60,8 @@ Ant Design 依次提供了三级选项卡，分别用于不同的场景。
6060
| 参数 | 说明 | 类型 | 默认值 |
6161
| ----------- | ------------------------- | ------------ | ------ |
6262
| forceRender | 被隐藏时是否渲染 DOM 结构 | boolean | false |
63-
| key | 对应 activeKey | string | 无 |
64-
| tab | 选项卡头显示文字 | string\|slot | 无 |
63+
| key | 对应 activeKey | string | - |
64+
| tab | 选项卡头显示文字 | string\|slot | - |
6565

6666
### Tabs.TabPane 插槽
6767

‎components/tooltip/index.zh-CN.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -18,26 +18,26 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*gwrhTozoTC4AAA
1818

1919
| 参数 | 说明 | 类型 | 默认值 |
2020
| ----- | -------- | ------------ | ------ |
21-
| title | 提示文字 | string\|slot | 无 |
21+
| title | 提示文字 | string\|slot | - |
2222

2323
### 共同的 API
2424

2525
以下 API 为 Tooltip、Popconfirm、Popover 共享的 API。
2626

2727
| 参数 | 说明 | 类型 | 默认值 | 版本 |
2828
| --- | --- | --- | --- | --- |
29-
| align | 该值将合并到 placement 的配置中，设置参考 [dom-align](https://github.com/yiminghe/dom-align) | Object | 无 | |
29+
| align | 该值将合并到 placement 的配置中，设置参考 [dom-align](https://github.com/yiminghe/dom-align) | Object | - | |
3030
| arrowPointAtCenter | 箭头是否指向目标元素中心 | boolean | `false` | |
3131
| arrow | 修改箭头的显示状态以及修改箭头是否指向目标元素中心 | boolean \| { pointAtCenter: boolean} | `true` | 4.2.0 |
3232
| autoAdjustOverflow | 气泡被遮挡时自动调整位置 | boolean | `true` | |
33-
| color | 背景颜色 | string | 无 | |
33+
| color | 背景颜色 | string | - | |
3434
| destroyTooltipOnHide | 隐藏后是否销毁 tooltip | boolean | false | |
3535
| getPopupContainer | 浮层渲染父节点，默认渲染到 body 上 | (triggerNode: HTMLElement) => HTMLElement | () => document.body | |
3636
| mouseEnterDelay | 鼠标移入后延时多少才显示 Tooltip，单位：秒 | number | 0.1 | |
3737
| mouseLeaveDelay | 鼠标移出后延时多少才隐藏 Tooltip，单位：秒 | number | 0.1 | |
38-
| overlayClassName | 卡片类名 | string | 无 | |
39-
| overlayStyle | 卡片样式 | object | 无 | |
40-
| overlayInnerStyle | 卡片内容区域样式 | object | 无 | 4.0 |
38+
| overlayClassName | 卡片类名 | string | - | |
39+
| overlayStyle | 卡片样式 | object | - | |
40+
| overlayInnerStyle | 卡片内容区域样式 | object | - | 4.0 |
4141
| placement | 气泡框位置，可选 `top` `left` `right` `bottom` `topLeft` `topRight` `bottomLeft` `bottomRight` `leftTop` `leftBottom` `rightTop` `rightBottom` | string | top | |
4242
| trigger | 触发行为，可选 `hover/focus/click/contextmenu` | string | hover | |
4343
| open(v-model) | 用于手动控制浮层显隐, 小于 4.0.0 使用 `visible` | boolean | false | 4.0 |

‎components/upload/index.zh-CN.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*l1nlSryXib8AAA
2121

2222
| 参数 | 说明 | 类型 | 默认值 | 版本 | |
2323
| --- | --- | --- | --- | --- | --- |
24-
| accept | 接受上传的文件类型, 详见 [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | 无 | | |
25-
| action | 上传的地址 | string\|(file) => `Promise` | 无 | | |
26-
| beforeUpload | 上传文件之前的钩子，参数为上传的文件，若返回 `false` 则停止上传。支持返回一个 Promise 对象，Promise 对象 reject 时则停止上传，resolve 时开始上传（ resolve 传入 `File` 或 `Blob` 对象则上传 resolve 传入对象）。 | (file, fileList) => `boolean` \| `Promise` | 无 | |
27-
| customRequest | 通过覆盖默认的上传行为，可以自定义自己的上传实现 | function | 无 | | |
28-
| data | 上传所需参数或返回上传参数的方法 | object\|(file) => object | 无 | | |
24+
| accept | 接受上传的文件类型, 详见 [input accept Attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) | string | - | | |
25+
| action | 上传的地址 | string\|(file) => `Promise` | - | | |
26+
| beforeUpload | 上传文件之前的钩子，参数为上传的文件，若返回 `false` 则停止上传。支持返回一个 Promise 对象，Promise 对象 reject 时则停止上传，resolve 时开始上传（ resolve 传入 `File` 或 `Blob` 对象则上传 resolve 传入对象）。 | (file, fileList) => `boolean` \| `Promise` | - | |
27+
| customRequest | 通过覆盖默认的上传行为，可以自定义自己的上传实现 | function | - | | |
28+
| data | 上传所需参数或返回上传参数的方法 | object\|(file) => object | - | | |
2929
| directory | 支持上传文件夹（[caniuse](https://caniuse.com/#feat=input-file-directory)） | boolean | false | 3.0 | |
3030
| disabled | 是否禁用 | boolean | - | | |
3131
| downloadIcon | 自定义下载 icon | v-slot:iconRender="{file: UploadFile}" | - | 3.0 | |
32-
| fileList | 已经上传的文件列表（受控） | object\[] | 无 | | |
33-
| headers | 设置上传的请求头部，IE10 以上有效 | object | 无 | | |
32+
| fileList | 已经上传的文件列表（受控） | object\[] | - | | |
33+
| headers | 设置上传的请求头部，IE10 以上有效 | object | - | | |
3434
| iconRender | 自定义显示 icon | v-slot:iconRender="{file: UploadFile, listType?: UploadListType}" | - | 3.0 | |
3535
| isImageUrl | 自定义缩略图是否使用 <img /> 标签进行显示 | (file: UploadFile) => boolean | - | 3.0 | |
3636
| itemRender | 自定义上传列表项 | v-slot:itemRender="{originNode: VNode, file: UploadFile, fileList: object\[], actions: { download: function, preview: function, remove: function }" | - | 3.0 | |
@@ -40,7 +40,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*l1nlSryXib8AAA
4040
| multiple | 是否支持多选文件，`ie10+` 支持。开启后按住 ctrl 可选择多个文件。 | boolean | false | | |
4141
| name | 发到后台的文件参数名 | string | `file` | | |
4242
| openFileDialogOnClick | 点击打开文件对话框 | boolean | true | 3.0 | |
43-
| previewFile | 自定义文件预览逻辑 | (file: File \| Blob) => Promise<dataURL: string> | 无 | 1.5.0 | |
43+
| previewFile | 自定义文件预览逻辑 | (file: File \| Blob) => Promise<dataURL: string> | - | 1.5.0 | |
4444
| previewIcon | 自定义预览 icon | v-slot:iconRender="{file: UploadFile}" | - | 3.0 | |
4545
| progress | 自定义进度条样式 | [ProgressProps](/components/progress/#api)（仅支持 `type="line"`） | { strokeWidth: 2, showInfo: false } | 3.0 | |
4646
| removeIcon | 自定义删除 icon | v-slot:iconRender="{file: UploadFile}" | - | 3.0 | |
@@ -52,11 +52,11 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*l1nlSryXib8AAA
5252

5353
| 事件名称 | 说明 | 回调参数 | 版本 | |
5454
| --- | --- | --- | --- | --- |
55-
| change | 上传文件改变时的状态，详见 [change](#change) | function | 无 | |
55+
| change | 上传文件改变时的状态，详见 [change](#change) | function | - | |
5656
| download | 点击下载文件时的回调，如果没有指定，则默认跳转到文件 url 对应的标签页。 | function(file): void | 跳转新标签页 | 1.5.0 |
5757
| drop | 当文件被拖入上传区域时执行的回调功能 | (event: DragEvent) => void | - | 3.0 |
58-
| preview | 点击文件链接或预览图标时的回调 | function(file) | 无 | |
59-
| reject | 拖拽文件不符合 accept 类型时的回调 | function(fileList) | 无 | |
58+
| preview | 点击文件链接或预览图标时的回调 | function(file) | - | |
59+
| reject | 拖拽文件不符合 accept 类型时的回调 | function(fileList) | - | |
6060
| remove   | 点击移除文件时的回调，返回值为 false 时不移除。支持返回一个 Promise 对象，Promise 对象 resolve(false) 或 reject 时不移除 | function(file): boolean \| Promise | -   | 3.0 |
6161

6262
### UploadFile

0 commit comments

Comments
 (0)