Skip to content

Commit 6fb6898

Browse files
authored
docs: correct docs mistakes (#3018)
* docs: correct docs mistakes * chore: correct some docs content * chore: correct some docs content * chore: update docs
1 parent 321b549 commit 6fb6898

File tree

10 files changed

+19
-19
lines changed

10 files changed

+19
-19
lines changed

src/packages/space/doc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ import { Space } from '@nutui/nutui-react'
7575

7676
### 样式变量
7777

78-
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](/components/config-provider)
78+
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/component/configprovider)
7979

8080
| 名称 | 默认值 | 描述 |
8181
| --- | --- | --- |

src/packages/space/doc.taro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ import { Space } from '@nutui/nutui-react-taro'
7575

7676
### 样式变量
7777

78-
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](/components/config-provider)
78+
组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/component/configprovider)
7979

8080
| 名称 | 默认值 | 描述 |
8181
| --- | --- | --- |

src/packages/tour/doc.en-US.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ import { Tour } from '@nutui/nutui-react'
6262
| type | Tour type | `step` \| `tile` | `step` |
6363
| list | Boot Step Content | `TourList[]` | `-` |
6464
| offset | The offset of the hollow mask relative to the target element | `number[]` | `[8, 10]` |
65-
| location | Location of popover[location](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `string` | `bottom` |
65+
| location | Location of popover[location](#/zh-CN/component/popover) | `string` | `bottom` |
6666
| next | Next step text | `ReactNode` | `''` |
6767
| prev | Next step text | `ReactNode` | `''` |
6868
| complete | Complete text | `ReactNode` | `''` |
6969
| mask | Whether to display cutout mask | `boolean` | `true` |
7070
| maskWidth | Width of hollow mask | `number` \| `string` | `''` |
7171
| maskHeight | Hollow mask height | `number` \| `string` | `''` |
72-
| closeOnOverlayClick | Whether to close when clicking overlay,[closeOnClickOverlay](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `boolean` | `true` |
72+
| closeOnOverlayClick | Whether to close when clicking overlay,[closeOnClickOverlay](#/en-US/component/popover) | `boolean` | `true` |
7373
| showPrev | Whether to show prev button | `boolean` | `true` |
7474
| title | Whether to show title bar | `ReactNode` | `''` |
7575
| onClose | Emit when popover close | `(e: MouseEvent<HTMLDivElement>) => void` | `-` |

src/packages/tour/doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ import { Tour } from '@nutui/nutui-react'
6262
| type | 引导类型 | `step` \| `tile` | `step` |
6363
| list | 引导步骤内容 | `TourList[]` | `-` |
6464
| offset | 镂空遮罩相对于目标元素的偏移量 | `number[]` | `[8, 10]` |
65-
| location | 弹出层位置,同 Popopver 的[location 属性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `string` | `bottom` |
65+
| location | 弹出层位置,同 Popopver 的[location 属性](#/zh-CN/component/popover) | `string` | `bottom` |
6666
| next | 下一步按钮文案 | `ReactNode` | `''` |
6767
| prev | 上一步按钮文案 | `ReactNode` | `''` |
6868
| complete | 完成按钮文案 | `ReactNode` | `''` |
6969
| mask | 是否显示镂空遮罩 | `boolean` | `true` |
7070
| maskWidth | 镂空遮罩层宽度 | `number` \| `string` | `''` |
7171
| maskHeight | 镂空遮罩层高度 | `number` \| `string` | `''` |
72-
| closeOnOverlayClick | 是否在点击镂空遮罩层后关闭,同 Popopver 的[closeOnClickOverlay 属性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `boolean` | `true` |
72+
| closeOnOverlayClick | 是否在点击镂空遮罩层后关闭,同 Popopver 的[closeOnClickOverlay 属性](#/zh-CN/component/popover) | `boolean` | `true` |
7373
| showPrev | 是否展示上一步按钮 | `boolean` | `true` |
7474
| title | 是否展示标题栏 | `ReactNode` | `''` |
7575
| onClose | 气泡层关闭时触发 | `(e: MouseEvent<HTMLDivElement>) => void` | `-` |

src/packages/tour/doc.taro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ import { Tour } from '@nutui/nutui-react-taro'
6262
| type | 引导类型 | `step` \| `tile` | `step` |
6363
| list | 引导步骤内容 | `TourList[]` | `-` |
6464
| offset | 镂空遮罩相对于目标元素的偏移量 | `number[]` | `[8, 10]` |
65-
| location | 弹出层位置,同 Popopver 的[location 属性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `string` | `bottom` |
65+
| location | 弹出层位置,同 Popopver 的[location 属性](#/zh-CN/component/popover) | `string` | `bottom` |
6666
| next | 下一步按钮文案 | `ReactNode` | `''` |
6767
| prev | 上一步按钮文案 | `ReactNode` | `''` |
6868
| complete | 完成按钮文案 | `ReactNode` | `''` |
6969
| mask | 是否显示镂空遮罩 | `boolean` | `true` |
7070
| maskWidth | 镂空遮罩层宽度 | `number` \| `string` | `''` |
7171
| maskHeight | 镂空遮罩层高度 | `number` \| `string` | `''` |
72-
| closeOnOverlayClick | 是否在点击镂空遮罩层后关闭,同 Popopver 的[closeOnClickOverlay 属性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `boolean` | `true` |
72+
| closeOnOverlayClick | 是否在点击镂空遮罩层后关闭,同 Popopver 的[closeOnClickOverlay 属性](#/zh-CN/component/popover) | `boolean` | `true` |
7373
| showPrev | 是否展示上一步按钮 | `boolean` | `true` |
7474
| title | 是否展示标题栏 | `ReactNode` | `''` |
7575
| onClose | 气泡层关闭时触发 | `(e: MouseEvent<HTMLDivElement>) => void` | `-` |

src/packages/tour/doc.zh-TW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ import { Tour } from '@nutui/nutui-react'
6262
| type | 引導類型 | `step` \| `tile` | `step` |
6363
| list | 引導步驟內容 | `TourList[]` | `-` |
6464
| offset | 鏤空遮罩相對於目標元素的偏移量 | `number[]` | `[8, 10]` |
65-
| location | 彈出層位置,同 Popopver 的[location 屬性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `string` | `bottom` |
65+
| location | 彈出層位置,同 Popopver 的[location 屬性](#/zh-CN/component/popover) | `string` | `bottom` |
6666
| next | 下一步按鈕文案 | `ReactNode` | `''` |
6767
| prev | 上一步按鈕文案 | `ReactNode` | `''` |
6868
| complete | 完成按鈕文案 | `ReactNode` | `''` |
6969
| mask | 是否顯示鏤空遮罩 | `boolean` | `true` |
7070
| maskWidth | 鏤空遮罩層寬度 | `number` \| `string` | `''` |
7171
| maskHeight | 鏤空遮罩層高度 | `number` \| `string` | `''` |
72-
| closeOnOverlayClick | 是否在點擊鏤空遮罩層後關閉,同 Popopver 的[closeOnClickOverlay 屬性](https://nutui.jd.com/h5/react/2x/#/zh-CN/component/popover) | `boolean` | `true` |
72+
| closeOnOverlayClick | 是否在點擊鏤空遮罩層後關閉,同 Popopver 的[closeOnClickOverlay 屬性](#/zh-CN/component/popover) | `boolean` | `true` |
7373
| showPrev | 是否展示上一步按鈕 | `boolean` | `true` |
7474
| title | 是否展示標題欄 | `ReactNode` | `''` |
7575
| onClose | 氣泡層關閉時觸發 | `(e: MouseEvent<HTMLDivElement>) => void` | `-` |

src/packages/uploader/doc.en-US.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,8 @@ import { Uploader } from '@nutui/nutui-react'
107107
| maxCount | File upload count limit | `number` \| `string` | `1` |
108108
| fit | Picture fill mode | `contain` \| `cover` \| `fill` \| `none` \| `scale-down` | `cover` |
109109
| clearInput | If or not you want to clear the `input` content, set it to `true` to support selecting the same file to upload over and over again | `boolean` | `true` |
110-
| accept | Allowed file types to be uploaded, [Details] ("<https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%> B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B") | `string` | `*` |
111-
| uploadIcon | uploadRegion <a href=“#/zh-CN/icon>Icon Name</a> | `React.ReactNode` | `-` |
110+
| accept | Allowed file types to be uploaded, [Details] (https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B) | `string` | `*` |
111+
| uploadIcon | uploadRegion <a href="#/en-US/component/icon">Icon Name</a> | `React.ReactNode` | `-` |
112112
| deleteIcon | Delete the icon name of the region | `React.ReactNode` | `-` |
113113
| uploadLabel | Text below the image in the upload area | `React.
114114
| multiple | Whether to support file multi-selection |`boolean`|`false`|

src/packages/uploader/doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ import { Uploader } from '@nutui/nutui-react'
111111
| maxCount | 文件上传数量限制 | `number` \| `string` | `1` |
112112
| fit | 图片填充模式 | `contain` \| `cover` \| `fill` \| `none` \| `scale-down` | `cover` |
113113
| clearInput | 是否需要清空`input`内容,设为`true`支持重复选择上传同一个文件 | `boolean` | `true` |
114-
| accept | 允许上传的文件类型,[详细说明]("https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B") | `string` | `*` |
115-
| uploadIcon | 上传区域<a href="#/zh-CN/icon">图标名称</a> | `React.ReactNode` | `-` |
114+
| accept | 允许上传的文件类型,[详细说明](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B) | `string` | `*` |
115+
| uploadIcon | 上传区域<a href="#/zh-CN/component/icon">图标名称</a> | `React.ReactNode` | `-` |
116116
| deleteIcon | 删除区域的图标名称 | `React.ReactNode` | `-` |
117117
| uploadLabel | 上传区域图片下方文字 | `React.ReactNode` | `-` |
118118
| multiple | 是否支持文件多选 | `boolean` | `false` |

src/packages/uploader/doc.taro.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ import { Uploader } from '@nutui/nutui-react-taro'
102102
| maxCount | 文件上传数量限制 | `number` \| `string` | `1` |
103103
| fit | 图片填充模式 | `contain` \| `cover` \| `fill` \| `none` \| `scale-down` | `cover` |
104104
| clearInput | 是否需要清空`input`内容,设为`true`支持重复选择上传同一个文件 | `boolean` | `true` |
105-
| uploadIcon | 上传区域<a href="#/zh-CN/icon">图标名称</a> | `React.ReactNode` | `-` |
105+
| uploadIcon | 上传区域<a href="#/zh-CN/component/icon">图标名称</a> | `React.ReactNode` | `-` |
106106
| deleteIcon | 删除区域的图标名称 | `React.ReactNode` | `-` |
107107
| uploadLabel | 上传区域图片下方文字 | `React.ReactNode` | `-` |
108108
| multiple | 是否支持文件多选 | `boolean` | `false` |
@@ -117,8 +117,8 @@ import { Uploader } from '@nutui/nutui-react-taro'
117117
| onUploadQueueChange | 图片上传队列变化时触发 | `(tasks: FileItem[]) => void` | `-` |
118118
| sourceType | [选择文件的来源]("https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html") | `Array` | `['album','camera']` |
119119
| camera`仅支持WEAPP` | 仅在 `source-type``camera` 时生效,使用前置或后置摄像头 | `String` | `back` |
120-
| sizeType | [是否压缩所选文件]("https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html") | `Array` | `['original','compressed']` |
121-
| mediaType`仅支持WEAPP` | [选择文件类型]("https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html") | `Array` | `['image', 'video', 'mix']` |
120+
| sizeType | [是否压缩所选文件](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html) | `Array` | `['original','compressed']` |
121+
| mediaType`仅支持WEAPP` | [选择文件类型](https://developers.weixin.qq.com/miniprogram/dev/api/media/video/wx.chooseMedia.html) | `Array` | `['image', 'video', 'mix']` |
122122
| maxDuration`仅支持WEAPP` | 拍摄视频最长拍摄时间,单位秒。时间范围为 3s 至 60s 之间。不限制相册。 | `number` | `10` |
123123

124124
### FileItem

src/packages/uploader/doc.zh-TW.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ import { Uploader } from '@nutui/nutui-react'
111111
| maxCount | 文件上傳數量限製 | `number` \| `string` | `1` |
112112
| fit | 圖片填充模式 | `contain` \| `cover` \| `fill` \| `none` \| `scale-down` | `cover` |
113113
| clearInput | 是否需要清空`input`內容,設為`true`支持重復選擇上傳同一個文件 | `boolean` | `true` |
114-
| accept | 允許上傳的文件類型,[詳細說明]("https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B") | `string` | `*` |
115-
| uploadIcon | 上傳區域<a href="#/zh-CN/icon">圖標名稱</a> | `React.ReactNode` | `-` |
114+
| accept | 允許上傳的文件類型,[詳細說明](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/Input/file#%E9%99%90%E5%88%B6%E5%85%81%E8%AE%B8%E7%9A%84%E6%96%87%E4%BB%B6%E7%B1%BB%E5%9E%8B) | `string` | `*` |
115+
| uploadIcon | 上傳區域<a href="#/zh-CN/component/icon">圖標名稱</a> | `React.ReactNode` | `-` |
116116
| deleteIcon | 刪除區域的圖標名稱 | `React.ReactNode` | `-` |
117117
| uploadLabel | 上傳區域圖片下方文字 | `React.ReactNode` | `-` |
118118
| multiple | 是否支持文件多選 | `boolean` | `false` |

0 commit comments

Comments
 (0)