From 5ee64bf874f930d87ddd07baba0308c54c72e0a7 Mon Sep 17 00:00:00 2001 From: "Alex.huxiyang" <1872591453@qq.com> Date: Fri, 21 Jun 2024 14:20:36 +0800 Subject: [PATCH] =?UTF-8?q?chore:=20=E6=96=87=E6=A1=A3=E6=9C=AA=E6=9D=A5?= =?UTF-8?q?=E8=A7=84=E8=8C=83=20(#2373)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/packages/actionsheet/doc.en-US.md | 4 +- src/packages/actionsheet/doc.md | 6 +- src/packages/actionsheet/doc.taro.md | 202 ++++++++++----------- src/packages/actionsheet/doc.zh-TW.md | 6 +- src/packages/address/doc.en-US.md | 4 +- src/packages/address/doc.md | 5 +- src/packages/address/doc.taro.md | 5 +- src/packages/address/doc.zh-TW.md | 6 +- src/packages/animate/doc.en-US.md | 4 +- src/packages/animate/doc.md | 5 +- src/packages/animate/doc.taro.md | 5 +- src/packages/animate/doc.zh-TW.md | 6 +- src/packages/animatingnumbers/doc.en-US.md | 4 +- src/packages/animatingnumbers/doc.md | 5 +- src/packages/animatingnumbers/doc.taro.md | 5 +- src/packages/animatingnumbers/doc.zh-TW.md | 6 +- src/packages/audio/doc.en-US.md | 4 +- src/packages/audio/doc.md | 5 +- src/packages/audio/doc.taro.md | 5 +- src/packages/audio/doc.zh-TW.md | 6 +- src/packages/avatar/doc.en-US.md | 4 +- src/packages/avatar/doc.md | 5 +- src/packages/avatar/doc.taro.md | 5 +- src/packages/avatar/doc.zh-TW.md | 6 +- src/packages/avatarcropper/doc.md | 5 +- src/packages/avatarcropper/doc.taro.md | 5 +- src/packages/avatarcropper/doc.zh-TW.md | 6 +- src/packages/backtop/doc.en-US.md | 4 +- src/packages/backtop/doc.md | 5 +- src/packages/backtop/doc.taro.md | 5 +- src/packages/backtop/doc.zh-TW.md | 6 +- src/packages/badge/doc.en-US.md | 4 +- src/packages/badge/doc.md | 5 +- src/packages/badge/doc.taro.md | 5 +- src/packages/badge/doc.zh-TW.md | 6 +- src/packages/barrage/doc.en-US.md | 4 +- src/packages/barrage/doc.md | 5 +- src/packages/barrage/doc.taro.md | 5 +- src/packages/barrage/doc.zh-TW.md | 6 +- src/packages/button/doc.en-US.md | 4 +- src/packages/button/doc.md | 5 +- src/packages/button/doc.taro.md | 5 +- src/packages/button/doc.zh-TW.md | 6 +- src/packages/calendar/doc.en-US.md | 4 +- src/packages/calendar/doc.md | 5 +- src/packages/calendar/doc.taro.md | 5 +- src/packages/calendar/doc.zh-TW.md | 6 +- src/packages/calendarcard/doc.en-US.md | 4 +- src/packages/calendarcard/doc.md | 5 +- src/packages/calendarcard/doc.taro.md | 5 +- src/packages/calendarcard/doc.zh-TW.md | 6 +- src/packages/card/doc.en-US.md | 4 +- src/packages/card/doc.md | 5 +- src/packages/card/doc.taro.md | 5 +- src/packages/card/doc.zh-TW.md | 6 +- src/packages/cascader/doc.en-US.md | 4 +- src/packages/cascader/doc.md | 5 +- src/packages/cascader/doc.taro.md | 5 +- src/packages/cascader/doc.zh-TW.md | 6 +- src/packages/cell/doc.en-US.md | 4 +- src/packages/cell/doc.md | 5 +- src/packages/cell/doc.taro.md | 5 +- src/packages/cell/doc.zh-TW.md | 6 +- src/packages/checkbox/doc.en-US.md | 4 +- src/packages/checkbox/doc.md | 5 +- src/packages/checkbox/doc.taro.md | 5 +- src/packages/checkbox/doc.zh-TW.md | 5 +- src/packages/circleprogress/doc.en-US.md | 4 +- src/packages/circleprogress/doc.md | 5 +- src/packages/circleprogress/doc.taro.md | 5 +- src/packages/circleprogress/doc.zh-TW.md | 6 +- src/packages/collapse/doc.en-US.md | 4 +- src/packages/collapse/doc.md | 5 +- src/packages/collapse/doc.taro.md | 5 +- src/packages/collapse/doc.zh-TW.md | 6 +- src/packages/configprovider/doc.en-US.md | 4 +- src/packages/configprovider/doc.md | 5 +- src/packages/configprovider/doc.taro.md | 5 +- src/packages/configprovider/doc.zh-TW.md | 6 +- src/packages/countdown/doc.en-US.md | 4 +- src/packages/countdown/doc.md | 5 +- src/packages/countdown/doc.taro.md | 5 +- src/packages/countdown/doc.zh-TW.md | 6 +- src/packages/datepicker/doc.en-US.md | 4 +- src/packages/datepicker/doc.md | 5 +- src/packages/datepicker/doc.taro.md | 5 +- src/packages/datepicker/doc.zh-TW.md | 6 +- src/packages/dialog/doc.en-US.md | 4 +- src/packages/dialog/doc.md | 5 +- src/packages/dialog/doc.taro.md | 5 +- src/packages/dialog/doc.zh-TW.md | 6 +- src/packages/divider/doc.en-US.md | 4 +- src/packages/divider/doc.md | 5 +- src/packages/divider/doc.taro.md | 5 +- src/packages/divider/doc.zh-TW.md | 6 +- src/packages/drag/doc.en-US.md | 4 +- src/packages/drag/doc.md | 5 +- src/packages/drag/doc.taro.md | 5 +- src/packages/drag/doc.zh-TW.md | 6 +- src/packages/elevator/doc.en-US.md | 4 +- src/packages/elevator/doc.md | 5 +- src/packages/elevator/doc.taro.md | 5 +- src/packages/elevator/doc.zh-TW.md | 6 +- src/packages/ellipsis/doc.en-US.md | 4 +- src/packages/ellipsis/doc.md | 5 +- src/packages/ellipsis/doc.taro.md | 5 +- src/packages/ellipsis/doc.zh-TW.md | 6 +- src/packages/empty/doc.en-US.md | 4 +- src/packages/empty/doc.md | 5 +- src/packages/empty/doc.taro.md | 5 +- src/packages/empty/doc.zh-TW.md | 6 +- src/packages/fixednav/doc.en-US.md | 4 +- src/packages/fixednav/doc.md | 5 +- src/packages/fixednav/doc.taro.md | 5 +- src/packages/fixednav/doc.zh-TW.md | 6 +- src/packages/form/doc.en-US.md | 4 +- src/packages/form/doc.md | 5 +- src/packages/form/doc.taro.md | 5 +- src/packages/form/doc.zh-TW.md | 6 +- src/packages/grid/doc.en-US.md | 4 +- src/packages/grid/doc.md | 5 +- src/packages/grid/doc.taro.md | 5 +- src/packages/grid/doc.zh-TW.md | 6 +- src/packages/icon/doc.en-US.md | 4 +- src/packages/icon/doc.md | 5 +- src/packages/icon/doc.taro.md | 5 +- src/packages/icon/doc.zh-TW.md | 6 +- src/packages/image/doc.en-US.md | 4 +- src/packages/image/doc.md | 5 +- src/packages/image/doc.taro.md | 5 +- src/packages/image/doc.zh-TW.md | 6 +- src/packages/imagepreview/doc.en-US.md | 4 +- src/packages/imagepreview/doc.md | 5 +- src/packages/imagepreview/doc.taro.md | 5 +- src/packages/imagepreview/doc.zh-TW.md | 6 +- src/packages/indicator/doc.en-US.md | 4 +- src/packages/indicator/doc.md | 5 +- src/packages/indicator/doc.taro.md | 5 +- src/packages/indicator/doc.zh-TW.md | 6 +- src/packages/infiniteloading/doc.en-US.md | 4 +- src/packages/infiniteloading/doc.md | 5 +- src/packages/infiniteloading/doc.taro.md | 5 +- src/packages/infiniteloading/doc.zh-TW.md | 6 +- src/packages/input/doc.en-US.md | 4 +- src/packages/input/doc.md | 5 +- src/packages/input/doc.taro.md | 5 +- src/packages/input/doc.zh-TW.md | 5 +- src/packages/inputnumber/doc.en-US.md | 4 +- src/packages/inputnumber/doc.md | 5 +- src/packages/inputnumber/doc.taro.md | 5 +- src/packages/inputnumber/doc.zh-TW.md | 6 +- src/packages/layout/doc.en-US.md | 4 +- src/packages/layout/doc.md | 5 +- src/packages/layout/doc.taro.md | 5 +- src/packages/layout/doc.zh-TW.md | 6 +- src/packages/loading/doc.en-US.md | 4 +- src/packages/loading/doc.md | 7 +- src/packages/loading/doc.taro.md | 7 +- src/packages/loading/doc.zh-TW.md | 6 +- src/packages/menu/doc.en-US.md | 4 +- src/packages/menu/doc.md | 5 +- src/packages/menu/doc.taro.md | 5 +- src/packages/menu/doc.zh-TW.md | 6 +- src/packages/navbar/doc.en-US.md | 4 +- src/packages/navbar/doc.md | 5 +- src/packages/navbar/doc.taro.md | 5 +- src/packages/navbar/doc.zh-TW.md | 6 +- src/packages/noticebar/doc.en-US.md | 4 +- src/packages/noticebar/doc.md | 5 +- src/packages/noticebar/doc.taro.md | 5 +- src/packages/noticebar/doc.zh-TW.md | 6 +- src/packages/notify/doc.en-US.md | 4 +- src/packages/notify/doc.md | 5 +- src/packages/notify/doc.taro.md | 5 +- src/packages/notify/doc.zh-TW.md | 6 +- src/packages/numberkeyboard/doc.en-US.md | 4 +- src/packages/numberkeyboard/doc.md | 5 +- src/packages/numberkeyboard/doc.taro.md | 5 +- src/packages/numberkeyboard/doc.zh-TW.md | 6 +- src/packages/overlay/doc.en-US.md | 4 +- src/packages/overlay/doc.md | 5 +- src/packages/overlay/doc.taro.md | 5 +- src/packages/overlay/doc.zh-TW.md | 6 +- src/packages/pagination/doc.en-US.md | 4 +- src/packages/pagination/doc.md | 5 +- src/packages/pagination/doc.taro.md | 5 +- src/packages/pagination/doc.zh-TW.md | 6 +- src/packages/picker/doc.en-US.md | 4 +- src/packages/picker/doc.md | 5 +- src/packages/picker/doc.taro.md | 5 +- src/packages/picker/doc.zh-TW.md | 6 +- src/packages/popover/doc.en-US.md | 4 +- src/packages/popover/doc.md | 5 +- src/packages/popover/doc.taro.md | 5 +- src/packages/popover/doc.zh-TW.md | 6 +- src/packages/popup/doc.en-US.md | 4 +- src/packages/popup/doc.md | 5 +- src/packages/popup/doc.taro.md | 5 +- src/packages/popup/doc.zh-TW.md | 5 +- src/packages/price/doc.en-US.md | 4 +- src/packages/price/doc.md | 5 +- src/packages/price/doc.taro.md | 5 +- src/packages/price/doc.zh-TW.md | 6 +- src/packages/progress/doc.en-US.md | 4 +- src/packages/progress/doc.md | 5 +- src/packages/progress/doc.taro.md | 5 +- src/packages/progress/doc.zh-TW.md | 6 +- src/packages/pulltorefresh/doc.en-US.md | 4 +- src/packages/pulltorefresh/doc.md | 5 +- src/packages/pulltorefresh/doc.taro.md | 5 +- src/packages/pulltorefresh/doc.zh-TW.md | 6 +- src/packages/radio/doc.en-US.md | 4 +- src/packages/radio/doc.md | 5 +- src/packages/radio/doc.taro.md | 5 +- src/packages/radio/doc.zh-TW.md | 6 +- src/packages/range/doc.en-US.md | 4 +- src/packages/range/doc.md | 5 +- src/packages/range/doc.taro.md | 5 +- src/packages/range/doc.zh-TW.md | 6 +- src/packages/rate/doc.en-US.md | 4 +- src/packages/rate/doc.md | 5 +- src/packages/rate/doc.taro.md | 5 +- src/packages/rate/doc.zh-TW.md | 6 +- src/packages/safearea/doc.en-US.md | 4 +- src/packages/safearea/doc.md | 5 +- src/packages/safearea/doc.taro.md | 5 +- src/packages/safearea/doc.zh-TW.md | 6 +- src/packages/searchbar/doc.en-US.md | 4 +- src/packages/searchbar/doc.md | 5 +- src/packages/searchbar/doc.taro.md | 5 +- src/packages/searchbar/doc.zh-TW.md | 6 +- src/packages/shortpassword/doc.en-US.md | 4 +- src/packages/shortpassword/doc.md | 5 +- src/packages/shortpassword/doc.taro.md | 5 +- src/packages/shortpassword/doc.zh-TW.md | 6 +- src/packages/sidenavbar/doc.en-US.md | 4 +- src/packages/sidenavbar/doc.md | 5 +- src/packages/sidenavbar/doc.taro.md | 5 +- src/packages/sidenavbar/doc.zh-TW.md | 6 +- src/packages/signature/doc.en-US.md | 4 +- src/packages/signature/doc.md | 5 +- src/packages/signature/doc.taro.md | 5 +- src/packages/signature/doc.zh-TW.md | 6 +- src/packages/skeleton/doc.en-US.md | 4 +- src/packages/skeleton/doc.md | 5 +- src/packages/skeleton/doc.taro.md | 5 +- src/packages/skeleton/doc.zh-TW.md | 6 +- src/packages/space/doc.en-US.md | 4 +- src/packages/space/doc.md | 7 +- src/packages/space/doc.taro.md | 7 +- src/packages/space/doc.zh-TW.md | 6 +- src/packages/steps/doc.en-US.md | 4 +- src/packages/steps/doc.md | 5 +- src/packages/steps/doc.taro.md | 5 +- src/packages/steps/doc.zh-TW.md | 6 +- src/packages/sticky/doc.en-US.md | 4 +- src/packages/sticky/doc.md | 5 +- src/packages/sticky/doc.taro.md | 5 +- src/packages/sticky/doc.zh-TW.md | 6 +- src/packages/swipe/doc.en-US.md | 4 +- src/packages/swipe/doc.md | 5 +- src/packages/swipe/doc.taro.md | 5 +- src/packages/swipe/doc.zh-TW.md | 6 +- src/packages/swiper/doc.en-US.md | 4 +- src/packages/swiper/doc.md | 5 +- src/packages/swiper/doc.taro.md | 5 +- src/packages/swiper/doc.zh-TW.md | 6 +- src/packages/switch/doc.en-US.md | 4 +- src/packages/switch/doc.md | 5 +- src/packages/switch/doc.taro.md | 5 +- src/packages/switch/doc.zh-TW.md | 6 +- src/packages/tabbar/doc.en-US.md | 4 +- src/packages/tabbar/doc.md | 5 +- src/packages/tabbar/doc.taro.md | 5 +- src/packages/tabbar/doc.zh-TW.md | 6 +- src/packages/table/doc.en-US.md | 4 +- src/packages/table/doc.md | 5 +- src/packages/table/doc.taro.md | 5 +- src/packages/table/doc.zh-TW.md | 6 +- src/packages/tabs/doc.en-US.md | 4 +- src/packages/tabs/doc.md | 5 +- src/packages/tabs/doc.taro.md | 5 +- src/packages/tabs/doc.zh-TW.md | 6 +- src/packages/tag/doc.en-US.md | 4 +- src/packages/tag/doc.md | 5 +- src/packages/tag/doc.taro.md | 3 +- src/packages/tag/doc.zh-TW.md | 6 +- src/packages/textarea/doc.en-US.md | 4 +- src/packages/textarea/doc.md | 5 +- src/packages/textarea/doc.taro.md | 5 +- src/packages/textarea/doc.zh-TW.md | 6 +- src/packages/timeselect/doc.en-US.md | 4 +- src/packages/timeselect/doc.md | 5 +- src/packages/timeselect/doc.taro.md | 5 +- src/packages/timeselect/doc.zh-TW.md | 6 +- src/packages/toast/doc.en-US.md | 4 +- src/packages/toast/doc.md | 3 +- src/packages/toast/doc.taro.md | 3 +- src/packages/toast/doc.zh-TW.md | 6 +- src/packages/tour/doc.en-US.md | 4 +- src/packages/tour/doc.md | 7 +- src/packages/tour/doc.taro.md | 7 +- src/packages/tour/doc.zh-TW.md | 6 +- src/packages/trendarrow/doc.en-US.md | 4 +- src/packages/trendarrow/doc.md | 5 +- src/packages/trendarrow/doc.taro.md | 5 +- src/packages/trendarrow/doc.zh-TW.md | 6 +- src/packages/uploader/doc.en-US.md | 4 +- src/packages/uploader/doc.md | 5 +- src/packages/uploader/doc.taro.md | 5 +- src/packages/uploader/doc.zh-TW.md | 6 +- src/packages/video/doc.en-US.md | 4 +- src/packages/video/doc.md | 5 +- src/packages/video/doc.taro.md | 5 +- src/packages/video/doc.zh-TW.md | 6 +- src/packages/virtuallist/doc.en-US.md | 4 +- src/packages/virtuallist/doc.md | 5 +- src/packages/virtuallist/doc.taro.md | 5 +- src/packages/virtuallist/doc.zh-TW.md | 6 +- src/packages/watermark/doc.en-US.md | 4 +- src/packages/watermark/doc.md | 5 +- src/packages/watermark/doc.taro.md | 5 +- src/packages/watermark/doc.zh-TW.md | 24 ++- 323 files changed, 834 insertions(+), 1001 deletions(-) diff --git a/src/packages/actionsheet/doc.en-US.md b/src/packages/actionsheet/doc.en-US.md index e2f8704bd6..6e526d30d2 100644 --- a/src/packages/actionsheet/doc.en-US.md +++ b/src/packages/actionsheet/doc.en-US.md @@ -1,10 +1,10 @@ # ActionSheet -## Intro + Action menu panel that pops up from the bottom. -## Install +## Import ```tsx import { ActionSheet } from '@nutui/nutui-react'; diff --git a/src/packages/actionsheet/doc.md b/src/packages/actionsheet/doc.md index 4e9f97bb82..3fa4b84c83 100644 --- a/src/packages/actionsheet/doc.md +++ b/src/packages/actionsheet/doc.md @@ -1,16 +1,16 @@ # ActionSheet 动作面板 -## 介绍 + 从底部弹出的动作菜单面板。 -## 安装 +## 引入 ```tsx import { ActionSheet } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/actionsheet/doc.taro.md b/src/packages/actionsheet/doc.taro.md index b2c1080c9e..1ada20586f 100644 --- a/src/packages/actionsheet/doc.taro.md +++ b/src/packages/actionsheet/doc.taro.md @@ -1,102 +1,100 @@ -# ActionSheet 动作面板 - -## 介绍 - -从底部弹出的动作菜单面板。 - -## 安装 - -```tsx -import { ActionSheet } from '@nutui/nutui-react-taro'; -``` - -## 代码演示 - -### 基础用法 - -:::demo - - - -::: - -### 展示取消按钮 - -:::demo - - - -::: - -### 展示描述信息 - -:::demo - - - -::: - -### 选项状态 - -:::demo - - - -::: - -### 自定义内容 - -:::demo - - - -::: - -### 自定义key - -:::demo - - - -::: - -## ActionSheet - -### Props - -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| visible | 遮罩层可见 | `boolean` | `false` | -| title | 设置列表面板标题 | `string` | `-` | -| description | 设置列表面板副标题/描述 | `string` | `-` | -| options | 列表项 | `Array` | `[]` | -| optionKey | 列表项的自定义设置 | `{ [key: string]: string }` | `-` | -| cancelText | 取消文案 | `string` | `取消` | -| onSelect | 选择之后触发 | `(item: any, index: number) => void` | `-` | -| onCancel | 点击取消文案时触发 | `() => void` | `-` | - -### options - -| 属性 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| name | 列表项的标题key值 | `string` | `-` | -| description | 列表项的描述key值 | `string` | `-` | -| danger | 高亮颜色 | `string` | `$color-primary` | -| disabled | 禁用状态 | `string` | `$disabled-color` | - -## 主题定制 - -### 样式变量 - -组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/component/configprovider)。 - -| 名称 | 说明 | 默认值 | -| --- | --- | --- | -| \--nutui-actionsheet-background-color | 背景色 | `$color-background-overlay` | -| \--nutui-actionsheet-border-radius | 列表和取消按钮圆角 | `0` | -| \--nutui-actionsheet-border-color | 标题和取消位置的border色值 | `#f6f6f6` | -| \--nutui-actionsheet-item-text-align | 列表项的文字对齐方式 | `center` | -| \--nutui-actionsheet-item-border-bottom | 列表项的底部border | `none` | -| \--nutui-actionsheet-item-line-height | 列表项行高 | `24px` | -| \--nutui-actionsheet-item-color | 列表项字色 | `$color-title` | -| \--nutui-actionsheet-item-danger | 列表项danger字色 | `$color-primary` | \ No newline at end of file +# ActionSheet 动作面板 + +从底部弹出的动作菜单面板。 + +## 引入 + +```tsx +import { ActionSheet } from '@nutui/nutui-react-taro'; +``` + +## 示例代码 + +### 基础用法 + +:::demo + + + +::: + +### 展示取消按钮 + +:::demo + + + +::: + +### 展示描述信息 + +:::demo + + + +::: + +### 选项状态 + +:::demo + + + +::: + +### 自定义内容 + +:::demo + + + +::: + +### 自定义key + +:::demo + + + +::: + +## ActionSheet + +### Props + +| 属性 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| visible | 遮罩层可见 | `boolean` | `false` | +| title | 设置列表面板标题 | `string` | `-` | +| description | 设置列表面板副标题/描述 | `string` | `-` | +| options | 列表项 | `Array` | `[]` | +| optionKey | 列表项的自定义设置 | `{ [key: string]: string }` | `-` | +| cancelText | 取消文案 | `string` | `取消` | +| onSelect | 选择之后触发 | `(item: any, index: number) => void` | `-` | +| onCancel | 点击取消文案时触发 | `() => void` | `-` | + +### options + +| 属性 | 说明 | 类型 | 默认值 | +| --- | --- | --- | --- | +| name | 列表项的标题key值 | `string` | `-` | +| description | 列表项的描述key值 | `string` | `-` | +| danger | 高亮颜色 | `string` | `$color-primary` | +| disabled | 禁用状态 | `string` | `$disabled-color` | + +## 主题定制 + +### 样式变量 + +组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/component/configprovider)。 + +| 名称 | 说明 | 默认值 | +| --- | --- | --- | +| \--nutui-actionsheet-background-color | 背景色 | `$color-background-overlay` | +| \--nutui-actionsheet-border-radius | 列表和取消按钮圆角 | `0` | +| \--nutui-actionsheet-border-color | 标题和取消位置的border色值 | `#f6f6f6` | +| \--nutui-actionsheet-item-text-align | 列表项的文字对齐方式 | `center` | +| \--nutui-actionsheet-item-border-bottom | 列表项的底部border | `none` | +| \--nutui-actionsheet-item-line-height | 列表项行高 | `24px` | +| \--nutui-actionsheet-item-color | 列表项字色 | `$color-title` | +| \--nutui-actionsheet-item-danger | 列表项danger字色 | `$color-primary` | diff --git a/src/packages/actionsheet/doc.zh-TW.md b/src/packages/actionsheet/doc.zh-TW.md index 6f988011c7..17e0700ce8 100644 --- a/src/packages/actionsheet/doc.zh-TW.md +++ b/src/packages/actionsheet/doc.zh-TW.md @@ -1,16 +1,16 @@ # ActionSheet 動作面闆 -## 介紹 + 從底部彈出的動作菜單面闆。 -## 安裝 +## 引入 ```tsx import { ActionSheet } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/address/doc.en-US.md b/src/packages/address/doc.en-US.md index 34af6b1313..1f5227c46e 100644 --- a/src/packages/address/doc.en-US.md +++ b/src/packages/address/doc.en-US.md @@ -1,10 +1,10 @@ # Address -## Intro + Load on demand Load the Icon、Popup、Elevator dependent component -## Install +## Import ```tsx import { Address } from '@nutui/nutui-react'; diff --git a/src/packages/address/doc.md b/src/packages/address/doc.md index 47a9414111..74d313bc59 100644 --- a/src/packages/address/doc.md +++ b/src/packages/address/doc.md @@ -1,16 +1,15 @@ # Address 地址 -## 介绍 地址选择,在2.0中,地址改用级联组件实现。截止当前版本,只支持级联,不支持级联+电梯模式,开发中。 -## 安装 +## 引入 ```tsx import { Address } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 选择自定义地址 diff --git a/src/packages/address/doc.taro.md b/src/packages/address/doc.taro.md index e1a97c078f..6396ca49f1 100644 --- a/src/packages/address/doc.taro.md +++ b/src/packages/address/doc.taro.md @@ -1,16 +1,15 @@ # Address 地址 -## 介绍 地址选择 -## 安装 +## 引入 ```tsx import { Address } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 选择自定义地址 diff --git a/src/packages/address/doc.zh-TW.md b/src/packages/address/doc.zh-TW.md index 429e5014e7..1d69a3aa65 100644 --- a/src/packages/address/doc.zh-TW.md +++ b/src/packages/address/doc.zh-TW.md @@ -1,16 +1,16 @@ # Address 地址 -## 介紹 + 地址選擇,在2.0中,地址改用級聯組件實現。截止當前版本,只支持級聯,不支持級聯+電梯模式,開發中。 -## 安裝 +## 引入 ```tsx import { Address } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 選擇自定義地址 diff --git a/src/packages/animate/doc.en-US.md b/src/packages/animate/doc.en-US.md index 597a9b8c6b..efa732b8f5 100644 --- a/src/packages/animate/doc.en-US.md +++ b/src/packages/animate/doc.en-US.md @@ -1,10 +1,10 @@ # Animate -## Intro + Add animation effects to child elements -## Install +## Import ```tsx import { Animate } from '@nutui/nutui-react'; diff --git a/src/packages/animate/doc.md b/src/packages/animate/doc.md index da558986cf..a658d252f8 100644 --- a/src/packages/animate/doc.md +++ b/src/packages/animate/doc.md @@ -1,16 +1,15 @@ # Animate 动画/动效 -## 介绍 给子元素添加动画效果 -## 安装 +## 引入 ```tsx import { Animate } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 点击触发 diff --git a/src/packages/animate/doc.taro.md b/src/packages/animate/doc.taro.md index 5b6a5fc308..8f7fd9843b 100644 --- a/src/packages/animate/doc.taro.md +++ b/src/packages/animate/doc.taro.md @@ -1,16 +1,15 @@ # Animate 动画/动效 -## 介绍 给子元素添加动画效果 -## 安装 +## 引入 ```tsx import { Animate } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 点击触发 diff --git a/src/packages/animate/doc.zh-TW.md b/src/packages/animate/doc.zh-TW.md index c4ae326b44..af16318acb 100644 --- a/src/packages/animate/doc.zh-TW.md +++ b/src/packages/animate/doc.zh-TW.md @@ -1,16 +1,16 @@ # Animate 動畫/動效 -## 介紹 + 給子元素添加動畫效果 -## 安裝 +## 引入 ```tsx import { Animate } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 點擊觸發 diff --git a/src/packages/animatingnumbers/doc.en-US.md b/src/packages/animatingnumbers/doc.en-US.md index dd2372a13b..c9cd18fa17 100644 --- a/src/packages/animatingnumbers/doc.en-US.md +++ b/src/packages/animatingnumbers/doc.en-US.md @@ -1,10 +1,10 @@ # AnimatingNumbers -## Intro + Digital animation collection -## Install +## Import ```tsx import { AnimatingNumbers } from '@nutui/nutui-react' diff --git a/src/packages/animatingnumbers/doc.md b/src/packages/animatingnumbers/doc.md index ef31a70782..ff6e141712 100644 --- a/src/packages/animatingnumbers/doc.md +++ b/src/packages/animatingnumbers/doc.md @@ -1,16 +1,15 @@ # AnimatingNumbers 数字动画 -## 介绍 数字动画集合 -## 安装 +## 引入 ```tsx import { AnimatingNumbers } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### AnimatingNumbers.CountUp - 基础用法 diff --git a/src/packages/animatingnumbers/doc.taro.md b/src/packages/animatingnumbers/doc.taro.md index c094f50e76..0658fbd18f 100644 --- a/src/packages/animatingnumbers/doc.taro.md +++ b/src/packages/animatingnumbers/doc.taro.md @@ -1,16 +1,15 @@ # AnimatingNumbers 数字动画 -## 介绍 数字动画集合 -## 安装 +## 引入 ```tsx import { AnimatingNumbers } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### AnimatingNumbers.CountUp - 基础用法 diff --git a/src/packages/animatingnumbers/doc.zh-TW.md b/src/packages/animatingnumbers/doc.zh-TW.md index f432928abf..d50f172721 100644 --- a/src/packages/animatingnumbers/doc.zh-TW.md +++ b/src/packages/animatingnumbers/doc.zh-TW.md @@ -1,16 +1,16 @@ # AnimatingNumbers 數字動畫 -## 介紹 + 數字動畫集合 -## 安裝 +## 引入 ```tsx import { AnimatingNumbers } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### AnimatingNumbers.CountUp - 基礎用法 diff --git a/src/packages/audio/doc.en-US.md b/src/packages/audio/doc.en-US.md index b00d38c385..b50a7fd121 100644 --- a/src/packages/audio/doc.en-US.md +++ b/src/packages/audio/doc.en-US.md @@ -1,10 +1,10 @@ # Audio -## Intro + Used for audio playback -## Install +## Import ```tsx import { Audio } from '@nutui/nutui-react' diff --git a/src/packages/audio/doc.md b/src/packages/audio/doc.md index 19bad5e631..35760c2da5 100644 --- a/src/packages/audio/doc.md +++ b/src/packages/audio/doc.md @@ -1,16 +1,15 @@ # Audio 音频播放器 -## 介绍 用于音频播放 -## 安装 +## 引入 ```tsx import { Audio } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/audio/doc.taro.md b/src/packages/audio/doc.taro.md index c6abdf9cb8..cd038f82a5 100644 --- a/src/packages/audio/doc.taro.md +++ b/src/packages/audio/doc.taro.md @@ -1,16 +1,15 @@ # Audio 音频播放器 -## 介绍 用于音频播放 -## 安装 +## 引入 ```tsx import { Audio } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/audio/doc.zh-TW.md b/src/packages/audio/doc.zh-TW.md index f9a901054e..8b497ffa7a 100644 --- a/src/packages/audio/doc.zh-TW.md +++ b/src/packages/audio/doc.zh-TW.md @@ -1,16 +1,16 @@ # Audio 音頻播放器 -## 介紹 + 用於音頻播放 -## 安裝 +## 引入 ```tsx import { Audio } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/avatar/doc.en-US.md b/src/packages/avatar/doc.en-US.md index 6963a9c3e8..d657fce1e9 100644 --- a/src/packages/avatar/doc.en-US.md +++ b/src/packages/avatar/doc.en-US.md @@ -1,10 +1,10 @@ # Avatar -## Intro + Avatars can be used to represent people or objects. It supports images, Icons, or letters. -## Install +## Import ```tsx import { Avatar } from '@nutui/nutui-react'; diff --git a/src/packages/avatar/doc.md b/src/packages/avatar/doc.md index c18da38893..bafefa8230 100644 --- a/src/packages/avatar/doc.md +++ b/src/packages/avatar/doc.md @@ -1,17 +1,16 @@ # Avatar 头像 -## 介绍 用来代表用户或事物,支持图片、图标或字符展示。 -## 安装 +## 引入 ```tsx import { Avatar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/avatar/doc.taro.md b/src/packages/avatar/doc.taro.md index b97dad72a7..2b5d146abe 100644 --- a/src/packages/avatar/doc.taro.md +++ b/src/packages/avatar/doc.taro.md @@ -1,16 +1,15 @@ # Avatar 头像 -## 介绍 用来代表用户或事物,支持图片、图标或字符展示。 -## 安装 +## 引入 ```tsx import { Avatar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/avatar/doc.zh-TW.md b/src/packages/avatar/doc.zh-TW.md index 3007cbb901..4b2c32f869 100644 --- a/src/packages/avatar/doc.zh-TW.md +++ b/src/packages/avatar/doc.zh-TW.md @@ -1,17 +1,17 @@ # Avatar 頭像 -## 介紹 + 用來代錶用戶或事物,支持圖片、圖標或字符展示。 -## 安裝 +## 引入 ```tsx import { Avatar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/avatarcropper/doc.md b/src/packages/avatarcropper/doc.md index 7e53b22a2d..79b1f8c572 100644 --- a/src/packages/avatarcropper/doc.md +++ b/src/packages/avatarcropper/doc.md @@ -1,16 +1,15 @@ # AvatarCropper 头像剪切 -## 介绍 用来对头像进行剪切生成一张新的图片。 -## 安装 +## 引入 ```tsx import { AvatarCropper } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/avatarcropper/doc.taro.md b/src/packages/avatarcropper/doc.taro.md index 5086623337..e2efcd92d1 100644 --- a/src/packages/avatarcropper/doc.taro.md +++ b/src/packages/avatarcropper/doc.taro.md @@ -1,16 +1,15 @@ # AvatarCropper 头像裁剪 -## 介绍 用来对头像进行裁剪生成一张新的图片。 -## 安装 +## 引入 ```tsx import { AvatarCropper } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/avatarcropper/doc.zh-TW.md b/src/packages/avatarcropper/doc.zh-TW.md index 851b54d3bf..12521ae7f1 100644 --- a/src/packages/avatarcropper/doc.zh-TW.md +++ b/src/packages/avatarcropper/doc.zh-TW.md @@ -1,16 +1,16 @@ # AvatarCropper 头像剪裁 -## 介紹 + 用來對頭像進行剪裁生成一張新圖片。 -## 安裝 +## 引入 ```tsx import { AvatarCropper } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基礎用法 diff --git a/src/packages/backtop/doc.en-US.md b/src/packages/backtop/doc.en-US.md index 8e57af73b5..a419910fb4 100644 --- a/src/packages/backtop/doc.en-US.md +++ b/src/packages/backtop/doc.en-US.md @@ -1,10 +1,10 @@ # BackTop -## Intro + Provides a quick return to the top function for long pages. -## Install +## Import ```tsx import { BackTop } from '@nutui/nutui-react'; diff --git a/src/packages/backtop/doc.md b/src/packages/backtop/doc.md index 2038327e76..6986fc8dc4 100644 --- a/src/packages/backtop/doc.md +++ b/src/packages/backtop/doc.md @@ -1,16 +1,15 @@ # BackTop 返回顶部 -## 介绍 提供较长的页面快捷返回顶部功能。 -## 安装 +## 引入 ```tsx import { BackTop } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/backtop/doc.taro.md b/src/packages/backtop/doc.taro.md index 106b363c22..18832796fb 100644 --- a/src/packages/backtop/doc.taro.md +++ b/src/packages/backtop/doc.taro.md @@ -1,16 +1,15 @@ # BackTop 返回顶部 -## 介绍 提供较长的页面快捷返回顶部功能。 -## 安装 +## 引入 ```tsx import { BackTop } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/backtop/doc.zh-TW.md b/src/packages/backtop/doc.zh-TW.md index c25b9c6f94..e6738691ae 100644 --- a/src/packages/backtop/doc.zh-TW.md +++ b/src/packages/backtop/doc.zh-TW.md @@ -1,16 +1,16 @@ # BackTop 返回頂部 -## 介紹 + 提供較長的頁面快捷返回頂部功能。 -## 安裝 +## 引入 ```tsx import { BackTop } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/badge/doc.en-US.md b/src/packages/badge/doc.en-US.md index ebbec68f18..caf738e8d0 100644 --- a/src/packages/badge/doc.en-US.md +++ b/src/packages/badge/doc.en-US.md @@ -1,10 +1,10 @@ # Badge -## Intro + 出现在图标或文字右上角的红色圆点、数字或者文字,表示有新内容或者待处理的信息。 -## Install +## Import ```tsx import { Badge } from '@nutui/nutui-react'; diff --git a/src/packages/badge/doc.md b/src/packages/badge/doc.md index 54e1c55465..ec8ac213ea 100644 --- a/src/packages/badge/doc.md +++ b/src/packages/badge/doc.md @@ -1,16 +1,15 @@ # Badge 徽标 -## 介绍 出现在图标或文字右上角的红色圆点、数字或者文字,表示有新内容或者待处理的信息。 -## 安装 +## 引入 ```tsx import { Badge } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/badge/doc.taro.md b/src/packages/badge/doc.taro.md index 7fc02f5757..6e6b4c0a55 100644 --- a/src/packages/badge/doc.taro.md +++ b/src/packages/badge/doc.taro.md @@ -1,16 +1,15 @@ # Badge 徽标 -## 介绍 出现在图标或文字右上角的红色圆点、数字或者文字,表示有新内容或者待处理的信息。 -## 安装 +## 引入 ```tsx import { Badge } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/badge/doc.zh-TW.md b/src/packages/badge/doc.zh-TW.md index 9e5cd2d2be..4d1cf2d58f 100644 --- a/src/packages/badge/doc.zh-TW.md +++ b/src/packages/badge/doc.zh-TW.md @@ -1,16 +1,16 @@ # Badge 徽標 -## 介紹 + 出現在圖標或文字右上角的紅色圓點、數字或者文字,錶示有新內容或者待處理的信息。 -## 安裝 +## 引入 ```tsx import { Badge } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/barrage/doc.en-US.md b/src/packages/barrage/doc.en-US.md index a7e65bbfa3..151480f557 100644 --- a/src/packages/barrage/doc.en-US.md +++ b/src/packages/barrage/doc.en-US.md @@ -1,10 +1,10 @@ # Barrage -## Intro + It is used for the rotation display of words and phrases, which is suitable for video or other similar needs. -## Install +## Import ```tsx import { Barrage } from '@nutui/nutui-react' diff --git a/src/packages/barrage/doc.md b/src/packages/barrage/doc.md index 3fb23a7e8b..e20ec2e2e9 100644 --- a/src/packages/barrage/doc.md +++ b/src/packages/barrage/doc.md @@ -1,16 +1,15 @@ # Barrage 弹幕 -## 介绍 用于话语和词组的轮播展示,适用于视频中或其他类似需求中。 -## 安装 +## 引入 ```tsx import { Barrage } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/barrage/doc.taro.md b/src/packages/barrage/doc.taro.md index 0b248a0b77..261d993f24 100644 --- a/src/packages/barrage/doc.taro.md +++ b/src/packages/barrage/doc.taro.md @@ -1,16 +1,15 @@ # Barrage 弹幕 -## 介绍 用于话语和词组的轮播展示,适用于视频中或其他类似需求中。 -## 安装 +## 引入 ```tsx import { Barrage } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/barrage/doc.zh-TW.md b/src/packages/barrage/doc.zh-TW.md index ca78b5ca14..e0c893c30a 100644 --- a/src/packages/barrage/doc.zh-TW.md +++ b/src/packages/barrage/doc.zh-TW.md @@ -1,16 +1,16 @@ # Barrage 彈幕 -## 介紹 + 用於話語和詞組的輪播展示,適用於視頻中或其他類似需求中。 -## 安裝 +## 引入 ```tsx import { Barrage } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/button/doc.en-US.md b/src/packages/button/doc.en-US.md index f157f8c5fb..429e5d8fee 100644 --- a/src/packages/button/doc.en-US.md +++ b/src/packages/button/doc.en-US.md @@ -1,10 +1,10 @@ # Button -## Intro + Buttons are used to trigger an action, such as submitting a form. -## Install +## Import ```tsx import { Button } from '@nutui/nutui-react'; diff --git a/src/packages/button/doc.md b/src/packages/button/doc.md index 3c124eaca2..aeebbc94c5 100644 --- a/src/packages/button/doc.md +++ b/src/packages/button/doc.md @@ -1,16 +1,15 @@ # Button 按钮 -## 介绍 按钮用于触发一个操作,如提交表单。 -## 安装 +## 引入 ```tsx import { Button } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 按钮类型 diff --git a/src/packages/button/doc.taro.md b/src/packages/button/doc.taro.md index 63f6607857..ec8198dd3f 100644 --- a/src/packages/button/doc.taro.md +++ b/src/packages/button/doc.taro.md @@ -1,16 +1,15 @@ # Button 按钮 -## 介绍 按钮用于触发一个操作,如提交表单。 -## 安装 +## 引入 ```tsx import { Button } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 设置 open-type diff --git a/src/packages/button/doc.zh-TW.md b/src/packages/button/doc.zh-TW.md index 240fafc11b..39dd594b18 100644 --- a/src/packages/button/doc.zh-TW.md +++ b/src/packages/button/doc.zh-TW.md @@ -1,16 +1,16 @@ # Button 按鈕 -## 介紹 + 按鈕用於觸發一個操作,如提交表單。 -## 安裝 +## 引入 ```tsx import { Button } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 按鈕類型 diff --git a/src/packages/calendar/doc.en-US.md b/src/packages/calendar/doc.en-US.md index f0b30e5ba0..5b5ade1abb 100644 --- a/src/packages/calendar/doc.en-US.md +++ b/src/packages/calendar/doc.en-US.md @@ -1,10 +1,10 @@ # Calendar -## Intro + Calendar, tileable/pop-up display -## Install +## Import ```tsx import { Calendar } from '@nutui/nutui-react'; diff --git a/src/packages/calendar/doc.md b/src/packages/calendar/doc.md index 733a0502b5..699773298b 100644 --- a/src/packages/calendar/doc.md +++ b/src/packages/calendar/doc.md @@ -1,16 +1,15 @@ # Calendar 日历 -## 介绍 日历,可平铺/弹窗展示 -## 安装 +## 引入 ```tsx import { Calendar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/calendar/doc.taro.md b/src/packages/calendar/doc.taro.md index d67e113984..3cffc56684 100644 --- a/src/packages/calendar/doc.taro.md +++ b/src/packages/calendar/doc.taro.md @@ -1,16 +1,15 @@ # Calendar 日历 -## 介绍 日历,可平铺/弹窗展示 -## 安装 +## 引入 ```tsx import { Calendar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/calendar/doc.zh-TW.md b/src/packages/calendar/doc.zh-TW.md index 85f4bcbe5a..aae025a0f3 100644 --- a/src/packages/calendar/doc.zh-TW.md +++ b/src/packages/calendar/doc.zh-TW.md @@ -1,16 +1,16 @@ # Calendar 日歴 -## 介紹 + 日歴,可平鋪/彈窗展示 -## 安裝 +## 引入 ```tsx import { Calendar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/calendarcard/doc.en-US.md b/src/packages/calendarcard/doc.en-US.md index 2ddaeaaf5c..eeac12a219 100644 --- a/src/packages/calendarcard/doc.en-US.md +++ b/src/packages/calendarcard/doc.en-US.md @@ -1,10 +1,10 @@ # CalendarCard -## Intro + CalendarCard -## Install +## Import ```tsx import { CalendarCard } from '@nutui/nutui-react'; diff --git a/src/packages/calendarcard/doc.md b/src/packages/calendarcard/doc.md index 14450e8128..7cc6533ecb 100644 --- a/src/packages/calendarcard/doc.md +++ b/src/packages/calendarcard/doc.md @@ -1,16 +1,15 @@ # CalendarCard 日历 -## 介绍 日历 -## 安装 +## 引入 ```tsx import { CalendarCard } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 选择单个日期 diff --git a/src/packages/calendarcard/doc.taro.md b/src/packages/calendarcard/doc.taro.md index bf8744405f..01b79b8384 100644 --- a/src/packages/calendarcard/doc.taro.md +++ b/src/packages/calendarcard/doc.taro.md @@ -1,16 +1,15 @@ # CalendarCard 日历 -## 介绍 日历 -## 安装 +## 引入 ```tsx import { CalendarCard } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 选择单个日期 diff --git a/src/packages/calendarcard/doc.zh-TW.md b/src/packages/calendarcard/doc.zh-TW.md index 32509002b2..6f16b3b6b7 100644 --- a/src/packages/calendarcard/doc.zh-TW.md +++ b/src/packages/calendarcard/doc.zh-TW.md @@ -1,16 +1,16 @@ # CalendarCard 日歷 -## 介紹 + 日歷 -## 安裝 +## 引入 ```tsx import { CalendarCard } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 選擇單個日期 diff --git a/src/packages/card/doc.en-US.md b/src/packages/card/doc.en-US.md index 35eb8969b8..83011995b2 100644 --- a/src/packages/card/doc.en-US.md +++ b/src/packages/card/doc.en-US.md @@ -1,10 +1,10 @@ # Card -## Intro + Used to display product pictures, prices and other information. -## Install +## Import ```tsx import { Card, Price, Tag } from '@nutui/nutui-react' diff --git a/src/packages/card/doc.md b/src/packages/card/doc.md index 65265a5fea..fe113ea65d 100644 --- a/src/packages/card/doc.md +++ b/src/packages/card/doc.md @@ -1,16 +1,15 @@ # Card 商品卡片 -## 介绍 商品卡片,用于展示商品的图片、价格等信息 -## 安装 +## 引入 ```tsx import { Card, Price, Tag } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/card/doc.taro.md b/src/packages/card/doc.taro.md index 5801808160..e58f798ffd 100644 --- a/src/packages/card/doc.taro.md +++ b/src/packages/card/doc.taro.md @@ -1,16 +1,15 @@ # Card 商品卡片 -## 介绍 商品卡片,用于展示商品的图片、价格等信息 -## 安装 +## 引入 ```tsx import { Card, Price, Tag } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/card/doc.zh-TW.md b/src/packages/card/doc.zh-TW.md index e1259575b9..93de6b17bf 100644 --- a/src/packages/card/doc.zh-TW.md +++ b/src/packages/card/doc.zh-TW.md @@ -1,16 +1,16 @@ # Card 商品卡片 -## 介紹 + 商品卡片,用於展示商品的圖片、價格等信息 -## 安裝 +## 引入 ```tsx import { Card, Price, Tag } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/cascader/doc.en-US.md b/src/packages/cascader/doc.en-US.md index f9cefb2146..a4921060d9 100644 --- a/src/packages/cascader/doc.en-US.md +++ b/src/packages/cascader/doc.en-US.md @@ -1,10 +1,10 @@ # Cascader -## Intro + The cascader component is used for the selection of multi-level data. The typical scene is the selection of provinces and cities. -## Install +## Import ```tsx import { Cascader } from '@nutui/nutui-react'; diff --git a/src/packages/cascader/doc.md b/src/packages/cascader/doc.md index e622a3699a..70e8a75139 100644 --- a/src/packages/cascader/doc.md +++ b/src/packages/cascader/doc.md @@ -1,16 +1,15 @@ # Cascader 级联选择 -## 介绍 级联选择器,用于多层级数据的选择,典型场景为省市区选择。 -## 安装 +## 引入 ```tsx import { Cascader } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/cascader/doc.taro.md b/src/packages/cascader/doc.taro.md index 1a75ca5ee5..d4f9b66f1a 100644 --- a/src/packages/cascader/doc.taro.md +++ b/src/packages/cascader/doc.taro.md @@ -1,16 +1,15 @@ # Cascader 级联选择 -## 介绍 级联选择器,用于多层级数据的选择,典型场景为省市区选择。 -## 安装 +## 引入 ```tsx import { Cascader } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/cascader/doc.zh-TW.md b/src/packages/cascader/doc.zh-TW.md index 2fc741b0f2..88ff646236 100644 --- a/src/packages/cascader/doc.zh-TW.md +++ b/src/packages/cascader/doc.zh-TW.md @@ -1,16 +1,16 @@ # Cascader 級聯選擇 -## 介紹 + 級聯選擇器,用於多層級數據的選擇,典型場景為省市區選擇。 -## 安裝 +## 引入 ```tsx import { Cascader } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/cell/doc.en-US.md b/src/packages/cell/doc.en-US.md index 70aefbfd32..bb086521b2 100644 --- a/src/packages/cell/doc.en-US.md +++ b/src/packages/cell/doc.en-US.md @@ -1,10 +1,10 @@ # Cell -## Intro + The cell is a single display item in the list. -## Install +## Import ```tsx import { Cell } from '@nutui/nutui-react' diff --git a/src/packages/cell/doc.md b/src/packages/cell/doc.md index 36b5efd5f6..33295b7c8a 100644 --- a/src/packages/cell/doc.md +++ b/src/packages/cell/doc.md @@ -1,16 +1,15 @@ # Cell 单元格 -## 介绍 列表项,可组成列表。 -## 安装 +## 引入 ```tsx import { Cell } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/cell/doc.taro.md b/src/packages/cell/doc.taro.md index 70068da65a..24a9c1b927 100644 --- a/src/packages/cell/doc.taro.md +++ b/src/packages/cell/doc.taro.md @@ -1,16 +1,15 @@ # Cell 单元格 -## 介绍 列表项,可组成列表。 -## 安装 +## 引入 ```tsx import { Cell } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/cell/doc.zh-TW.md b/src/packages/cell/doc.zh-TW.md index a5a1ea2912..076a44cae6 100644 --- a/src/packages/cell/doc.zh-TW.md +++ b/src/packages/cell/doc.zh-TW.md @@ -1,16 +1,16 @@ # Cell 單元格 -## 介紹 + 列表項,可組成列表。 -## 安裝 +## 引入 ```tsx import { Cell } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/checkbox/doc.en-US.md b/src/packages/checkbox/doc.en-US.md index d7baa2f5dc..999a531bea 100644 --- a/src/packages/checkbox/doc.en-US.md +++ b/src/packages/checkbox/doc.en-US.md @@ -1,10 +1,10 @@ # Checkbox -## Intro + 多选按钮用于选择。 -## Install +## Import ```tsx import { Checkbox } from '@nutui/nutui-react'; diff --git a/src/packages/checkbox/doc.md b/src/packages/checkbox/doc.md index 882244a0f2..ef00f2981e 100644 --- a/src/packages/checkbox/doc.md +++ b/src/packages/checkbox/doc.md @@ -1,16 +1,15 @@ # Checkbox 复选按钮 -## 介绍 多选按钮用于选择。 -## 安装 +## 引入 ```tsx import { Checkbox } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 非受控 diff --git a/src/packages/checkbox/doc.taro.md b/src/packages/checkbox/doc.taro.md index bfb5302de6..dc650f61bf 100644 --- a/src/packages/checkbox/doc.taro.md +++ b/src/packages/checkbox/doc.taro.md @@ -1,16 +1,15 @@ # Checkbox 复选按钮 -## 介绍 多选按钮用于选择。 -## 安装 +## 引入 ```tsx import { Checkbox } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 非受控 diff --git a/src/packages/checkbox/doc.zh-TW.md b/src/packages/checkbox/doc.zh-TW.md index 7067975009..4dbf09885c 100644 --- a/src/packages/checkbox/doc.zh-TW.md +++ b/src/packages/checkbox/doc.zh-TW.md @@ -1,16 +1,15 @@ # Checkbox 复选按钮 -## 介绍 多选按钮用于选择。 -## 安装 +## 引入 ```tsx import { Checkbox } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 非受控 diff --git a/src/packages/circleprogress/doc.en-US.md b/src/packages/circleprogress/doc.en-US.md index d7c3cc8d57..2ac82dae3a 100644 --- a/src/packages/circleprogress/doc.en-US.md +++ b/src/packages/circleprogress/doc.en-US.md @@ -1,10 +1,10 @@ # CricleProgress -## Intro + Circular progress bar component -## Install +## Import ```tsx import { CircleProgress } from '@nutui/nutui-react'; diff --git a/src/packages/circleprogress/doc.md b/src/packages/circleprogress/doc.md index c66093aa6b..e56a122c3d 100644 --- a/src/packages/circleprogress/doc.md +++ b/src/packages/circleprogress/doc.md @@ -1,16 +1,15 @@ # CircleProgress 环形进度条 -## 介绍 展示操作或任务的当前进度。 -## 安装 +## 引入 ```tsx import { CircleProgress } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/circleprogress/doc.taro.md b/src/packages/circleprogress/doc.taro.md index b21784c77c..92db493289 100644 --- a/src/packages/circleprogress/doc.taro.md +++ b/src/packages/circleprogress/doc.taro.md @@ -1,16 +1,15 @@ # CircleProgress 进度条 -## 介绍 展示操作或任务的当前进度。 -## 安装 +## 引入 ```tsx import { CircleProgress } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/circleprogress/doc.zh-TW.md b/src/packages/circleprogress/doc.zh-TW.md index a51f45488a..d91652b628 100644 --- a/src/packages/circleprogress/doc.zh-TW.md +++ b/src/packages/circleprogress/doc.zh-TW.md @@ -1,16 +1,16 @@ # CircleProgress 環形進度條 -## 介紹 + 展示操作或任務的當前進度。 -## 安裝 +## 引入 ```tsx import { CircleProgress } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/collapse/doc.en-US.md b/src/packages/collapse/doc.en-US.md index b95b37e500..f9f3dca1dc 100644 --- a/src/packages/collapse/doc.en-US.md +++ b/src/packages/collapse/doc.en-US.md @@ -1,10 +1,10 @@ # Collapse 折叠面板 -## Intro + Place the content in multiple folded panels, and click the panel title to expand or shrink the content. -## Install +## Import ```tsx import { Collapse } from 'nutui-react' diff --git a/src/packages/collapse/doc.md b/src/packages/collapse/doc.md index e4a56fcbaf..dc89b028c2 100644 --- a/src/packages/collapse/doc.md +++ b/src/packages/collapse/doc.md @@ -1,16 +1,15 @@ # Collapse 折叠面板 -## 介绍 将内容放置在多个折叠面板中,点击面板标题可展开或收缩内容。 -## 安装 +## 引入 ```tsx import { Collapse } from 'nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/collapse/doc.taro.md b/src/packages/collapse/doc.taro.md index 66ba244066..7073b389f2 100644 --- a/src/packages/collapse/doc.taro.md +++ b/src/packages/collapse/doc.taro.md @@ -1,16 +1,15 @@ # Collapse 折叠面板 -## 介绍 将内容放置在多个折叠面板中,点击面板标题可展开或收缩内容。 -## 安装 +## 引入 ```tsx import { Collapse } from 'nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/collapse/doc.zh-TW.md b/src/packages/collapse/doc.zh-TW.md index 30498a46d7..bbfb4e7733 100644 --- a/src/packages/collapse/doc.zh-TW.md +++ b/src/packages/collapse/doc.zh-TW.md @@ -1,16 +1,16 @@ # Collapse 摺疊面闆 -## 介紹 + 將內容放置在多個摺疊面闆中,點擊面闆標題可展開或收縮內容。 -## 安裝 +## 引入 ```tsx import { Collapse } from 'nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/configprovider/doc.en-US.md b/src/packages/configprovider/doc.en-US.md index 53b6e03f9f..c26825f6e3 100644 --- a/src/packages/configprovider/doc.en-US.md +++ b/src/packages/configprovider/doc.en-US.md @@ -1,10 +1,10 @@ # ConfigProvider -## Intro + Used to configure NutUI-React components globally, provide theme customization, internationalization support. -## Install +## Import ```tsx import { ConfigProvider } from '@nutui/nutui-react'; diff --git a/src/packages/configprovider/doc.md b/src/packages/configprovider/doc.md index be449d8f7d..a59d963c78 100644 --- a/src/packages/configprovider/doc.md +++ b/src/packages/configprovider/doc.md @@ -1,16 +1,15 @@ # ConfigProvider 全局配置 -## 介绍 用于全局配置 NutUI-React 组件,提供主题定制,国际化支持。 -## 安装 +## 引入 ```tsx import { ConfigProvider } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 主题定制 diff --git a/src/packages/configprovider/doc.taro.md b/src/packages/configprovider/doc.taro.md index 2db31f8113..ceb8ef797d 100644 --- a/src/packages/configprovider/doc.taro.md +++ b/src/packages/configprovider/doc.taro.md @@ -1,16 +1,15 @@ # ConfigProvider 全局配置 -## 介绍 用于全局配置 NutUI-React 组件,提供主题定制,国际化支持。 -## 安装 +## 引入 ```tsx import { ConfigProvider } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 主题定制 diff --git a/src/packages/configprovider/doc.zh-TW.md b/src/packages/configprovider/doc.zh-TW.md index 23b3b4c79e..c5c2bb23be 100644 --- a/src/packages/configprovider/doc.zh-TW.md +++ b/src/packages/configprovider/doc.zh-TW.md @@ -1,16 +1,16 @@ # ConfigProvider 全域配置 -## 介紹 + 用於全域配置 NutUI-React 元件,提供主題定製,國際化支援。 -## 安裝 +## 引入 ```tsx import { ConfigProvider } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 主題定製 diff --git a/src/packages/countdown/doc.en-US.md b/src/packages/countdown/doc.en-US.md index 8bb44e9abc..aa7fd17144 100644 --- a/src/packages/countdown/doc.en-US.md +++ b/src/packages/countdown/doc.en-US.md @@ -1,10 +1,10 @@ # CountDown -## Intro + Used to display the countdown value in real time, and precision supports milliseconds. -## Install +## Import ```tsx import { CountDown } from '@nutui/nutui-react' diff --git a/src/packages/countdown/doc.md b/src/packages/countdown/doc.md index c0336e7be0..1557c5ce8e 100644 --- a/src/packages/countdown/doc.md +++ b/src/packages/countdown/doc.md @@ -1,16 +1,15 @@ # CountDown 倒计时 -## 介绍 用于实时展示倒计时数值,支持毫秒精度。 -## 安装 +## 引入 ```tsx import { CountDown } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/countdown/doc.taro.md b/src/packages/countdown/doc.taro.md index 6c0924fd88..f22f596fbe 100644 --- a/src/packages/countdown/doc.taro.md +++ b/src/packages/countdown/doc.taro.md @@ -1,16 +1,15 @@ # CountDown 倒计时 -## 介绍 用于实时展示倒计时数值,支持毫秒精度。 -## 安装 +## 引入 ```tsx import { CountDown } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/countdown/doc.zh-TW.md b/src/packages/countdown/doc.zh-TW.md index 45e0176f31..610fc94575 100644 --- a/src/packages/countdown/doc.zh-TW.md +++ b/src/packages/countdown/doc.zh-TW.md @@ -1,16 +1,16 @@ # CountDown 倒計時 -## 介紹 + 用於實時展示倒計時數值,支持毫秒精度。 -## 安裝 +## 引入 ```tsx import { CountDown } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/datepicker/doc.en-US.md b/src/packages/datepicker/doc.en-US.md index b0167f79a3..b4fd67baf9 100644 --- a/src/packages/datepicker/doc.en-US.md +++ b/src/packages/datepicker/doc.en-US.md @@ -1,10 +1,10 @@ # DatePicker -## Intro + Used to select time, support date and time dimensions, usually used with the Popup component. -## Install +## Import ```tsx import { DatePicker } from '@nutui/nutui'; diff --git a/src/packages/datepicker/doc.md b/src/packages/datepicker/doc.md index d069ef3b3a..d499aedf0c 100644 --- a/src/packages/datepicker/doc.md +++ b/src/packages/datepicker/doc.md @@ -1,16 +1,15 @@ # DatePicker 日期选择器 -## 介绍 时间选择器,支持日期、年月、时分等维度,通常与弹出层组件配合使用。 -## 安装 +## 引入 ```tsx import { DatePicker } from '@nutui/nutui'; ``` -## 代码演示 +## 示例代码 ### 选择日期 diff --git a/src/packages/datepicker/doc.taro.md b/src/packages/datepicker/doc.taro.md index a97028af13..54d9c5fe75 100644 --- a/src/packages/datepicker/doc.taro.md +++ b/src/packages/datepicker/doc.taro.md @@ -1,16 +1,15 @@ # DatePicker 日期选择器 -## 介绍 时间选择器,支持日期、年月、时分等维度,通常与弹出层组件配合使用。 -## 安装 +## 引入 ```tsx import { DatePicker } from '@nutui/nutui-taro'; ``` -## 代码演示 +## 示例代码 ### 选择日期 diff --git a/src/packages/datepicker/doc.zh-TW.md b/src/packages/datepicker/doc.zh-TW.md index db66af1d52..55a71f0fc3 100644 --- a/src/packages/datepicker/doc.zh-TW.md +++ b/src/packages/datepicker/doc.zh-TW.md @@ -1,16 +1,16 @@ # DatePicker 日期選擇器 -## 介紹 + 時間選擇器,支持日期、年月、時分等維度,通常與彈出層組件配合使用。 -## 安裝 +## 引入 ```tsx import { DatePicker } from '@nutui/nutui'; ``` -## 代碼演示 +## 示例代碼 ### 選擇日期 diff --git a/src/packages/dialog/doc.en-US.md b/src/packages/dialog/doc.en-US.md index 0c8edf2d20..30429494af 100644 --- a/src/packages/dialog/doc.en-US.md +++ b/src/packages/dialog/doc.en-US.md @@ -1,12 +1,12 @@ # Dialog -## Intro + Modular dialog box, displayed in the floating layer, guides users to perform related operations, often used in message prompts, message confirmation, or complete specific interaction operations on the current page。 The pop -up box components support the function call and component call. -## Install +## Import ```tsx import { Dialog } from '@nutui/nutui-react' diff --git a/src/packages/dialog/doc.md b/src/packages/dialog/doc.md index e9e09c4de1..e4c3785e61 100644 --- a/src/packages/dialog/doc.md +++ b/src/packages/dialog/doc.md @@ -1,18 +1,17 @@ # Dialog 对话框 -## 介绍 模态对话框,在浮层中显示,引导用户进行相关操作,常用于消息提示、消息确认,或在当前页面内完成特定的交互操作。 弹出框组件支持函数调用和组件调用两种方式。 -## 安装 +## 引入 ```tsx import { Dialog } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 函数式调用 diff --git a/src/packages/dialog/doc.taro.md b/src/packages/dialog/doc.taro.md index 5e8d0dbcf9..8aa590eb8b 100644 --- a/src/packages/dialog/doc.taro.md +++ b/src/packages/dialog/doc.taro.md @@ -1,18 +1,17 @@ # Dialog 对话框 -## 介绍 模态对话框,在浮层中显示,引导用户进行相关操作,常用于消息提示、消息确认,或在当前页面内完成特定的交互操作。 弹出框组件支持函数调用和组件调用两种方式。 -## 安装 +## 引入 ```tsx import { Dialog } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 函数式调用 diff --git a/src/packages/dialog/doc.zh-TW.md b/src/packages/dialog/doc.zh-TW.md index a7df7131dc..3ecc1aa93d 100644 --- a/src/packages/dialog/doc.zh-TW.md +++ b/src/packages/dialog/doc.zh-TW.md @@ -1,18 +1,18 @@ # Dialog 對話框 -## 介紹 + 模態對話框,在浮層中顯示,引導用戶進行相關操作,常用於消息提示、消息確認,或在當前頁面內完成特定的交互操作。 彈出框組件支持函數調用和組件調用兩種方式。 -## 安裝 +## 引入 ```tsx import { Dialog } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 函數式調用 diff --git a/src/packages/divider/doc.en-US.md b/src/packages/divider/doc.en-US.md index 035623373d..2682ef44d0 100644 --- a/src/packages/divider/doc.en-US.md +++ b/src/packages/divider/doc.en-US.md @@ -1,10 +1,10 @@ # Divider -## Intro + Separate content into multiple areas. -## Install +## Import ```tsx import { Divider } from '@nutui/nutui-react'; diff --git a/src/packages/divider/doc.md b/src/packages/divider/doc.md index 33779041b1..a4228a3087 100644 --- a/src/packages/divider/doc.md +++ b/src/packages/divider/doc.md @@ -1,16 +1,15 @@ # Divider 分割线 -## 介绍 用于将内容分隔为多个区域。 -## 安装 +## 引入 ```tsx import { Divider } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/divider/doc.taro.md b/src/packages/divider/doc.taro.md index 1ea44688c1..9334252454 100644 --- a/src/packages/divider/doc.taro.md +++ b/src/packages/divider/doc.taro.md @@ -1,16 +1,15 @@ # Divider 分割线 -## 介绍 用于将内容分隔为多个区域。 -## 安装 +## 引入 ```tsx import { Divider } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/divider/doc.zh-TW.md b/src/packages/divider/doc.zh-TW.md index 06e7266bfa..4f4557f3cb 100644 --- a/src/packages/divider/doc.zh-TW.md +++ b/src/packages/divider/doc.zh-TW.md @@ -1,16 +1,16 @@ # Divider 分割線 -## 介紹 + 用於將內容分隔為多個區域。 -## 安裝 +## 引入 ```tsx import { Divider } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/drag/doc.en-US.md b/src/packages/drag/doc.en-US.md index 21aebffbe5..67d8819a76 100644 --- a/src/packages/drag/doc.en-US.md +++ b/src/packages/drag/doc.en-US.md @@ -1,10 +1,10 @@ # Drag -## Intro + Implement draggable arbitrary elements. -## Install +## Import ```tsx import { Drag } from '@nutui/nutui-react' diff --git a/src/packages/drag/doc.md b/src/packages/drag/doc.md index aeb0991029..816e1d2c23 100644 --- a/src/packages/drag/doc.md +++ b/src/packages/drag/doc.md @@ -1,16 +1,15 @@ # Drag 拖拽 -## 介绍 实现可拖拽的任意元素 -## 安装 +## 引入 ```tsx import { Drag } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/drag/doc.taro.md b/src/packages/drag/doc.taro.md index b4086e71d3..40f67d5de9 100644 --- a/src/packages/drag/doc.taro.md +++ b/src/packages/drag/doc.taro.md @@ -1,16 +1,15 @@ # Drag 拖拽 -## 介绍 实现可拖拽的任意元素 -## 安装 +## 引入 ```tsx import { Drag } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/drag/doc.zh-TW.md b/src/packages/drag/doc.zh-TW.md index abdd7e137b..b9e515b8bc 100644 --- a/src/packages/drag/doc.zh-TW.md +++ b/src/packages/drag/doc.zh-TW.md @@ -1,16 +1,16 @@ # Drag 拖拽 -## 介紹 + 實現可拖拽的任意元素 -## 安裝 +## 引入 ```tsx import { Drag } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/elevator/doc.en-US.md b/src/packages/elevator/doc.en-US.md index 879176d97f..d92c74b982 100644 --- a/src/packages/elevator/doc.en-US.md +++ b/src/packages/elevator/doc.en-US.md @@ -1,10 +1,10 @@ # Elevator -## Intro + It is used to quickly locate the list and display the index -## Install +## Import ```tsx import { Elevator } from '@nutui/nutui-react' diff --git a/src/packages/elevator/doc.md b/src/packages/elevator/doc.md index 101fe4a093..cdd6375892 100644 --- a/src/packages/elevator/doc.md +++ b/src/packages/elevator/doc.md @@ -1,16 +1,15 @@ # Elevator 电梯楼层 -## 介绍 用于列表快速定位以及索引的显示 -## 安装 +## 引入 ```tsx import { Elevator } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/elevator/doc.taro.md b/src/packages/elevator/doc.taro.md index 2ad85dc77f..322254c596 100644 --- a/src/packages/elevator/doc.taro.md +++ b/src/packages/elevator/doc.taro.md @@ -1,16 +1,15 @@ # Elevator 电梯楼层 -## 介绍 用于列表快速定位以及索引的显示 -## 安装 +## 引入 ```tsx import { Elevator } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/elevator/doc.zh-TW.md b/src/packages/elevator/doc.zh-TW.md index 9fe51df756..ab1742b673 100644 --- a/src/packages/elevator/doc.zh-TW.md +++ b/src/packages/elevator/doc.zh-TW.md @@ -1,16 +1,16 @@ # Elevator 電梯樓層 -## 介紹 + 用於列表快速定位以及索引的顯示 -## 安裝 +## 引入 ```tsx import { Elevator } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/ellipsis/doc.en-US.md b/src/packages/ellipsis/doc.en-US.md index 7ef1b2b73f..3b4b0e7968 100644 --- a/src/packages/ellipsis/doc.en-US.md +++ b/src/packages/ellipsis/doc.en-US.md @@ -1,10 +1,10 @@ # Ellipsis -## Intro + isplay space is insufficient, hidden part of the content and "..." Alternative. -## Install +## Import ```tsx import { Ellipsis } from '@nutui/nutui-react'; diff --git a/src/packages/ellipsis/doc.md b/src/packages/ellipsis/doc.md index af3c94fbfe..e4a4c01208 100644 --- a/src/packages/ellipsis/doc.md +++ b/src/packages/ellipsis/doc.md @@ -1,16 +1,15 @@ # Ellipsis组件 -## 介绍 展示空间不足时,隐去部分内容并用“...”替代。 -## 安装 +## 引入 ```tsx import { Ellipsis } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 头部省略 diff --git a/src/packages/ellipsis/doc.taro.md b/src/packages/ellipsis/doc.taro.md index 669c145ddd..c7903eeaf3 100644 --- a/src/packages/ellipsis/doc.taro.md +++ b/src/packages/ellipsis/doc.taro.md @@ -1,16 +1,15 @@ # Ellipsis组件 -## 介绍 展示空间不足时,隐去部分内容并用“...”替代。 -## 安装 +## 引入 ```tsx import { Ellipsis } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 头部省略 diff --git a/src/packages/ellipsis/doc.zh-TW.md b/src/packages/ellipsis/doc.zh-TW.md index 35b5838904..0c2c9d8ae8 100644 --- a/src/packages/ellipsis/doc.zh-TW.md +++ b/src/packages/ellipsis/doc.zh-TW.md @@ -1,16 +1,16 @@ # Ellipsis組件 -## 介紹 + 展示空間不足時,隱去部分內容併用“...”替代。 -## 安裝 +## 引入 ```tsx import { Ellipsis } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 頭部省略 diff --git a/src/packages/empty/doc.en-US.md b/src/packages/empty/doc.en-US.md index f0568b36fe..a79cc2b5e1 100644 --- a/src/packages/empty/doc.en-US.md +++ b/src/packages/empty/doc.en-US.md @@ -1,10 +1,10 @@ # Empty -## Intro + Placeholder prompt when empty -## Install +## Import ```tsx import { Empty } from '@nutui/nutui-react' diff --git a/src/packages/empty/doc.md b/src/packages/empty/doc.md index 196394f62e..68a0dc75c8 100644 --- a/src/packages/empty/doc.md +++ b/src/packages/empty/doc.md @@ -1,16 +1,15 @@ # Empty组件 -## 介绍 空状态时的占位提示 -## 安装 +## 引入 ```tsx import { Empty } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/empty/doc.taro.md b/src/packages/empty/doc.taro.md index a14917505e..f2790d4ac7 100644 --- a/src/packages/empty/doc.taro.md +++ b/src/packages/empty/doc.taro.md @@ -1,16 +1,15 @@ # Empty组件 -## 介绍 空状态时的占位提示 -## 安装 +## 引入 ```tsx import { Empty } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/empty/doc.zh-TW.md b/src/packages/empty/doc.zh-TW.md index 684d177433..e61cc7aca5 100644 --- a/src/packages/empty/doc.zh-TW.md +++ b/src/packages/empty/doc.zh-TW.md @@ -1,16 +1,16 @@ # Empty組件 -## 介紹 + 空狀態時的占位提示 -## 安裝 +## 引入 ```tsx import { Empty } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/fixednav/doc.en-US.md b/src/packages/fixednav/doc.en-US.md index 3abe28c3fb..4e76a28b21 100644 --- a/src/packages/fixednav/doc.en-US.md +++ b/src/packages/fixednav/doc.en-US.md @@ -1,10 +1,10 @@ # FixedNav hover navigation -## Intro + Hovering and collecting experience interaction for quick navigation -## Install +## Import ```tsx import { FixedNav } from '@nutui/nutui-react'; diff --git a/src/packages/fixednav/doc.md b/src/packages/fixednav/doc.md index a9aaf5ad7c..2fb8428946 100644 --- a/src/packages/fixednav/doc.md +++ b/src/packages/fixednav/doc.md @@ -1,16 +1,15 @@ # FixedNav 悬浮导航 -## 介绍 悬浮收齐体验交互,用于快捷导航 -## 安装 +## 引入 ```tsx import { FixedNav } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/fixednav/doc.taro.md b/src/packages/fixednav/doc.taro.md index 6a68d2e399..3a8751016a 100644 --- a/src/packages/fixednav/doc.taro.md +++ b/src/packages/fixednav/doc.taro.md @@ -1,16 +1,15 @@ # FixedNav 悬浮导航 -## 介绍 悬浮收齐体验交互,用于快捷导航 -## 安装 +## 引入 ```tsx import { FixedNav } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/fixednav/doc.zh-TW.md b/src/packages/fixednav/doc.zh-TW.md index a69f9d2897..b24c5b2ae0 100644 --- a/src/packages/fixednav/doc.zh-TW.md +++ b/src/packages/fixednav/doc.zh-TW.md @@ -1,16 +1,16 @@ # FixedNav 懸浮導航 -## 介紹 + 懸浮收齊體驗交互,用於快捷導航 -## 安裝 +## 引入 ```tsx import { FixedNav } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/form/doc.en-US.md b/src/packages/form/doc.en-US.md index a40e986ddc..cd80d875c7 100644 --- a/src/packages/form/doc.en-US.md +++ b/src/packages/form/doc.en-US.md @@ -1,10 +1,10 @@ # Form -## Intro + It is used for data entry and verification, and supports input boxes, radio boxes, check boxes and other types. -## Install +## Import ```tsx import { Form } from '@nutui/nutui-react' diff --git a/src/packages/form/doc.md b/src/packages/form/doc.md index 340a876ea2..6f566ede4a 100644 --- a/src/packages/form/doc.md +++ b/src/packages/form/doc.md @@ -1,16 +1,15 @@ # Form 表单 -## 介绍 用于数据录入、校验,支持输入框、单选框、复选框等类型。 -## 安装 +## 引入 ```tsx import { Form } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/form/doc.taro.md b/src/packages/form/doc.taro.md index 1759ffb407..90318cdb92 100644 --- a/src/packages/form/doc.taro.md +++ b/src/packages/form/doc.taro.md @@ -1,16 +1,15 @@ # Form 表单 -## 介绍 用于数据录入、校验,支持输入框、单选框、复选框等类型。 -## 安装 +## 引入 ```tsx import { Form } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/form/doc.zh-TW.md b/src/packages/form/doc.zh-TW.md index 475ffff5b8..678562e5ff 100644 --- a/src/packages/form/doc.zh-TW.md +++ b/src/packages/form/doc.zh-TW.md @@ -1,16 +1,16 @@ # Form 錶單 -## 介紹 + 用於數據錄入、校驗,支持輸入框、單選框、復選框等類型。 -## 安裝 +## 引入 ```tsx import { Form } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/grid/doc.en-US.md b/src/packages/grid/doc.en-US.md index cd1b7e8605..d43a8f14ec 100644 --- a/src/packages/grid/doc.en-US.md +++ b/src/packages/grid/doc.en-US.md @@ -1,10 +1,10 @@ # Grid -## Intro + Used to separate into equal-width blocks for page navigation. -## Install +## Import ```tsx import { Grid } from '@nutui/nutui-react' diff --git a/src/packages/grid/doc.md b/src/packages/grid/doc.md index 7e4e91698d..019cafec37 100644 --- a/src/packages/grid/doc.md +++ b/src/packages/grid/doc.md @@ -1,16 +1,15 @@ # Grid 宫格 -## 介绍 用于分隔成等宽区块进行页面导航。 -## 安装 +## 引入 ```tsx import { Grid } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/grid/doc.taro.md b/src/packages/grid/doc.taro.md index 0b99392386..6381b06b9a 100644 --- a/src/packages/grid/doc.taro.md +++ b/src/packages/grid/doc.taro.md @@ -1,16 +1,15 @@ # Grid 宫格 -## 介绍 用于分隔成等宽区块进行页面导航。 -## 安装 +## 引入 ```tsx import { Grid } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/grid/doc.zh-TW.md b/src/packages/grid/doc.zh-TW.md index 47cc9ae8be..afc5b3964e 100644 --- a/src/packages/grid/doc.zh-TW.md +++ b/src/packages/grid/doc.zh-TW.md @@ -1,16 +1,16 @@ # Grid 宮格 -## 介紹 + 用於分隔成等寬區塊進行頁面導航。 -## 安裝 +## 引入 ```tsx import { Grid } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/icon/doc.en-US.md b/src/packages/icon/doc.en-US.md index f19edee41a..d3c7daf9ef 100644 --- a/src/packages/icon/doc.en-US.md +++ b/src/packages/icon/doc.en-US.md @@ -1,10 +1,10 @@ # Icon -## Intro + Install the @nutui/icons-react icon component package independently. Two usage methods are provided (Svg on demand, IconFont in full). -## Install +## Import ```bash npm i --save @nutui/icons-react diff --git a/src/packages/icon/doc.md b/src/packages/icon/doc.md index 2e0892fe32..30a17544ab 100644 --- a/src/packages/icon/doc.md +++ b/src/packages/icon/doc.md @@ -1,16 +1,15 @@ # Icon 图标 -## 介绍 独立安装 @nutui/icons-react 图标组件包。提供两种使用方式(Svg 按需使用、IconFont 全量使用)。 -## 安装 +## 引入 ```bash npm i --save @nutui/icons-react ``` -## 代码演示 +## 示例代码 ### 方式一: Svg 按需使用 diff --git a/src/packages/icon/doc.taro.md b/src/packages/icon/doc.taro.md index 67c47070df..f38aaf65ea 100644 --- a/src/packages/icon/doc.taro.md +++ b/src/packages/icon/doc.taro.md @@ -1,10 +1,9 @@ # Icon 图标 -## 介绍 独立安装 @nutui/icons-react-taro 图标组件包。基于字体的图标集。 -## 安装 +## 引入 ```bash npm i --save @nutui/icons-react-taro @@ -12,7 +11,7 @@ npm i --save @nutui/icons-react-taro > 在 taro 项目中使用,需要将 prebundle 关闭。 -## 代码演示 +## 示例代码 ### 方式一: Svg按需使用 diff --git a/src/packages/icon/doc.zh-TW.md b/src/packages/icon/doc.zh-TW.md index 83a83ddb60..1e2fa9af91 100644 --- a/src/packages/icon/doc.zh-TW.md +++ b/src/packages/icon/doc.zh-TW.md @@ -1,16 +1,16 @@ # Icon 圖標 -## 介紹 + 獨立安裝 @nutui/icons-react 圖標組件包。提供兩種使用方式(Svg 按需使用、IconFont 全量使用)。 -## 安裝 +## 引入 ```bash npm i --save @nutui/icons-react ``` -## 代碼演示 +## 示例代碼 ### 方式一: Svg 按需使用 diff --git a/src/packages/image/doc.en-US.md b/src/packages/image/doc.en-US.md index 8c48bb17c5..2edde279f2 100644 --- a/src/packages/image/doc.en-US.md +++ b/src/packages/image/doc.en-US.md @@ -1,10 +1,10 @@ # Image -## Intro + Enhanced img tag with multiple image fill modes, support for loading hint, loading failure hint. -## Install +## Import ```tsx import { Image } from '@nutui/nutui-react'; diff --git a/src/packages/image/doc.md b/src/packages/image/doc.md index 0b49566bf6..f90a0bebe5 100644 --- a/src/packages/image/doc.md +++ b/src/packages/image/doc.md @@ -1,16 +1,15 @@ # Image组件 -## 介绍 增强版的 img 标签,提供多种图片填充模式,支持图片加载中提示、加载失败提示。 -## 安装 +## 引入 ```tsx import { Image } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/image/doc.taro.md b/src/packages/image/doc.taro.md index 2512ff6966..7f27fa81c6 100644 --- a/src/packages/image/doc.taro.md +++ b/src/packages/image/doc.taro.md @@ -1,16 +1,15 @@ # Image 图片 -## 介绍 增强版的 img 标签,提供多种图片填充模式,支持图片加载中提示、加载失败提示。 -## 安装 +## 引入 ```tsx import { Image } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/image/doc.zh-TW.md b/src/packages/image/doc.zh-TW.md index eccc968685..3df7ba57ec 100644 --- a/src/packages/image/doc.zh-TW.md +++ b/src/packages/image/doc.zh-TW.md @@ -1,16 +1,16 @@ # Image組件 -## 介紹 + 增強版的 img 標簽,提供多種圖片填充模式,支持圖片加載中提示、加載失敗提示。 -## 安裝 +## 引入 ```tsx import { Image } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/imagepreview/doc.en-US.md b/src/packages/imagepreview/doc.en-US.md index 6efa1c2395..a3f1102c85 100644 --- a/src/packages/imagepreview/doc.en-US.md +++ b/src/packages/imagepreview/doc.en-US.md @@ -1,10 +1,10 @@ # ImagePreview -## Intro + Support full screen preview videos and images, support functional call. -## Install +## Import ```tsx import { ImagePreview } from '@nutui/nutui-react' diff --git a/src/packages/imagepreview/doc.md b/src/packages/imagepreview/doc.md index 18eed082fe..185abf7b70 100644 --- a/src/packages/imagepreview/doc.md +++ b/src/packages/imagepreview/doc.md @@ -1,16 +1,15 @@ # ImagePreview组件 -## 介绍 支持全屏预览视频和图片,可函数式调用 -## 安装 +## 引入 ```tsx import { ImagePreview } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/imagepreview/doc.taro.md b/src/packages/imagepreview/doc.taro.md index 4143418ed8..6514b2358a 100644 --- a/src/packages/imagepreview/doc.taro.md +++ b/src/packages/imagepreview/doc.taro.md @@ -1,16 +1,15 @@ # ImagePreview组件 -## 介绍 支持全屏预览视频和图片,可函数式调用 -## 安装 +## 引入 ```tsx import { ImagePreview } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/imagepreview/doc.zh-TW.md b/src/packages/imagepreview/doc.zh-TW.md index 0d39c9ff01..84ac12591f 100644 --- a/src/packages/imagepreview/doc.zh-TW.md +++ b/src/packages/imagepreview/doc.zh-TW.md @@ -1,16 +1,16 @@ # ImagePreview組件 -## 介紹 + 支持全屏預覽視頻和圖片,可函數式調用 -## 安裝 +## 引入 ```tsx import { ImagePreview } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/indicator/doc.en-US.md b/src/packages/indicator/doc.en-US.md index 8cbcc14030..7d4e5e63da 100644 --- a/src/packages/indicator/doc.en-US.md +++ b/src/packages/indicator/doc.en-US.md @@ -1,10 +1,10 @@ # Indicator -## Intro + Displays the progress of a task or process, often used for provisioning processes -## Install +## Import ```tsx import { Indicator } from '@nutui/nutui-react' diff --git a/src/packages/indicator/doc.md b/src/packages/indicator/doc.md index 4f035b3fd5..be1b2af007 100644 --- a/src/packages/indicator/doc.md +++ b/src/packages/indicator/doc.md @@ -1,16 +1,15 @@ # Indicator 指示器 -## 介绍 显示一个任务或流程的进度,常用于开通流程。 -## 安装 +## 引入 ```tsx import { Indicator } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/indicator/doc.taro.md b/src/packages/indicator/doc.taro.md index 2d3b7ed0b9..ff1d05026f 100644 --- a/src/packages/indicator/doc.taro.md +++ b/src/packages/indicator/doc.taro.md @@ -1,16 +1,15 @@ # Indicator 指示器 -## 介绍 显示一个任务或流程的进度,常用于开通流程。 -## 安装 +## 引入 ```tsx import { Indicator } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/indicator/doc.zh-TW.md b/src/packages/indicator/doc.zh-TW.md index 3cc5963e90..86163474ec 100644 --- a/src/packages/indicator/doc.zh-TW.md +++ b/src/packages/indicator/doc.zh-TW.md @@ -1,16 +1,16 @@ # Indicator 指示器 -## 介紹 + 顯示一個任務或流程的進度,常用於開通流程。 -## 安裝 +## 引入 ```tsx import { Indicator } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/infiniteloading/doc.en-US.md b/src/packages/infiniteloading/doc.en-US.md index 6668186f83..80935979f5 100644 --- a/src/packages/infiniteloading/doc.en-US.md +++ b/src/packages/infiniteloading/doc.en-US.md @@ -1,10 +1,10 @@ # InfiniteLoading -## Intro + Scrolling to the bottom of the list automatically loads more data. -## Install +## Import ```tsx import { InfiniteLoading } from '@nutui/nutui-react' diff --git a/src/packages/infiniteloading/doc.md b/src/packages/infiniteloading/doc.md index 6a114ef189..609efacd92 100644 --- a/src/packages/infiniteloading/doc.md +++ b/src/packages/infiniteloading/doc.md @@ -1,16 +1,15 @@ # InfiniteLoading 滚动加载 -## 介绍 列表滚动到底部自动加载更多数据。 -## 安装 +## 引入 ```tsx import { InfiniteLoading } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/infiniteloading/doc.taro.md b/src/packages/infiniteloading/doc.taro.md index 4c095b10ec..b9984baed3 100644 --- a/src/packages/infiniteloading/doc.taro.md +++ b/src/packages/infiniteloading/doc.taro.md @@ -1,16 +1,15 @@ # InfiniteLoading 滚动加载 -## 介绍 列表滚动到底部自动加载更多数据。 -## 安装 +## 引入 ```tsx import { InfiniteLoading } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/infiniteloading/doc.zh-TW.md b/src/packages/infiniteloading/doc.zh-TW.md index 0ac3c1ee12..6ea1720c5f 100644 --- a/src/packages/infiniteloading/doc.zh-TW.md +++ b/src/packages/infiniteloading/doc.zh-TW.md @@ -1,16 +1,16 @@ # InfiniteLoading 滾動加載 -## 介紹 + 列錶滾動到底部自動加載更多數據。 -## 安裝 +## 引入 ```tsx import { InfiniteLoading } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/input/doc.en-US.md b/src/packages/input/doc.en-US.md index a22c9353f3..37a9c03b49 100644 --- a/src/packages/input/doc.en-US.md +++ b/src/packages/input/doc.en-US.md @@ -1,10 +1,10 @@ # Input -## Intro + The user can enter content in the text box. -## Install +## Import ```tsx import { Input } from '@nutui/nutui-react'; diff --git a/src/packages/input/doc.md b/src/packages/input/doc.md index 614b824fd2..0e381f864a 100644 --- a/src/packages/input/doc.md +++ b/src/packages/input/doc.md @@ -1,17 +1,16 @@ # Input 输入框 -## 介绍 用户可以在文本框里输入内容。 -## 安装 +## 引入 ```tsx import { Input } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/input/doc.taro.md b/src/packages/input/doc.taro.md index 19b76e2da8..a4c2c2323d 100644 --- a/src/packages/input/doc.taro.md +++ b/src/packages/input/doc.taro.md @@ -1,17 +1,16 @@ # Input 输入框 -## 介绍 用户可以在文本框里输入内容。 -## 安装 +## 引入 ```tsx import { Input } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/input/doc.zh-TW.md b/src/packages/input/doc.zh-TW.md index a952ed9a36..ea31a257ed 100644 --- a/src/packages/input/doc.zh-TW.md +++ b/src/packages/input/doc.zh-TW.md @@ -1,17 +1,16 @@ # Input 输入框 -## 介绍 用户可以在文本框里输入内容。 -## 安装 +## 引入 ```tsx import { Input } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/inputnumber/doc.en-US.md b/src/packages/inputnumber/doc.en-US.md index 298f0ff730..d3c3dc40a6 100644 --- a/src/packages/inputnumber/doc.en-US.md +++ b/src/packages/inputnumber/doc.en-US.md @@ -1,10 +1,10 @@ # InputNumber -## Intro + Control the number increase or decrease by clicking the button. -## Install +## Import ```tsx import { InputNumber } from '@nutui/nutui-react'; diff --git a/src/packages/inputnumber/doc.md b/src/packages/inputnumber/doc.md index bce322ba1d..c74c5fa008 100644 --- a/src/packages/inputnumber/doc.md +++ b/src/packages/inputnumber/doc.md @@ -1,16 +1,15 @@ # InputNumber 数字输入框 -## 介绍 通过点击按钮控制数字增减。 -## 安装 +## 引入 ```tsx import { InputNumber } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/inputnumber/doc.taro.md b/src/packages/inputnumber/doc.taro.md index 08acf26105..7a3faa13b7 100644 --- a/src/packages/inputnumber/doc.taro.md +++ b/src/packages/inputnumber/doc.taro.md @@ -1,16 +1,15 @@ # InputNumber 数字输入框 -## 介绍 通过点击按钮控制数字增减。 -## 安装 +## 引入 ```tsx import { InputNumber } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/inputnumber/doc.zh-TW.md b/src/packages/inputnumber/doc.zh-TW.md index 87b4953c0d..fa324a19bd 100644 --- a/src/packages/inputnumber/doc.zh-TW.md +++ b/src/packages/inputnumber/doc.zh-TW.md @@ -1,16 +1,16 @@ # InputNumber 數字輸入框 -## 介紹 + 通過點擊按鈕控制數字增減。 -## 安裝 +## 引入 ```tsx import { InputNumber } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/layout/doc.en-US.md b/src/packages/layout/doc.en-US.md index 2e1cea6e7e..8a83881254 100644 --- a/src/packages/layout/doc.en-US.md +++ b/src/packages/layout/doc.en-US.md @@ -1,10 +1,10 @@ # Layout -## Intro + for quick layout -## Install +## Import ```tsx import { Row, Col } from '@nutui/nutui-react' diff --git a/src/packages/layout/doc.md b/src/packages/layout/doc.md index c80b74d0d2..59c1978b9e 100644 --- a/src/packages/layout/doc.md +++ b/src/packages/layout/doc.md @@ -1,16 +1,15 @@ # Layout 布局 -## 介绍 用于快速进行布局 -## 安装 +## 引入 ```tsx import { Row, Col } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础布局 diff --git a/src/packages/layout/doc.taro.md b/src/packages/layout/doc.taro.md index e461df08ab..5fabd0a2bb 100644 --- a/src/packages/layout/doc.taro.md +++ b/src/packages/layout/doc.taro.md @@ -1,16 +1,15 @@ # Layout 布局 -## 介绍 用于快速进行布局 -## 安装 +## 引入 ```tsx import { Row, Col } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础布局 diff --git a/src/packages/layout/doc.zh-TW.md b/src/packages/layout/doc.zh-TW.md index 9989b8fd0e..5fd4d73c5d 100644 --- a/src/packages/layout/doc.zh-TW.md +++ b/src/packages/layout/doc.zh-TW.md @@ -1,16 +1,16 @@ # Layout 佈局 -## 介紹 + 用於快速進行佈局 -## 安裝 +## 引入 ```tsx import { Row, Col } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎佈局 diff --git a/src/packages/loading/doc.en-US.md b/src/packages/loading/doc.en-US.md index 3746388f7b..cbc09ef04a 100644 --- a/src/packages/loading/doc.en-US.md +++ b/src/packages/loading/doc.en-US.md @@ -1,10 +1,10 @@ # Loading -### Intro +# A loading icon, Used to show the loading state -### Install +### Import ```tsx import { Loading } from '@nutui/nutui-react'; diff --git a/src/packages/loading/doc.md b/src/packages/loading/doc.md index aec60004f4..6f47ecd8fb 100644 --- a/src/packages/loading/doc.md +++ b/src/packages/loading/doc.md @@ -1,16 +1,15 @@ # Loading 加载中 -### 介绍 - +# 加载图标,用于显示正在加载中的状态 -### 安装 +### 引入 ```tsx import { Loading } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/loading/doc.taro.md b/src/packages/loading/doc.taro.md index 779d8d390f..ccc893eda7 100644 --- a/src/packages/loading/doc.taro.md +++ b/src/packages/loading/doc.taro.md @@ -1,16 +1,15 @@ # Loading 加载中 -### 介绍 - +# 加载图标,用于显示正在加载中的状态 -### 安装 +### 引入 ```tsx import { Loading } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/loading/doc.zh-TW.md b/src/packages/loading/doc.zh-TW.md index 4a18b85d6f..55547db7ce 100644 --- a/src/packages/loading/doc.zh-TW.md +++ b/src/packages/loading/doc.zh-TW.md @@ -1,16 +1,16 @@ # Loading 加載中 -### 介紹 +# 加載圖標,用於顯示正在加載中的狀態 -### 安裝 +### 引入 ```tsx import { Loading } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/menu/doc.en-US.md b/src/packages/menu/doc.en-US.md index 456999c28c..ebb2065166 100644 --- a/src/packages/menu/doc.en-US.md +++ b/src/packages/menu/doc.en-US.md @@ -1,10 +1,10 @@ # Menu -## Intro + The menu list that pops down downwards. -## Install +## Import ```tsx import { Menu } from '@nutui/nutui-react' diff --git a/src/packages/menu/doc.md b/src/packages/menu/doc.md index 592e5e60f9..d3e6a93c5e 100644 --- a/src/packages/menu/doc.md +++ b/src/packages/menu/doc.md @@ -1,16 +1,15 @@ # Menu 菜单 -## 介绍 向下弹出的菜单列表 -## 安装 +## 引入 ```tsx import { Menu } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/menu/doc.taro.md b/src/packages/menu/doc.taro.md index b5ff1df0d6..4baa72998e 100644 --- a/src/packages/menu/doc.taro.md +++ b/src/packages/menu/doc.taro.md @@ -1,16 +1,15 @@ # Menu 菜单 -## 介绍 向下弹出的菜单列表 -## 安装 +## 引入 ```tsx import { Menu } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/menu/doc.zh-TW.md b/src/packages/menu/doc.zh-TW.md index f7e1c67a7c..603507b37d 100644 --- a/src/packages/menu/doc.zh-TW.md +++ b/src/packages/menu/doc.zh-TW.md @@ -1,16 +1,16 @@ # Menu 菜單 -## 介紹 + 嚮下彈出的菜單列錶 -## 安裝 +## 引入 ```tsx import { Menu } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/navbar/doc.en-US.md b/src/packages/navbar/doc.en-US.md index e0c26b95c0..dcf952d830 100644 --- a/src/packages/navbar/doc.en-US.md +++ b/src/packages/navbar/doc.en-US.md @@ -1,10 +1,10 @@ # Navbar -## Intro + Provides navigation capabilities. -## Install +## Import ```tsx import { NavBar } from '@nutui/nutui-react'; diff --git a/src/packages/navbar/doc.md b/src/packages/navbar/doc.md index 372c5d273f..64694bb786 100644 --- a/src/packages/navbar/doc.md +++ b/src/packages/navbar/doc.md @@ -1,16 +1,15 @@ # Navbar 头部导航 -## 介绍 提供导航功能。 -## 安装 +## 引入 ```tsx import { NavBar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/navbar/doc.taro.md b/src/packages/navbar/doc.taro.md index 73a35c3a8b..984bb24323 100644 --- a/src/packages/navbar/doc.taro.md +++ b/src/packages/navbar/doc.taro.md @@ -1,16 +1,15 @@ # Navbar 头部导航 -## 介绍 提供导航功能。 -## 安装 +## 引入 ```tsx import { NavBar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/navbar/doc.zh-TW.md b/src/packages/navbar/doc.zh-TW.md index 6366eb3157..a6962adae9 100644 --- a/src/packages/navbar/doc.zh-TW.md +++ b/src/packages/navbar/doc.zh-TW.md @@ -1,16 +1,16 @@ # Navbar 頭部導航 -## 介紹 + 提供導航功能。 -## 安裝 +## 引入 ```tsx import { NavBar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/noticebar/doc.en-US.md b/src/packages/noticebar/doc.en-US.md index 708fc2b1e4..5571e305da 100644 --- a/src/packages/noticebar/doc.en-US.md +++ b/src/packages/noticebar/doc.en-US.md @@ -1,10 +1,10 @@ # NoticeBar -## Intro + Used to display a group of message notifications in a continuous loop. -## Install +## Import ```tsx import { NoticeBar } from '@nutui/nutui-react'; diff --git a/src/packages/noticebar/doc.md b/src/packages/noticebar/doc.md index 140a0ce7cf..01c98a08b6 100644 --- a/src/packages/noticebar/doc.md +++ b/src/packages/noticebar/doc.md @@ -1,16 +1,15 @@ # NoticeBar 公告栏 -## 介绍 用于循环播放展示一组消息通知。 -## 安装 +## 引入 ```tsx import { NoticeBar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/noticebar/doc.taro.md b/src/packages/noticebar/doc.taro.md index 45a1d93607..c1cdaad354 100644 --- a/src/packages/noticebar/doc.taro.md +++ b/src/packages/noticebar/doc.taro.md @@ -1,16 +1,15 @@ # NoticeBar 公告栏 -## 介绍 用于循环播放展示一组消息通知。 -## 安装 +## 引入 ```tsx import { NoticeBar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/noticebar/doc.zh-TW.md b/src/packages/noticebar/doc.zh-TW.md index 272f131abb..bbfef71be9 100644 --- a/src/packages/noticebar/doc.zh-TW.md +++ b/src/packages/noticebar/doc.zh-TW.md @@ -1,16 +1,16 @@ # NoticeBar 公告欄 -## 介紹 + 用於循環播放展示一組消息通知。 -## 安裝 +## 引入 ```tsx import { NoticeBar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/notify/doc.en-US.md b/src/packages/notify/doc.en-US.md index 55fa8225f3..e7935a1a22 100644 --- a/src/packages/notify/doc.en-US.md +++ b/src/packages/notify/doc.en-US.md @@ -1,10 +1,10 @@ # Notify -## Intro + Show message tips at the top of the page -## Install +## Import ```tsx import { Notify } from '@nutui/nutui-react'; diff --git a/src/packages/notify/doc.md b/src/packages/notify/doc.md index 4adeb7b368..9d22f762b8 100644 --- a/src/packages/notify/doc.md +++ b/src/packages/notify/doc.md @@ -1,16 +1,15 @@ # Notify 消息通知 -## 介绍 在页面顶部展示消息提示 -## 安装 +## 引入 ```tsx import { Notify } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/notify/doc.taro.md b/src/packages/notify/doc.taro.md index a2c9eeba17..204953b60d 100644 --- a/src/packages/notify/doc.taro.md +++ b/src/packages/notify/doc.taro.md @@ -1,16 +1,15 @@ # Notify 消息通知 -## 介绍 在页面顶部展示消息提示 -## 安装 +## 引入 ```tsx import { Notify } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/notify/doc.zh-TW.md b/src/packages/notify/doc.zh-TW.md index 663d295dc8..34d4a4e05e 100644 --- a/src/packages/notify/doc.zh-TW.md +++ b/src/packages/notify/doc.zh-TW.md @@ -1,16 +1,16 @@ # Notify 消息通知 -### 介紹 +# 在頁面頂部展示消息提示 -### 安裝 +### 引入 ```tsx import { Notify } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/numberkeyboard/doc.en-US.md b/src/packages/numberkeyboard/doc.en-US.md index 2748604f1d..6d8bed5e95 100644 --- a/src/packages/numberkeyboard/doc.en-US.md +++ b/src/packages/numberkeyboard/doc.en-US.md @@ -1,10 +1,10 @@ # NumberKeyboard -## Intro + Virtual numeric keypad, used for scenarios where payment passwords are entered. -## Install +## Import ```tsx import { NumberKeyboard } from '@nutui/nutui-react'; diff --git a/src/packages/numberkeyboard/doc.md b/src/packages/numberkeyboard/doc.md index cd338e3db0..113c894d84 100644 --- a/src/packages/numberkeyboard/doc.md +++ b/src/packages/numberkeyboard/doc.md @@ -1,16 +1,15 @@ # NumberKeyboard 数字键盘 -## 介绍 虚拟数字键盘,用于输入支付密码的场景。 -## 安装 +## 引入 ```tsx import { NumberKeyboard } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 默认键盘 diff --git a/src/packages/numberkeyboard/doc.taro.md b/src/packages/numberkeyboard/doc.taro.md index 7591c858dc..f1b01e55f7 100644 --- a/src/packages/numberkeyboard/doc.taro.md +++ b/src/packages/numberkeyboard/doc.taro.md @@ -1,16 +1,15 @@ # NumberKeyboard 数字键盘 -## 介绍 虚拟数字键盘,用于输入支付密码的场景。 -## 安装 +## 引入 ```tsx import { NumberKeyboard } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 默认键盘 diff --git a/src/packages/numberkeyboard/doc.zh-TW.md b/src/packages/numberkeyboard/doc.zh-TW.md index b83a727e6f..690de7da98 100644 --- a/src/packages/numberkeyboard/doc.zh-TW.md +++ b/src/packages/numberkeyboard/doc.zh-TW.md @@ -1,16 +1,16 @@ # NumberKeyboard 數字鍵盤 -## 介紹 + 虛擬數字鍵盤,用於輸入支付密碼的場景。 -## 安裝 +## 引入 ```tsx import { NumberKeyboard } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 默認鍵盤 diff --git a/src/packages/overlay/doc.en-US.md b/src/packages/overlay/doc.en-US.md index 467f75eed5..976bd9a3f1 100644 --- a/src/packages/overlay/doc.en-US.md +++ b/src/packages/overlay/doc.en-US.md @@ -1,10 +1,10 @@ # Overlay -## Intro + Create a mask layer that is typically used to prevent users from doing other things -## Install +## Import ```tsx import { Overlay } from '@nutui/nutui-react'; diff --git a/src/packages/overlay/doc.md b/src/packages/overlay/doc.md index dfe34f46fe..d101d2a6cc 100644 --- a/src/packages/overlay/doc.md +++ b/src/packages/overlay/doc.md @@ -1,16 +1,15 @@ # Overlay 遮罩层 -## 介绍 创建一个遮罩层,通常用于阻止用户进行其他操作 -## 安装 +## 引入 ```tsx import { Overlay } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/overlay/doc.taro.md b/src/packages/overlay/doc.taro.md index f96f5e3c05..c452f03e3c 100644 --- a/src/packages/overlay/doc.taro.md +++ b/src/packages/overlay/doc.taro.md @@ -1,16 +1,15 @@ # Overlay 遮罩层 -## 介绍 创建一个遮罩层,通常用于阻止用户进行其他操作 -## 安装 +## 引入 ```tsx import { Overlay } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/overlay/doc.zh-TW.md b/src/packages/overlay/doc.zh-TW.md index cb01f19975..0ba09d45e0 100644 --- a/src/packages/overlay/doc.zh-TW.md +++ b/src/packages/overlay/doc.zh-TW.md @@ -1,16 +1,16 @@ # Overlay 遮罩層 -## 介紹 + 創建一個遮罩層,通常用於阻止用戶進行其他操作 -## 安裝 +## 引入 ```tsx import { Overlay } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/pagination/doc.en-US.md b/src/packages/pagination/doc.en-US.md index 1d64a9acfb..72c697b6ae 100644 --- a/src/packages/pagination/doc.en-US.md +++ b/src/packages/pagination/doc.en-US.md @@ -1,10 +1,10 @@ # Pagination -## Intro + When the amount of data is too much, use pagination to separate the data. -## Install +## Import ```tsx import { Pagination } from '@nutui/nutui-react'; diff --git a/src/packages/pagination/doc.md b/src/packages/pagination/doc.md index 6f945a8eec..ea37d303c2 100644 --- a/src/packages/pagination/doc.md +++ b/src/packages/pagination/doc.md @@ -1,16 +1,15 @@ # Pagination 分页 -## 介绍 当数据量较多时,采用分页的形式分隔长列表。 -## 安装 +## 引入 ```tsx import { Pagination } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/pagination/doc.taro.md b/src/packages/pagination/doc.taro.md index cf48f7f2f3..9dc4897d9d 100644 --- a/src/packages/pagination/doc.taro.md +++ b/src/packages/pagination/doc.taro.md @@ -1,16 +1,15 @@ # Pagination 分页 -## 介绍 当数据量较多时,采用分页的形式分隔长列表。 -## 安装 +## 引入 ```tsx import { Pagination } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/pagination/doc.zh-TW.md b/src/packages/pagination/doc.zh-TW.md index 817e1b9b66..03d79f2a4e 100644 --- a/src/packages/pagination/doc.zh-TW.md +++ b/src/packages/pagination/doc.zh-TW.md @@ -1,16 +1,16 @@ # Pagination 分頁 -## 介紹 + 當數據量較多時,採用分頁的形式分隔長列錶。 -## 安裝 +## 引入 ```tsx import { Pagination } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/picker/doc.en-US.md b/src/packages/picker/doc.en-US.md index 2da0ebe982..aab6cf730f 100644 --- a/src/packages/picker/doc.en-US.md +++ b/src/packages/picker/doc.en-US.md @@ -1,10 +1,10 @@ # Picker -## Intro + The picker component is usually used with Popup Component. -## Install +## Import ```tsx import { Picker } from '@nutui/nutui-react'; diff --git a/src/packages/picker/doc.md b/src/packages/picker/doc.md index 5659a20262..37f0740896 100644 --- a/src/packages/picker/doc.md +++ b/src/packages/picker/doc.md @@ -1,16 +1,15 @@ # Picker 选择器 -## 介绍 提供多个选项集合供用户选择其中一项。 -## 安装 +## 引入 ```tsx import { Picker } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/picker/doc.taro.md b/src/packages/picker/doc.taro.md index faeb60d56a..1299a2bfef 100644 --- a/src/packages/picker/doc.taro.md +++ b/src/packages/picker/doc.taro.md @@ -1,16 +1,15 @@ # Picker 选择器 -## 介绍 提供多个选项集合供用户选择其中一项。 -## 安装 +## 引入 ```tsx import { Picker } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/picker/doc.zh-TW.md b/src/packages/picker/doc.zh-TW.md index 0d9a112a20..cffa35745e 100644 --- a/src/packages/picker/doc.zh-TW.md +++ b/src/packages/picker/doc.zh-TW.md @@ -1,16 +1,16 @@ # Picker 選擇器 -## 介紹 + 提供多個選項集合供用戶選擇其中一項。 -## 安裝 +## 引入 ```tsx import { Picker } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/popover/doc.en-US.md b/src/packages/popover/doc.en-US.md index 188090294f..ae831d48c2 100644 --- a/src/packages/popover/doc.en-US.md +++ b/src/packages/popover/doc.en-US.md @@ -1,10 +1,10 @@ # Popover -## Intro + Click or hover the mouse on the element to pop up the floating layer of the bubble card. -## Install +## Import ```tsx import { Popover } from '@nutui/nutui-react' diff --git a/src/packages/popover/doc.md b/src/packages/popover/doc.md index 5ff7da0198..75c02fa2c8 100644 --- a/src/packages/popover/doc.md +++ b/src/packages/popover/doc.md @@ -1,16 +1,15 @@ # Popover 气泡弹出框 -## 介绍 点击或在元素上悬停鼠标,弹出气泡卡片浮层。 -## 安装 +## 引入 ```tsx import { Popover } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/popover/doc.taro.md b/src/packages/popover/doc.taro.md index ec6de08968..8865f14149 100644 --- a/src/packages/popover/doc.taro.md +++ b/src/packages/popover/doc.taro.md @@ -1,16 +1,15 @@ # Popover 气泡弹出框 -## 介绍 点击或在元素上悬停鼠标,弹出气泡卡片浮层。 -## 安装 +## 引入 ```tsx import { Popover } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/popover/doc.zh-TW.md b/src/packages/popover/doc.zh-TW.md index 5030e4be2e..2ba8352986 100644 --- a/src/packages/popover/doc.zh-TW.md +++ b/src/packages/popover/doc.zh-TW.md @@ -1,16 +1,16 @@ # Popover 氣泡彈出框 -## 介紹 + 點擊或在元素上懸停鼠標,彈出氣泡卡片浮層。 -## 安裝 +## 引入 ```tsx import { Popover } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/popup/doc.en-US.md b/src/packages/popup/doc.en-US.md index 05cc9f0464..b3bd0fbab1 100644 --- a/src/packages/popup/doc.en-US.md +++ b/src/packages/popup/doc.en-US.md @@ -1,10 +1,10 @@ # Popup -## Intro + Popup layer container, used to display pop-up windows, information prompts, etc. -## Install +## Import ```tsx import { Popup } from '@nutui/nutui-react'; diff --git a/src/packages/popup/doc.md b/src/packages/popup/doc.md index 9ad773615e..54da1c2f6e 100644 --- a/src/packages/popup/doc.md +++ b/src/packages/popup/doc.md @@ -1,16 +1,15 @@ # Popup 弹出层 -## 介绍 弹出层容器,用于展示弹窗、信息提示等内容 -## 安装 +## 引入 ```tsx import { Popup } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/popup/doc.taro.md b/src/packages/popup/doc.taro.md index 38316b432e..845678d952 100644 --- a/src/packages/popup/doc.taro.md +++ b/src/packages/popup/doc.taro.md @@ -1,16 +1,15 @@ # Popup 弹出层 -## 介绍 弹出层容器,用于展示弹窗、信息提示等内容 -## 安装 +## 引入 ```tsx import { Popup } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/popup/doc.zh-TW.md b/src/packages/popup/doc.zh-TW.md index f9de0b5f11..b9734698b9 100644 --- a/src/packages/popup/doc.zh-TW.md +++ b/src/packages/popup/doc.zh-TW.md @@ -1,16 +1,15 @@ # Popup 彈出層 -## 介绍 彈出層容器,用於展示彈窗、信息提示等內容 -## 安裝 +## 引入 ```tsx import { Popup } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/price/doc.en-US.md b/src/packages/price/doc.en-US.md index 44c306e0e9..97e0947737 100644 --- a/src/packages/price/doc.en-US.md +++ b/src/packages/price/doc.en-US.md @@ -1,10 +1,10 @@ # Price -## Intro + It is used to apply different styles to the parts before and after the decimal point of the commodity price value, and also supports functions such as the RMB symbol, thousands separator, and setting the number of decimal points. -## Install +## Import ```tsx import { Price } from '@nutui/nutui-react' diff --git a/src/packages/price/doc.md b/src/packages/price/doc.md index b99cf6f6a7..ff9620302c 100644 --- a/src/packages/price/doc.md +++ b/src/packages/price/doc.md @@ -1,16 +1,15 @@ # Price 价格 -## 介绍 用来对商品价格数值的小数点前后部分应用不同样式,还支持人民币符号、千位分隔符、设置小数点位数等功能。 -## 安装 +## 引入 ```tsx import { Price } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 small normal large diff --git a/src/packages/price/doc.taro.md b/src/packages/price/doc.taro.md index 6ab42e6a81..f716772560 100644 --- a/src/packages/price/doc.taro.md +++ b/src/packages/price/doc.taro.md @@ -1,16 +1,15 @@ # Price 价格 -## 介绍 用来对商品价格数值的小数点前后部分应用不同样式,还支持人民币符号、千位分隔符、设置小数点位数等功能。 -## 安装 +## 引入 ```tsx import { Price } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 small normal large diff --git a/src/packages/price/doc.zh-TW.md b/src/packages/price/doc.zh-TW.md index bd5693f5ef..fdd066b356 100644 --- a/src/packages/price/doc.zh-TW.md +++ b/src/packages/price/doc.zh-TW.md @@ -1,16 +1,16 @@ # Price 價格 -## 介紹 + 用來對商品價格數值的小數點前後部分應用不同樣式,還支持人民幣符號、仟位分隔符、設置小數點位數等功能。 -## 安裝 +## 引入 ```tsx import { Price } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 small normal large diff --git a/src/packages/progress/doc.en-US.md b/src/packages/progress/doc.en-US.md index e439e1b859..b7cf07e921 100644 --- a/src/packages/progress/doc.en-US.md +++ b/src/packages/progress/doc.en-US.md @@ -1,10 +1,10 @@ # Progress -## Intro + Used to show the current progress of the operation. -## Install +## Import ```tsx import { Progress } from '@nutui/nutui-react'; diff --git a/src/packages/progress/doc.md b/src/packages/progress/doc.md index 10575d6a2d..6960da27a3 100644 --- a/src/packages/progress/doc.md +++ b/src/packages/progress/doc.md @@ -1,16 +1,15 @@ # Progress 进度条 -## 介绍 展示操作或任务的当前进度。 -## 安装 +## 引入 ```tsx import { Progress } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/progress/doc.taro.md b/src/packages/progress/doc.taro.md index 694d940cc3..69b6e92b06 100644 --- a/src/packages/progress/doc.taro.md +++ b/src/packages/progress/doc.taro.md @@ -1,16 +1,15 @@ # Progress 进度条 -## 介绍 展示操作或任务的当前进度。 -## 安装 +## 引入 ```tsx import { Progress } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/progress/doc.zh-TW.md b/src/packages/progress/doc.zh-TW.md index 2ad84299d5..5ff97575f9 100644 --- a/src/packages/progress/doc.zh-TW.md +++ b/src/packages/progress/doc.zh-TW.md @@ -1,16 +1,16 @@ # Progress 進度條 -## 介紹 + 展示操作或任務的當前進度。 -## 安裝 +## 引入 ```tsx import { Progress } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/pulltorefresh/doc.en-US.md b/src/packages/pulltorefresh/doc.en-US.md index 6ceea343fc..763773c559 100644 --- a/src/packages/pulltorefresh/doc.en-US.md +++ b/src/packages/pulltorefresh/doc.en-US.md @@ -1,10 +1,10 @@ # PullToRefresh -## Intro + An interaction to load new content with a finger pull-to-refresh in a list. -## Install +## Import ```tsx import { PullToRefresh } from '@nutui/nutui-react'; diff --git a/src/packages/pulltorefresh/doc.md b/src/packages/pulltorefresh/doc.md index 51b231708e..4a5870953f 100644 --- a/src/packages/pulltorefresh/doc.md +++ b/src/packages/pulltorefresh/doc.md @@ -1,16 +1,15 @@ # PullToRefresh 下拉刷新 -## 介绍 在列表中通过手指下拉刷新加载新内容的交互操作。 -## 安装 +## 引入 ```tsx import { PullToRefresh } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/pulltorefresh/doc.taro.md b/src/packages/pulltorefresh/doc.taro.md index dcbfc425a9..42b915635b 100644 --- a/src/packages/pulltorefresh/doc.taro.md +++ b/src/packages/pulltorefresh/doc.taro.md @@ -1,16 +1,15 @@ # PullToRefresh 下拉刷新 -## 介绍 在列表中通过手指下拉刷新加载新内容的交互操作。 -## 安装 +## 引入 ```tsx import { PullToRefresh } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/pulltorefresh/doc.zh-TW.md b/src/packages/pulltorefresh/doc.zh-TW.md index 01eacfce9b..95859e9a27 100644 --- a/src/packages/pulltorefresh/doc.zh-TW.md +++ b/src/packages/pulltorefresh/doc.zh-TW.md @@ -1,16 +1,16 @@ # PullToRefresh 下拉刷新 -## 介紹 + 在列表中通過手指下拉刷新加載新內容的交互操作。 -## 安裝 +## 引入 ```tsx import { PullToRefresh } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/radio/doc.en-US.md b/src/packages/radio/doc.en-US.md index 5331f737ec..65f9996f97 100644 --- a/src/packages/radio/doc.en-US.md +++ b/src/packages/radio/doc.en-US.md @@ -1,10 +1,10 @@ # Radio -## Intro + Used to single select in a set of alternatives -## Install +## Import ```tsx import { Radio } from '@nutui/nutui-react'; diff --git a/src/packages/radio/doc.md b/src/packages/radio/doc.md index 1435e8593c..6e7da6f0e4 100644 --- a/src/packages/radio/doc.md +++ b/src/packages/radio/doc.md @@ -1,17 +1,16 @@ # Radio 单选按钮 -## 介绍 用于在一组备选项中进行单选 -## 安装 +## 引入 ```tsx import { Radio } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/radio/doc.taro.md b/src/packages/radio/doc.taro.md index 9b3f5d9ad8..8df7fc5024 100644 --- a/src/packages/radio/doc.taro.md +++ b/src/packages/radio/doc.taro.md @@ -1,17 +1,16 @@ # Radio 单选按钮 -## 介绍 用于在一组备选项中进行单选 -## 安装 +## 引入 ```tsx import { Radio } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/radio/doc.zh-TW.md b/src/packages/radio/doc.zh-TW.md index 1c7bfdfa3d..17636b1229 100644 --- a/src/packages/radio/doc.zh-TW.md +++ b/src/packages/radio/doc.zh-TW.md @@ -1,17 +1,17 @@ # Radio 單選按鈕 -## 介紹 + 用於在一組備選項中進行單選 -## 安裝 +## 引入 ```tsx import { Radio } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/range/doc.en-US.md b/src/packages/range/doc.en-US.md index 4741fa3648..a15b9dd081 100644 --- a/src/packages/range/doc.en-US.md +++ b/src/packages/range/doc.en-US.md @@ -1,10 +1,10 @@ # Range -## Intro + Slide the input bar to select a value within a given range. -## Install +## Import ```tsx import { Range } from '@nutui/nutui-react'; diff --git a/src/packages/range/doc.md b/src/packages/range/doc.md index 1116b9f76a..23cb00af7c 100644 --- a/src/packages/range/doc.md +++ b/src/packages/range/doc.md @@ -1,16 +1,15 @@ # Range 区间选择器 -## 介绍 滑动输入条,用于在给定的范围内选择一个值。 -## 安装 +## 引入 ```tsx import { Range } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/range/doc.taro.md b/src/packages/range/doc.taro.md index fa4d8d8351..fa736482a4 100644 --- a/src/packages/range/doc.taro.md +++ b/src/packages/range/doc.taro.md @@ -1,16 +1,15 @@ # Range 区间选择器 -## 介绍 滑动输入条,用于在给定的范围内选择一个值。 -## 安装 +## 引入 ```tsx import { Range } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/range/doc.zh-TW.md b/src/packages/range/doc.zh-TW.md index 18e92fd2b7..1bc5ec48c3 100644 --- a/src/packages/range/doc.zh-TW.md +++ b/src/packages/range/doc.zh-TW.md @@ -1,16 +1,16 @@ # Range 區間選擇器 -## 介紹 + 滑動輸入條,用於在給定的範圍內選擇一個值。 -## 安裝 +## 引入 ```tsx import { Range } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/rate/doc.en-US.md b/src/packages/rate/doc.en-US.md index ff1da72712..758e786286 100644 --- a/src/packages/rate/doc.en-US.md +++ b/src/packages/rate/doc.en-US.md @@ -1,10 +1,10 @@ # Rate -## Intro + Use for quick rating actions, or to showcase reviews. -## Install +## Import ```tsx import { Rate } from '@nutui/nutui-react'; diff --git a/src/packages/rate/doc.md b/src/packages/rate/doc.md index 1b34c5371d..53d3c6c596 100644 --- a/src/packages/rate/doc.md +++ b/src/packages/rate/doc.md @@ -1,16 +1,15 @@ # Rate 评分 -## 介绍 用于快速的评级操作,或对评价进行展示。 -## 安装 +## 引入 ```tsx import { Rate } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/rate/doc.taro.md b/src/packages/rate/doc.taro.md index ad74729f0b..f218cf3754 100644 --- a/src/packages/rate/doc.taro.md +++ b/src/packages/rate/doc.taro.md @@ -1,16 +1,15 @@ # Rate 评分 -## 介绍 用于快速的评级操作,或对评价进行展示。 -## 安装 +## 引入 ```tsx import { Rate } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/rate/doc.zh-TW.md b/src/packages/rate/doc.zh-TW.md index e836e9b69f..9cf429adf3 100644 --- a/src/packages/rate/doc.zh-TW.md +++ b/src/packages/rate/doc.zh-TW.md @@ -1,16 +1,16 @@ # Rate 評分 -## 介紹 + 用於快速的評級操作,或對評價進行展示。 -## 安裝 +## 引入 ```tsx import { Rate } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/safearea/doc.en-US.md b/src/packages/safearea/doc.en-US.md index 63b438bf28..ff1c25dc15 100644 --- a/src/packages/safearea/doc.en-US.md +++ b/src/packages/safearea/doc.en-US.md @@ -1,11 +1,11 @@ # SafeArea -## Intro + Provides adaptive margin adjustment in full screen.When the web page is displayed in full screen, automatic adaptation can be achieved with the help of the safe area. -## Install +## Import ```tsx import { SafeArea } from '@nutui/nutui-react'; diff --git a/src/packages/safearea/doc.md b/src/packages/safearea/doc.md index 777336b7f0..adf4cf6ddd 100644 --- a/src/packages/safearea/doc.md +++ b/src/packages/safearea/doc.md @@ -1,16 +1,15 @@ # SafeArea 安全区 -## 介绍 在全面屏下提供自适应的边距调整。当网页被全屏展示时,可借助安全区实现自动适配。 -## 安装 +## 引入 ```tsx import { SafeArea } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/safearea/doc.taro.md b/src/packages/safearea/doc.taro.md index cf84643adf..991da226f1 100644 --- a/src/packages/safearea/doc.taro.md +++ b/src/packages/safearea/doc.taro.md @@ -1,16 +1,15 @@ # SafeArea 安全区 -## 介绍 在全面屏下提供自适应的边距调整。当网页被全屏展示时,可借助安全区实现自动适配。 -## 安装 +## 引入 ```tsx import { SafeArea } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/safearea/doc.zh-TW.md b/src/packages/safearea/doc.zh-TW.md index 8ec104a2d5..3f6e29b001 100644 --- a/src/packages/safearea/doc.zh-TW.md +++ b/src/packages/safearea/doc.zh-TW.md @@ -1,16 +1,16 @@ # SafeArea 安全区 -## 介紹 + 在全面屏下提供自适应的边距调整。当网页被全屏展示时,可借助安全区实现自动适配。 -## 安装 +## 引入 ```tsx import { SafeArea } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/searchbar/doc.en-US.md b/src/packages/searchbar/doc.en-US.md index 8a87ee04b4..5fa278e079 100644 --- a/src/packages/searchbar/doc.en-US.md +++ b/src/packages/searchbar/doc.en-US.md @@ -1,10 +1,10 @@ # SearchBar -## Intro + The input box component used to search the scene. -## Install +## Import ```tsx import { SearchBar } from '@nutui/nutui-react'; diff --git a/src/packages/searchbar/doc.md b/src/packages/searchbar/doc.md index 8e0a64e4a5..61a7a78f6b 100644 --- a/src/packages/searchbar/doc.md +++ b/src/packages/searchbar/doc.md @@ -1,16 +1,15 @@ # SearchBar组件 -## 介绍 用于搜索场景的输入框组件。 -## 安装 +## 引入 ```tsx import { SearchBar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/searchbar/doc.taro.md b/src/packages/searchbar/doc.taro.md index 7a6cf25e9e..f736c9a2fb 100644 --- a/src/packages/searchbar/doc.taro.md +++ b/src/packages/searchbar/doc.taro.md @@ -1,16 +1,15 @@ # SearchBar组件 -## 介绍 用于搜索场景的输入框组件。 -## 安装 +## 引入 ```tsx import { SearchBar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/searchbar/doc.zh-TW.md b/src/packages/searchbar/doc.zh-TW.md index bce35e341f..6b71ba6a99 100644 --- a/src/packages/searchbar/doc.zh-TW.md +++ b/src/packages/searchbar/doc.zh-TW.md @@ -1,16 +1,16 @@ # SearchBar組件 -## 介紹 + 用於搜索場景的輸入框組件。 -## 安裝 +## 引入 ```tsx import { SearchBar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/shortpassword/doc.en-US.md b/src/packages/shortpassword/doc.en-US.md index 37a844c157..6c7a354d56 100644 --- a/src/packages/shortpassword/doc.en-US.md +++ b/src/packages/shortpassword/doc.en-US.md @@ -1,10 +1,10 @@ # ShortPassword -## Intro + Short password input box, which can be used to enter passwords, SMS verification codes, etc. -## Install +## Import ```tsx import { ShortPassword } from '@nutui/nutui-react'; diff --git a/src/packages/shortpassword/doc.md b/src/packages/shortpassword/doc.md index 52a1518642..4af70e3cd5 100644 --- a/src/packages/shortpassword/doc.md +++ b/src/packages/shortpassword/doc.md @@ -1,16 +1,15 @@ # ShortPassword 短密码 -## 介绍 短密码输入框,可用于输入密码、短信验证码等 -## 安装 +## 引入 ```tsx import { ShortPassword } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/shortpassword/doc.taro.md b/src/packages/shortpassword/doc.taro.md index 3db7d1fb64..b39763d0f4 100644 --- a/src/packages/shortpassword/doc.taro.md +++ b/src/packages/shortpassword/doc.taro.md @@ -1,16 +1,15 @@ # ShortPassword 短密码 -## 介绍 短密码输入框,可用于输入密码、短信验证码等 -## 安装 +## 引入 ```tsx import { ShortPassword } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/shortpassword/doc.zh-TW.md b/src/packages/shortpassword/doc.zh-TW.md index 67b2366a9b..32a51db60d 100644 --- a/src/packages/shortpassword/doc.zh-TW.md +++ b/src/packages/shortpassword/doc.zh-TW.md @@ -1,16 +1,16 @@ # ShortPassword 短密碼 -## 介紹 + 短密碼輸入框,可用於輸入密碼、短信驗證碼等 -## 安裝 +## 引入 ```tsx import { ShortPassword } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/sidenavbar/doc.en-US.md b/src/packages/sidenavbar/doc.en-US.md index 0ba9b85690..b99d7abe29 100644 --- a/src/packages/sidenavbar/doc.en-US.md +++ b/src/packages/sidenavbar/doc.en-US.md @@ -1,10 +1,10 @@ # SideNavBar组件 -## Intro + For content selection and switching -## Install +## Import ```tsx import { SideNavBar,SubSideNavBar,SideNavBarItem } from '@nutui/nutui-react'; diff --git a/src/packages/sidenavbar/doc.md b/src/packages/sidenavbar/doc.md index 9e4fbd6092..f162e016d3 100644 --- a/src/packages/sidenavbar/doc.md +++ b/src/packages/sidenavbar/doc.md @@ -1,16 +1,15 @@ # SideNavBar组件 -## 介绍 用于内容选择和切换 -## 安装 +## 引入 ```tsx import { SideNavBar,SubSideNavBar,SideNavBarItem } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/sidenavbar/doc.taro.md b/src/packages/sidenavbar/doc.taro.md index 1d0ec0906b..14639915ed 100644 --- a/src/packages/sidenavbar/doc.taro.md +++ b/src/packages/sidenavbar/doc.taro.md @@ -1,16 +1,15 @@ # SideNavBar组件 -## 介绍 用于内容选择和切换 -## 安装 +## 引入 ```tsx import { SideNavBar,SubSideNavBar,SideNavBarItem } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/sidenavbar/doc.zh-TW.md b/src/packages/sidenavbar/doc.zh-TW.md index 18de33c06d..eab47fa5e6 100644 --- a/src/packages/sidenavbar/doc.zh-TW.md +++ b/src/packages/sidenavbar/doc.zh-TW.md @@ -1,16 +1,16 @@ # SideNavBar組件 -## 介紹 + 用於內容選擇和切換 -## 安裝 +## 引入 ```tsx import { SideNavBar,SubSideNavBar,SideNavBarItem } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/signature/doc.en-US.md b/src/packages/signature/doc.en-US.md index 22d1741dcd..b8c98a1e7f 100644 --- a/src/packages/signature/doc.en-US.md +++ b/src/packages/signature/doc.en-US.md @@ -1,10 +1,10 @@ # Signature -## Intro + Signature component based on canvas. -## Install +## Import ```tsx import { Signature } from '@nutui/nutui-react' diff --git a/src/packages/signature/doc.md b/src/packages/signature/doc.md index c0f9f155fc..fdfe38c00e 100644 --- a/src/packages/signature/doc.md +++ b/src/packages/signature/doc.md @@ -1,16 +1,15 @@ # Signature 签名 -## 介绍 基于 Canvas 的签名组件 -## 安装 +## 引入 ```tsx import { Signature } from '@nutui/nutui-react' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/signature/doc.taro.md b/src/packages/signature/doc.taro.md index dd163be7eb..e7b62394aa 100644 --- a/src/packages/signature/doc.taro.md +++ b/src/packages/signature/doc.taro.md @@ -1,16 +1,15 @@ # Signature 签名 -## 介绍 基于 Canvas 的签名组件 -## 安装 +## 引入 ```tsx import { Signature } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/signature/doc.zh-TW.md b/src/packages/signature/doc.zh-TW.md index e142781de1..68b7d31829 100644 --- a/src/packages/signature/doc.zh-TW.md +++ b/src/packages/signature/doc.zh-TW.md @@ -1,16 +1,16 @@ # Signature 簽名 -## 介紹 + 基於 Canvas 的簽名組件 -## 安裝 +## 引入 ```tsx import { Signature } from '@nutui/nutui-react' ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/skeleton/doc.en-US.md b/src/packages/skeleton/doc.en-US.md index cba99febbe..f904f38f59 100644 --- a/src/packages/skeleton/doc.en-US.md +++ b/src/packages/skeleton/doc.en-US.md @@ -1,10 +1,10 @@ # Skeleton -## Intro + Filling gray bitmap in the area to be loaded on the page is essentially the transition effect in the process of interface loading. -## Install +## Import ```tsx import { Skeleton } from '@nutui/nutui-react'; diff --git a/src/packages/skeleton/doc.md b/src/packages/skeleton/doc.md index e1ad6e640b..b8767ab1b9 100644 --- a/src/packages/skeleton/doc.md +++ b/src/packages/skeleton/doc.md @@ -1,16 +1,15 @@ # Skeleton 骨架屏组件 -## 介绍 在页面上待加载区域填充灰色的占位图,本质上是界面加载过程中的过渡效果。 -## 安装 +## 引入 ```tsx import { Skeleton } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/skeleton/doc.taro.md b/src/packages/skeleton/doc.taro.md index ee912c379b..608baaf0b0 100644 --- a/src/packages/skeleton/doc.taro.md +++ b/src/packages/skeleton/doc.taro.md @@ -1,16 +1,15 @@ # Skeleton 骨架屏组件 -## 介绍 在页面上待加载区域填充灰色的占位图,本质上是界面加载过程中的过渡效果。 -## 安装 +## 引入 ```tsx import { Skeleton } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/skeleton/doc.zh-TW.md b/src/packages/skeleton/doc.zh-TW.md index 354a54bccb..89f055b37d 100644 --- a/src/packages/skeleton/doc.zh-TW.md +++ b/src/packages/skeleton/doc.zh-TW.md @@ -1,16 +1,16 @@ # Skeleton 骨架屏組件 -## 介紹 + 在頁面上待加載區域填充灰色的佔位圖,本質上是界面加載過程中的過渡效果。 -## 安裝 +## 引入 ```tsx import { Skeleton } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/space/doc.en-US.md b/src/packages/space/doc.en-US.md index 77122823d2..b62a9cea59 100644 --- a/src/packages/space/doc.en-US.md +++ b/src/packages/space/doc.en-US.md @@ -1,10 +1,10 @@ # Space -## Intro + Maintain the same width in the arrangement of elements. -## Install +## Import ```tsx import { Space } from '@nutui/nutui-react'; diff --git a/src/packages/space/doc.md b/src/packages/space/doc.md index 2fc652dfc6..8a8ccaf6b9 100644 --- a/src/packages/space/doc.md +++ b/src/packages/space/doc.md @@ -1,16 +1,15 @@ # Space 间距 -### 介绍 - +# 元素排列中保持相同的宽度。 -### 安装 +### 引入 ```tsx import { Space } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/space/doc.taro.md b/src/packages/space/doc.taro.md index c1bb6496cf..8f79b12060 100644 --- a/src/packages/space/doc.taro.md +++ b/src/packages/space/doc.taro.md @@ -1,16 +1,15 @@ # Space组件 -### 介绍 - +# 元素排列中保持相同的宽度。 -### 安装 +### 引入 ```tsx import { Space } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/space/doc.zh-TW.md b/src/packages/space/doc.zh-TW.md index c4b6fe28ce..e28e3e4b26 100644 --- a/src/packages/space/doc.zh-TW.md +++ b/src/packages/space/doc.zh-TW.md @@ -1,16 +1,16 @@ # Space 間距 -### 介紹 +# 元素排列中保持相同的寬度。 -### 安裝 +### 引入 ```tsx import { Space } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/steps/doc.en-US.md b/src/packages/steps/doc.en-US.md index 1b05f836b3..846f031ac0 100644 --- a/src/packages/steps/doc.en-US.md +++ b/src/packages/steps/doc.en-US.md @@ -1,10 +1,10 @@ # Steps -## Intro + Split and display the steps of a process, guide users to complete tasks according to the process, or show users the current status. -## Install +## Import ```tsx import { Steps } from '@nutui/nutui-react'; diff --git a/src/packages/steps/doc.md b/src/packages/steps/doc.md index 8b34f26f19..6b2069001b 100644 --- a/src/packages/steps/doc.md +++ b/src/packages/steps/doc.md @@ -1,16 +1,15 @@ # Steps 步骤条 -## 介绍 拆分展示某项流程的步骤,引导用户按流程完成任务或向用户展示当前状态。 -## 安装 +## 引入 ```tsx import { Steps } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/steps/doc.taro.md b/src/packages/steps/doc.taro.md index c8a9a097cb..d1983e1f1e 100644 --- a/src/packages/steps/doc.taro.md +++ b/src/packages/steps/doc.taro.md @@ -1,16 +1,15 @@ # Steps 步骤条 -## 介绍 拆分展示某项流程的步骤,引导用户按流程完成任务或向用户展示当前状态。 -## 安装 +## 引入 ```tsx import { Steps } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/steps/doc.zh-TW.md b/src/packages/steps/doc.zh-TW.md index e1c54b7cf0..d97968d177 100644 --- a/src/packages/steps/doc.zh-TW.md +++ b/src/packages/steps/doc.zh-TW.md @@ -1,16 +1,16 @@ # Steps 步驟條 -## 介紹 + 拆分展示某項流程的步驟,引導用戶按流程完成任務或嚮用戶展示當前狀態。 -## 安裝 +## 引入 ```tsx import { Steps } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/sticky/doc.en-US.md b/src/packages/sticky/doc.en-US.md index 97e22138c1..038ca51aab 100644 --- a/src/packages/sticky/doc.en-US.md +++ b/src/packages/sticky/doc.en-US.md @@ -1,10 +1,10 @@ # Sticky组件 -## Intro + The effect is the same as position: sticky in CSS, which can be used for compatibility with low-end browsers -## Install +## Import ```tsx import { Sticky } from '@nutui/nutui-react'; diff --git a/src/packages/sticky/doc.md b/src/packages/sticky/doc.md index a8ef005107..b4c6bd1752 100644 --- a/src/packages/sticky/doc.md +++ b/src/packages/sticky/doc.md @@ -1,16 +1,15 @@ # Sticky组件 -## 介绍 效果同 css 中的 position: sticky,对低端浏览器可使用其做兼容 -## 安装 +## 引入 ```tsx import { Sticky } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/sticky/doc.taro.md b/src/packages/sticky/doc.taro.md index 864d40b32c..bbcf70e801 100644 --- a/src/packages/sticky/doc.taro.md +++ b/src/packages/sticky/doc.taro.md @@ -1,18 +1,17 @@ # Sticky 组件 -## 介绍 效果同 css 中的 position: sticky,对低端浏览器可使用其做兼容 > 支持吸顶、吸底、容器内吸顶效果,也可以使用官方sticky组件 https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/extended/component-plus/sticky.html -## 安装 +## 引入 ```tsx import { Sticky } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/sticky/doc.zh-TW.md b/src/packages/sticky/doc.zh-TW.md index 37eacdea69..856b3f9bf4 100644 --- a/src/packages/sticky/doc.zh-TW.md +++ b/src/packages/sticky/doc.zh-TW.md @@ -1,16 +1,16 @@ # Sticky組件 -## 介紹 + 效果同 css 中的 position: sticky,對低端瀏覽器可使用其做兼容 -## 安裝 +## 引入 ```tsx import { Sticky } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/swipe/doc.en-US.md b/src/packages/swipe/doc.en-US.md index 1bf73f8ebb..d13faf3b90 100644 --- a/src/packages/swipe/doc.en-US.md +++ b/src/packages/swipe/doc.en-US.md @@ -1,10 +1,10 @@ # Swipe -## Intro + It is often used for gesture operations such as sliding left and right to delete cells -## Install +## Import ```tsx import { Swipe } from '@nutui/nutui-react'; diff --git a/src/packages/swipe/doc.md b/src/packages/swipe/doc.md index 9fdcb7f0d0..806e2346e5 100644 --- a/src/packages/swipe/doc.md +++ b/src/packages/swipe/doc.md @@ -1,16 +1,15 @@ # Swipe组件 -## 介绍 常用于单元格左右滑删除等手势操作 -## 安装 +## 引入 ```tsx import { Swipe } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/swipe/doc.taro.md b/src/packages/swipe/doc.taro.md index 4f887bb58c..963f59773e 100644 --- a/src/packages/swipe/doc.taro.md +++ b/src/packages/swipe/doc.taro.md @@ -1,16 +1,15 @@ # Swipe组件 -## 介绍 常用于单元格左右滑删除等手势操作 -## 安装 +## 引入 ```tsx import { Swipe } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/swipe/doc.zh-TW.md b/src/packages/swipe/doc.zh-TW.md index 69a71ab74a..b34c74ddff 100644 --- a/src/packages/swipe/doc.zh-TW.md +++ b/src/packages/swipe/doc.zh-TW.md @@ -1,16 +1,16 @@ # Swipe組件 -## 介紹 + 常用於單元格左右滑刪除等手勢操作 -## 安裝 +## 引入 ```tsx import { Swipe } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/swiper/doc.en-US.md b/src/packages/swiper/doc.en-US.md index f8051c0bcb..82676851a7 100644 --- a/src/packages/swiper/doc.en-US.md +++ b/src/packages/swiper/doc.en-US.md @@ -1,10 +1,10 @@ # Swiper -## Intro + Often used in a group of pictures or card rotation. -## Install +## Import ```tsx import { Swiper } from '@nutui/nutui-react'; diff --git a/src/packages/swiper/doc.md b/src/packages/swiper/doc.md index c99dc6b883..70c93c1c84 100644 --- a/src/packages/swiper/doc.md +++ b/src/packages/swiper/doc.md @@ -1,16 +1,15 @@ # Swiper 轮播 -## 介绍 常用于一组图片或卡片轮播,当内容空间不足时,可以用走马灯的形式进行收纳,进行轮播展现。 -## 安装 +## 引入 ```tsx import { Swiper } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/swiper/doc.taro.md b/src/packages/swiper/doc.taro.md index ef79df8702..7f2f7d25ef 100644 --- a/src/packages/swiper/doc.taro.md +++ b/src/packages/swiper/doc.taro.md @@ -1,16 +1,15 @@ # Swiper 轮播 -## 介绍 常用于一组图片或卡片轮播,当内容空间不足时,可以用走马灯的形式进行收纳,进行轮播展现。 -## 安装 +## 引入 ```tsx import { Swiper } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/swiper/doc.zh-TW.md b/src/packages/swiper/doc.zh-TW.md index d3120b6d14..9a3a44b1e3 100644 --- a/src/packages/swiper/doc.zh-TW.md +++ b/src/packages/swiper/doc.zh-TW.md @@ -1,16 +1,16 @@ # Swiper 輪播 -## 介紹 + 常用於一組圖片或卡片輪播,當內容空間不足時,可以用走馬燈的形式進行收納,進行輪播展現。 -## 安裝 +## 引入 ```tsx import { Swiper } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/switch/doc.en-US.md b/src/packages/switch/doc.en-US.md index ce7bfbf0a0..65d6643bd6 100644 --- a/src/packages/switch/doc.en-US.md +++ b/src/packages/switch/doc.en-US.md @@ -1,10 +1,10 @@ # Switch -## Introduction +duction Used to open or close the options. -## Install +## Import ```tsx import { Switch } from '@nutui/nutui-react'; diff --git a/src/packages/switch/doc.md b/src/packages/switch/doc.md index e397f662cf..b647e523a5 100644 --- a/src/packages/switch/doc.md +++ b/src/packages/switch/doc.md @@ -1,16 +1,15 @@ # Switch 开关 -## 介绍 用来打开或关闭选项。 -## 安装 +## 引入 ```tsx import { Switch } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 非受控 diff --git a/src/packages/switch/doc.taro.md b/src/packages/switch/doc.taro.md index be22d55e3c..843c5a2e49 100644 --- a/src/packages/switch/doc.taro.md +++ b/src/packages/switch/doc.taro.md @@ -1,16 +1,15 @@ # Switch 开关 -## 介绍 用来打开或关闭选项。 -## 安装 +## 引入 ```tsx import { Switch } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 非受控 diff --git a/src/packages/switch/doc.zh-TW.md b/src/packages/switch/doc.zh-TW.md index d0f81fb2ad..e464c23711 100644 --- a/src/packages/switch/doc.zh-TW.md +++ b/src/packages/switch/doc.zh-TW.md @@ -1,16 +1,16 @@ # Switch 開關 -## 介紹 + 用來打開或關閉選項。 -## 安裝 +## 引入 ```tsx import { Switch } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 非受控 diff --git a/src/packages/tabbar/doc.en-US.md b/src/packages/tabbar/doc.en-US.md index d0664124a2..8d87eb3dfe 100644 --- a/src/packages/tabbar/doc.en-US.md +++ b/src/packages/tabbar/doc.en-US.md @@ -1,10 +1,10 @@ # Tabbar -## Intro + Bottom Navigation Common Scenarios -## Install +## Import ```tsx import { Tabbar } from '@nutui/nutui-react'; diff --git a/src/packages/tabbar/doc.md b/src/packages/tabbar/doc.md index 731e2b8c04..3b7edfa55e 100644 --- a/src/packages/tabbar/doc.md +++ b/src/packages/tabbar/doc.md @@ -1,16 +1,15 @@ # Tabbar 标签栏 -## 介绍 底部导航常用场景 -## 安装 +## 引入 ```tsx import { Tabbar } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tabbar/doc.taro.md b/src/packages/tabbar/doc.taro.md index 257b60a9aa..ed4b39c3f8 100644 --- a/src/packages/tabbar/doc.taro.md +++ b/src/packages/tabbar/doc.taro.md @@ -1,16 +1,15 @@ # Tabbar 标签栏 -## 介绍 底部导航常用场景 -## 安装 +## 引入 ```tsx import { Tabbar } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tabbar/doc.zh-TW.md b/src/packages/tabbar/doc.zh-TW.md index 664787915e..06f69c6efa 100644 --- a/src/packages/tabbar/doc.zh-TW.md +++ b/src/packages/tabbar/doc.zh-TW.md @@ -1,16 +1,16 @@ # Tabbar 標簽欄 -## 介紹 + 底部導航常用場景 -## 安裝 +## 引入 ```tsx import { Tabbar } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/table/doc.en-US.md b/src/packages/table/doc.en-US.md index 9e53fd1928..20eb565db2 100644 --- a/src/packages/table/doc.en-US.md +++ b/src/packages/table/doc.en-US.md @@ -1,10 +1,10 @@ # Table -## Intro + Used for displaying basic tables. -## Install +## Import ```tsx import { Table } from '@nutui/nutui-react'; diff --git a/src/packages/table/doc.md b/src/packages/table/doc.md index c891637733..5c5b192fde 100644 --- a/src/packages/table/doc.md +++ b/src/packages/table/doc.md @@ -1,16 +1,15 @@ # Table组件 -## 介绍 用于展示基础表格 -## 安装 +## 引入 ```tsx import { Table } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/table/doc.taro.md b/src/packages/table/doc.taro.md index 45a9e68043..05f508eb83 100644 --- a/src/packages/table/doc.taro.md +++ b/src/packages/table/doc.taro.md @@ -1,16 +1,15 @@ # Table组件 -## 介绍 用于展示基础表格 -## 安装 +## 引入 ```tsx import { Table } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/table/doc.zh-TW.md b/src/packages/table/doc.zh-TW.md index f89b6c3b71..0885545170 100644 --- a/src/packages/table/doc.zh-TW.md +++ b/src/packages/table/doc.zh-TW.md @@ -1,16 +1,16 @@ # Table組件 -## 介紹 + 用於展示基礎表格。 -## 安裝 +## 引入 ```tsx import { Table } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/tabs/doc.en-US.md b/src/packages/tabs/doc.en-US.md index b19be867de..7ee41422ab 100644 --- a/src/packages/tabs/doc.en-US.md +++ b/src/packages/tabs/doc.en-US.md @@ -1,10 +1,10 @@ # Tabs -## Intro + It is often used for the storage and display of large blocks of content in the level area, and supports the form of embedded tags and rendering loop data. -## Install +## Import ```tsx import { Tabs } from '@nutui/nutui-react'; diff --git a/src/packages/tabs/doc.md b/src/packages/tabs/doc.md index 2c9183faa5..de0b34e7ea 100644 --- a/src/packages/tabs/doc.md +++ b/src/packages/tabs/doc.md @@ -1,16 +1,15 @@ # Tabs 选项卡切换 -## 介绍 常用于平级区域大块内容的的收纳和展现,支持内嵌标签形式和渲染循环数据形式 -## 安装 +## 引入 ```tsx import { Tabs } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tabs/doc.taro.md b/src/packages/tabs/doc.taro.md index da9718ca1a..2ad5a7f732 100644 --- a/src/packages/tabs/doc.taro.md +++ b/src/packages/tabs/doc.taro.md @@ -1,16 +1,15 @@ # Tabs 选项卡切换 -## 介绍 常用于平级区域大块内容的的收纳和展现,支持内嵌标签形式和渲染循环数据形式 -## 安装 +## 引入 ```tsx import { Tabs } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tabs/doc.zh-TW.md b/src/packages/tabs/doc.zh-TW.md index 83919406cf..3775e2f275 100644 --- a/src/packages/tabs/doc.zh-TW.md +++ b/src/packages/tabs/doc.zh-TW.md @@ -1,16 +1,16 @@ # Tabs 選項卡切換 -## 介紹 + 常用於平級區域大塊內容的的收納和展現,支持內嵌標簽形式和渲染循環數據形式 -## 安裝 +## 引入 ```tsx import { Tabs } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/tag/doc.en-US.md b/src/packages/tag/doc.en-US.md index a5208358f0..9d13573c22 100644 --- a/src/packages/tag/doc.en-US.md +++ b/src/packages/tag/doc.en-US.md @@ -1,10 +1,10 @@ # Tag -## Intro + Label for labeling and classification. -## Install +## Import ```tsx import { Tag } from '@nutui/nutui-react'; diff --git a/src/packages/tag/doc.md b/src/packages/tag/doc.md index 26b25e1808..bf47d14844 100644 --- a/src/packages/tag/doc.md +++ b/src/packages/tag/doc.md @@ -1,16 +1,15 @@ # Tag 标签 -## 介绍 用于标记和分类的标签。 -## 安装 +## 引入 ```tsx import { Tag } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tag/doc.taro.md b/src/packages/tag/doc.taro.md index 3562757788..82a5b07e9e 100644 --- a/src/packages/tag/doc.taro.md +++ b/src/packages/tag/doc.taro.md @@ -1,10 +1,9 @@ # Tag 标签 -## 介绍 用于标记和分类的标签。 -## 安装 +## 引入 ```tsx import { Tag } from '@nutui/nutui-react-taro'; diff --git a/src/packages/tag/doc.zh-TW.md b/src/packages/tag/doc.zh-TW.md index 0f3add86b3..ede2aa98f3 100644 --- a/src/packages/tag/doc.zh-TW.md +++ b/src/packages/tag/doc.zh-TW.md @@ -1,16 +1,16 @@ # Tag 標簽 -## 介紹 + 用於標記和分類的標簽。 -## 安裝 +## 引入 ```tsx import { Tag } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/textarea/doc.en-US.md b/src/packages/textarea/doc.en-US.md index be7ec46a19..5b46e15b8e 100644 --- a/src/packages/textarea/doc.en-US.md +++ b/src/packages/textarea/doc.en-US.md @@ -1,10 +1,10 @@ # TextArea -## Intro + Enter or edit text in the text box, and limit the number of entries is supported. -## Install +## Import ```tsx import { TextArea } from '@nutui/nutui-react'; diff --git a/src/packages/textarea/doc.md b/src/packages/textarea/doc.md index b866128a37..f377157f2d 100644 --- a/src/packages/textarea/doc.md +++ b/src/packages/textarea/doc.md @@ -1,16 +1,15 @@ # TextArea 文本域 -## 介绍 文本框内输入或编辑文字,支持限制输入数量。 -## 安装 +## 引入 ```tsx import { TextArea } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/textarea/doc.taro.md b/src/packages/textarea/doc.taro.md index ce5fcf3d93..bba3de069d 100644 --- a/src/packages/textarea/doc.taro.md +++ b/src/packages/textarea/doc.taro.md @@ -1,16 +1,15 @@ # TextArea 文本域 -## 介绍 文本框内输入或编辑文字,支持限制输入数量。 -## 安装 +## 引入 ```tsx import { TextArea } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/textarea/doc.zh-TW.md b/src/packages/textarea/doc.zh-TW.md index eaa3c5b3ec..36b2b6a8d9 100644 --- a/src/packages/textarea/doc.zh-TW.md +++ b/src/packages/textarea/doc.zh-TW.md @@ -1,16 +1,16 @@ # TextArea 文本域 -## 介紹 + 文本框內輸入或編輯文字,支持限制輸入數量。 -## 安裝 +## 引入 ```tsx import { TextArea } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/timeselect/doc.en-US.md b/src/packages/timeselect/doc.en-US.md index 1c68190391..1414c9ef00 100644 --- a/src/packages/timeselect/doc.en-US.md +++ b/src/packages/timeselect/doc.en-US.md @@ -1,10 +1,10 @@ # TimeSelect -## Intro + For delivery time selection -## Install +## Import ```tsx import { TimeSelect } from '@nutui/nutui-react'; diff --git a/src/packages/timeselect/doc.md b/src/packages/timeselect/doc.md index 0146a43c4c..6cf20f90f1 100644 --- a/src/packages/timeselect/doc.md +++ b/src/packages/timeselect/doc.md @@ -1,16 +1,15 @@ # TimeSelect 配送时间 -## 介绍 用于配送时间选择 -## 安装 +## 引入 ```tsx import { TimeSelect } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/timeselect/doc.taro.md b/src/packages/timeselect/doc.taro.md index f226eb764f..2d1d454cab 100644 --- a/src/packages/timeselect/doc.taro.md +++ b/src/packages/timeselect/doc.taro.md @@ -1,16 +1,15 @@ # TimeSelect 配送时间 -## 介绍 用于配送时间选择 -## 安装 +## 引入 ```tsx import { TimeSelect } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/timeselect/doc.zh-TW.md b/src/packages/timeselect/doc.zh-TW.md index 54cd9e051c..8a39901b93 100644 --- a/src/packages/timeselect/doc.zh-TW.md +++ b/src/packages/timeselect/doc.zh-TW.md @@ -1,16 +1,16 @@ # TimeSelect 配送時間 -## 介紹 + 用於配送時間選擇 -## 安裝 +## 引入 ```tsx import { TimeSelect } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/toast/doc.en-US.md b/src/packages/toast/doc.en-US.md index 8eeb23b86a..589e75fead 100644 --- a/src/packages/toast/doc.en-US.md +++ b/src/packages/toast/doc.en-US.md @@ -1,10 +1,10 @@ # Toast -## Intro + For light tips. -## Install +## Import ```tsx import { Toast } from '@nutui/nutui-react'; diff --git a/src/packages/toast/doc.md b/src/packages/toast/doc.md index b9fafc2ec0..b2786c2049 100644 --- a/src/packages/toast/doc.md +++ b/src/packages/toast/doc.md @@ -1,10 +1,9 @@ # Toast 吐司 -## 介绍 用于轻提示。 -## 安装 +## 引入 ```tsx import { Toast } from '@nutui/nutui-react'; diff --git a/src/packages/toast/doc.taro.md b/src/packages/toast/doc.taro.md index 7712dcfd7d..29cadd190a 100644 --- a/src/packages/toast/doc.taro.md +++ b/src/packages/toast/doc.taro.md @@ -1,12 +1,11 @@ # Toast 吐司 -## 介绍 用于轻提示。 > 当前组件 Taro 环境暂不支持函数式调用,推荐使用 Taro.API 使用原生组件 https://taro-docs.jd.com/taro/docs/apis/ui/interaction/showToast -## 安装 +## 引入 ```tsx import { Toast } from '@nutui/nutui-react-taro'; diff --git a/src/packages/toast/doc.zh-TW.md b/src/packages/toast/doc.zh-TW.md index 3b146f116c..2723a94c73 100644 --- a/src/packages/toast/doc.zh-TW.md +++ b/src/packages/toast/doc.zh-TW.md @@ -1,16 +1,16 @@ # Toast 吐司 -### 介紹 +# 用於輕提示。 -### 安裝 +### 引入 ```tsx import { Toast } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 文字提示 diff --git a/src/packages/tour/doc.en-US.md b/src/packages/tour/doc.en-US.md index 9422d68a90..c315b33cf5 100644 --- a/src/packages/tour/doc.en-US.md +++ b/src/packages/tour/doc.en-US.md @@ -1,10 +1,10 @@ # Tour -### Intro +# A bubble component used to guide the user through the product's capabilities. -## Install +## Import ```tsx import { Tour } from '@nutui/nutui-react'; diff --git a/src/packages/tour/doc.md b/src/packages/tour/doc.md index d8f712dfed..a861372659 100644 --- a/src/packages/tour/doc.md +++ b/src/packages/tour/doc.md @@ -1,16 +1,15 @@ # Tour 引导 -### 介绍 - +# 用于引导用户了解产品功能的气泡组件。 -## 安装 +## 引入 ```tsx import { Tour } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tour/doc.taro.md b/src/packages/tour/doc.taro.md index 92c463fb0b..328aa5e5a9 100644 --- a/src/packages/tour/doc.taro.md +++ b/src/packages/tour/doc.taro.md @@ -1,16 +1,15 @@ # Tour 引导 -### 介绍 - +# 用于引导用户了解产品功能的气泡组件。 -## 安装 +## 引入 ```tsx import { Tour } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/tour/doc.zh-TW.md b/src/packages/tour/doc.zh-TW.md index 4bc2574a3f..0f917166f5 100644 --- a/src/packages/tour/doc.zh-TW.md +++ b/src/packages/tour/doc.zh-TW.md @@ -1,16 +1,16 @@ # Tour 引導 -### 介紹 +# 用於引導用戶了解產品功能的氣泡組件。 -## 安裝 +## 引入 ```tsx import { Tour } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/trendarrow/doc.en-US.md b/src/packages/trendarrow/doc.en-US.md index e5deeb60eb..02af643f19 100644 --- a/src/packages/trendarrow/doc.en-US.md +++ b/src/packages/trendarrow/doc.en-US.md @@ -1,10 +1,10 @@ # TrendArrow -## Intro + A percentage number with an arrow indicating the trend of the indicator -## Install +## Import ```tsx import { TrendArrow } from '@nutui/nutui-react'; diff --git a/src/packages/trendarrow/doc.md b/src/packages/trendarrow/doc.md index e7f33e337b..7a026dd215 100644 --- a/src/packages/trendarrow/doc.md +++ b/src/packages/trendarrow/doc.md @@ -1,16 +1,15 @@ # TrendArrow 指标趋势 -## 介绍 带有箭头指示的百分比数字,用以展示指标趋势 -## 安装 +## 引入 ```tsx import { TrendArrow } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/trendarrow/doc.taro.md b/src/packages/trendarrow/doc.taro.md index 89d3a8be5c..0a55aa407d 100644 --- a/src/packages/trendarrow/doc.taro.md +++ b/src/packages/trendarrow/doc.taro.md @@ -1,16 +1,15 @@ # TrendArrow 指标趋势 -## 介绍 带有箭头指示的百分比数字,用以展示指标趋势 -## 安装 +## 引入 ```tsx import { TrendArrow } from '@nutui/nutui-react-taro' ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/trendarrow/doc.zh-TW.md b/src/packages/trendarrow/doc.zh-TW.md index 275fd7dfa5..510d621e6e 100644 --- a/src/packages/trendarrow/doc.zh-TW.md +++ b/src/packages/trendarrow/doc.zh-TW.md @@ -1,16 +1,16 @@ # TrendArrow 指標趨勢 -## 介紹 + 帶有箭頭指示的百分比數字,用以展示指標趨勢 -## 安裝 +## 引入 ```tsx import { TrendArrow } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/uploader/doc.en-US.md b/src/packages/uploader/doc.en-US.md index ce77158557..c06d0d8b29 100644 --- a/src/packages/uploader/doc.en-US.md +++ b/src/packages/uploader/doc.en-US.md @@ -1,10 +1,10 @@ # Uploader -## Intro + Used to upload local pictures or files to the server. -## Install +## Import ```tsx import { Uploader } from '@nutui/nutui-react'; diff --git a/src/packages/uploader/doc.md b/src/packages/uploader/doc.md index 3554fbe0bc..cf25e5e9df 100644 --- a/src/packages/uploader/doc.md +++ b/src/packages/uploader/doc.md @@ -1,16 +1,15 @@ # Uploader 上传 -## 介绍 用于将本地的图片或文件上传至服务器。 -## 安装 +## 引入 ```tsx import { Uploader } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/uploader/doc.taro.md b/src/packages/uploader/doc.taro.md index bd8bc53ab1..1e4aa9c5af 100644 --- a/src/packages/uploader/doc.taro.md +++ b/src/packages/uploader/doc.taro.md @@ -1,16 +1,15 @@ # Uploader 上传 -## 介绍 用于将本地的图片或文件上传至服务器。 -## 安装 +## 引入 ```tsx import { Uploader } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/uploader/doc.zh-TW.md b/src/packages/uploader/doc.zh-TW.md index e2b84f06b2..170da61860 100644 --- a/src/packages/uploader/doc.zh-TW.md +++ b/src/packages/uploader/doc.zh-TW.md @@ -1,16 +1,16 @@ # Uploader 上傳 -## 介紹 + 用於將本地的圖片或文件上傳至服務器。 -## 安裝 +## 引入 ```tsx import { Uploader } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/video/doc.en-US.md b/src/packages/video/doc.en-US.md index 684eaf8a5e..6b86110970 100644 --- a/src/packages/video/doc.en-US.md +++ b/src/packages/video/doc.en-US.md @@ -1,10 +1,10 @@ # Video -## Intro + Video player implemented by native video -## Install +## Import ```tsx import { Video } from '@nutui/nutui-react'; diff --git a/src/packages/video/doc.md b/src/packages/video/doc.md index b4f5a32bc9..4f39407b42 100644 --- a/src/packages/video/doc.md +++ b/src/packages/video/doc.md @@ -1,16 +1,15 @@ # Video 视频播放器 -## 介绍 原生video实现的视频播放器 -## 安装 +## 引入 ```tsx import { Video } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/video/doc.taro.md b/src/packages/video/doc.taro.md index a7520fa419..313dfee06d 100644 --- a/src/packages/video/doc.taro.md +++ b/src/packages/video/doc.taro.md @@ -1,16 +1,15 @@ # Video 视频播放器 -## 介绍 借助 Taro Video 标签实现的视频播放器,可以透传使用 Taro Video 的属性。 -## 安装 +## 引入 ```tsx import { Video } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/video/doc.zh-TW.md b/src/packages/video/doc.zh-TW.md index 03f1eeb0a4..0ea19a9d05 100644 --- a/src/packages/video/doc.zh-TW.md +++ b/src/packages/video/doc.zh-TW.md @@ -1,16 +1,16 @@ # Video 視頻播放器 -## 介紹 + 原生video實現的視頻播放器 -## 安裝 +## 引入 ```tsx import { Video } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 diff --git a/src/packages/virtuallist/doc.en-US.md b/src/packages/virtuallist/doc.en-US.md index 5bbc5bf987..2de1502cbb 100644 --- a/src/packages/virtuallist/doc.en-US.md +++ b/src/packages/virtuallist/doc.en-US.md @@ -1,10 +1,10 @@ # VirtualList -## Intro + In normal list show and pull-up loading, we usually use the InfiniteLoading component provided by NutUI. If we load a large amount of data, serious performance problems may occur, resulting in the view unable to respond to the operation for a period of time. At this time, we use the virtual list component list, which can ensure that only the current visual area is rendered, Other parts are rendered after the user scrolls to the visible area. Ensure page flow and improve performance. -## Install +## Import ```tsx import { Virtuallist } from '@nutui/nutui-react'; diff --git a/src/packages/virtuallist/doc.md b/src/packages/virtuallist/doc.md index 94f5fbdb7b..9f4e5f5803 100644 --- a/src/packages/virtuallist/doc.md +++ b/src/packages/virtuallist/doc.md @@ -1,16 +1,15 @@ # VirtualList 虚拟列表 -## 介绍 在正常的列表展示以及上拉加载中,我们通常使用 NutUI-React 提供的 滚动加载 组件,那如果我们加载的数据量非常大时,则可能会产生严重的性能问题,导致视图无法响应操作一段时间,这时候我们就用到了虚拟列表组件 VirtualList,它可以保证只渲染当前可视区域,其他部分在用户滚动到可视区域内之后再渲染。保证了页面流程度,提升性能。 -## 安装 +## 引入 ```tsx import { VirtualList } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法-垂直等高 diff --git a/src/packages/virtuallist/doc.taro.md b/src/packages/virtuallist/doc.taro.md index c3b09090a2..e5c4db90ba 100644 --- a/src/packages/virtuallist/doc.taro.md +++ b/src/packages/virtuallist/doc.taro.md @@ -1,16 +1,15 @@ # VirtualList 虚拟列表 -## 介绍 在正常的列表展示以及上拉加载中,我们通常使用 NutUI-React 提供的 滚动加载 组件,那如果我们加载的数据量非常大时,则可能会产生严重的性能问题,导致视图无法响应操作一段时间,这时候我们就用到了虚拟列表组件 VirtualList,它可以保证只渲染当前可视区域,其他部分在用户滚动到可视区域内之后再渲染。保证了页面流程度,提升性能。 -## 安装 +## 引入 ```tsx import { VirtualList } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法-垂直等高 diff --git a/src/packages/virtuallist/doc.zh-TW.md b/src/packages/virtuallist/doc.zh-TW.md index ec7952d35a..dd18c18491 100644 --- a/src/packages/virtuallist/doc.zh-TW.md +++ b/src/packages/virtuallist/doc.zh-TW.md @@ -1,16 +1,16 @@ # VirtualList 虛擬列錶 -## 介紹 + 在正常的列錶展示以及上拉加載中,我們通常使用 NutUI-React 提供的 滾動加載 組件,那如果我們加載的數據量非常大時,則可能會產生嚴重的性能問題,導致視圖無法響應操作一段時間,這時候我們就用到了虛擬列錶組件 VirtualList,它可以保證只渲染當前可視區域,其他部分在用戶滾動到可視區域內之後再渲染。保證了頁面流程度,提升性能。 -## 安裝 +## 引入 ```tsx import { VirtualList } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法-垂直等高 diff --git a/src/packages/watermark/doc.en-US.md b/src/packages/watermark/doc.en-US.md index b43e545598..7d0c5e6ded 100644 --- a/src/packages/watermark/doc.en-US.md +++ b/src/packages/watermark/doc.en-US.md @@ -1,10 +1,10 @@ # Watermark -## Intro + Add specific words or patterns on the page to prevent information theft. -## Install +## Import ```tsx import { WaterMark } from '@nutui/nutui-react'; diff --git a/src/packages/watermark/doc.md b/src/packages/watermark/doc.md index c3cb6f331d..1a437e68d6 100644 --- a/src/packages/watermark/doc.md +++ b/src/packages/watermark/doc.md @@ -1,16 +1,15 @@ # Watermark 水印 -## 介绍 页面上添加特定的文字或图案,可用于防止信息盗用。 -## 安装 +## 引入 ```tsx import { WaterMark } from '@nutui/nutui-react'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/watermark/doc.taro.md b/src/packages/watermark/doc.taro.md index ed3a0afa24..e934da287c 100644 --- a/src/packages/watermark/doc.taro.md +++ b/src/packages/watermark/doc.taro.md @@ -1,16 +1,15 @@ # Watermark 水印 -## 介绍 页面上添加特定的文字或图案,可用于防止信息盗用。 -## 安装 +## 引入 ```tsx import { Watermark } from '@nutui/nutui-react-taro'; ``` -## 代码演示 +## 示例代码 ### 基础用法 diff --git a/src/packages/watermark/doc.zh-TW.md b/src/packages/watermark/doc.zh-TW.md index e6dd1b2ed4..be6c3ebbbf 100644 --- a/src/packages/watermark/doc.zh-TW.md +++ b/src/packages/watermark/doc.zh-TW.md @@ -1,31 +1,29 @@ # Watermark 水印 -## 介紹 - 頁面上添加特定的文字或圖案,可用於防止信息盜用。 -## 安裝 +## 引入 ```tsx import { WaterMark } from '@nutui/nutui-react'; ``` -## 代碼演示 +## 示例代碼 ### 基礎用法 -:::demo - - - +:::demo + + + ::: ### 局部用法 -:::demo - - - +:::demo + + + ::: ## WaterMark @@ -57,4 +55,4 @@ import { WaterMark } from '@nutui/nutui-react'; | 名稱 | 說明 | 默認值 | | --- | --- | --- | -| \--nutui-watermark-z-index | zIndex | `$mask-content-z-index` | \ No newline at end of file +| \--nutui-watermark-z-index | zIndex | `$mask-content-z-index` |