From a3965f240003e830d4f4bc03364ff37eed84d547 Mon Sep 17 00:00:00 2001 From: Eiinu Date: Fri, 28 Jul 2023 00:30:06 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E7=BB=84=E4=BB=B6=E6=96=87=E6=A1=A3=20?= =?UTF-8?q?demo=20=E4=BB=A3=E7=A0=81=E8=B5=B0=E6=9F=A5=E4=BF=AE=E6=94=B9?= =?UTF-8?q?=20(#2459)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/packages/__VUE/address/doc.en-US.md | 37 ++- src/packages/__VUE/address/doc.md | 3 - src/packages/__VUE/address/doc.taro.md | 16 +- src/packages/__VUE/addresslist/doc.en-US.md | 1 - src/packages/__VUE/addresslist/doc.md | 1 - src/packages/__VUE/addresslist/doc.taro.md | 1 - src/packages/__VUE/audio/doc.en-US.md | 163 +++-------- src/packages/__VUE/audio/doc.md | 163 +++-------- src/packages/__VUE/backtop/doc.en-US.md | 161 ++--------- src/packages/__VUE/backtop/doc.md | 161 ++--------- src/packages/__VUE/backtop/doc.taro.md | 60 +--- .../__VUE/circleprogress/doc.en-US.md | 3 +- src/packages/__VUE/circleprogress/doc.md | 3 +- src/packages/__VUE/circleprogress/doc.taro.md | 3 +- src/packages/__VUE/empty/doc.en-US.md | 1 + src/packages/__VUE/empty/doc.md | 1 + src/packages/__VUE/empty/doc.taro.md | 1 + src/packages/__VUE/fixednav/doc.en-US.md | 237 +++++++++++----- src/packages/__VUE/fixednav/doc.md | 241 +++++++++++----- src/packages/__VUE/fixednav/doc.taro.md | 208 ++++++++------ src/packages/__VUE/form/doc.en-US.md | 114 ++++---- src/packages/__VUE/form/doc.md | 122 +++++---- src/packages/__VUE/form/doc.taro.md | 118 ++++---- .../__VUE/infiniteloading/doc.en-US.md | 259 +++++++----------- src/packages/__VUE/infiniteloading/doc.md | 259 +++++++----------- src/packages/__VUE/invoice/doc.en-US.md | 1 - src/packages/__VUE/invoice/doc.md | 1 - src/packages/__VUE/invoice/doc.taro.md | 1 - src/packages/__VUE/navbar/doc.en-US.md | 126 ++++----- src/packages/__VUE/navbar/doc.md | 128 ++++----- src/packages/__VUE/navbar/doc.taro.md | 138 ++++------ src/packages/__VUE/pullrefresh/doc.en-US.md | 109 ++++---- src/packages/__VUE/pullrefresh/doc.md | 109 ++++---- src/packages/__VUE/rate/doc.en-US.md | 164 ++++------- src/packages/__VUE/rate/doc.md | 164 ++++------- src/packages/__VUE/rate/doc.taro.md | 172 ++++-------- src/packages/__VUE/signature/doc.en-US.md | 92 +++---- src/packages/__VUE/signature/doc.md | 92 +++---- src/packages/__VUE/signature/doc.taro.md | 96 ++++--- src/packages/__VUE/steps/doc.en-US.md | 72 ++--- src/packages/__VUE/steps/doc.md | 72 ++--- src/packages/__VUE/steps/doc.taro.md | 72 ++--- src/packages/__VUE/sticky/doc.en-US.md | 34 ++- src/packages/__VUE/sticky/doc.md | 34 ++- src/packages/__VUE/sticky/doc.taro.md | 16 +- src/packages/__VUE/swipe/doc.en-US.md | 4 +- src/packages/__VUE/swipe/doc.md | 4 +- src/packages/__VUE/swipe/doc.taro.md | 4 +- src/packages/__VUE/switch/doc.en-US.md | 143 +++------- src/packages/__VUE/switch/doc.md | 139 +++------- src/packages/__VUE/switch/doc.taro.md | 135 +++------ src/packages/__VUE/table/doc.md | 4 +- src/packages/__VUE/table/doc.taro.md | 4 +- src/packages/__VUE/textarea/doc.en-US.md | 31 ++- src/packages/__VUE/textarea/doc.md | 39 +-- src/packages/__VUE/textarea/doc.taro.md | 29 +- 56 files changed, 1878 insertions(+), 2688 deletions(-) diff --git a/src/packages/__VUE/address/doc.en-US.md b/src/packages/__VUE/address/doc.en-US.md index 8b095b34e1..82505adb02 100644 --- a/src/packages/__VUE/address/doc.en-US.md +++ b/src/packages/__VUE/address/doc.en-US.md @@ -66,7 +66,7 @@ app.use(Address); const onChange = (cal) => { const name = address[cal.next]; - if (name.length < 1) { + if (!name || name.length < 1) { showPopup.value = false; } }; @@ -101,7 +101,6 @@ If you want to select a province, you need to set the region ID in the order of @change="onChange" @close="close" custom-address-title="Choose City" - :columns-placeholder="placeholder" > + ``` ::: @@ -528,10 +544,9 @@ If you want to select a province, you need to set the region ID in the order of console.log('点击了自定义地址左上角的返回按钮'); } }; - const onChange = (cal) => { const name = address[cal.next]; - if (name.length < 1) { + if (!name || name.length < 1) { showPopupOther.value = false; } }; diff --git a/src/packages/__VUE/address/doc.md b/src/packages/__VUE/address/doc.md index c55187ff5b..35afc37496 100644 --- a/src/packages/__VUE/address/doc.md +++ b/src/packages/__VUE/address/doc.md @@ -101,7 +101,6 @@ app.use(Address); @change="onChange" @close="close" custom-address-title="请选择所在地区" - :columns-placeholder="placeholder" > ``` ::: @@ -52,47 +32,23 @@ app.use(Audio); ```vue - ``` @@ -87,54 +44,19 @@ app.use(Backtop); :::demo -```html +```vue ``` @@ -144,54 +66,19 @@ app.use(Backtop); :::demo -```html +```vue ``` diff --git a/src/packages/__VUE/backtop/doc.md b/src/packages/__VUE/backtop/doc.md index 3061ac4ca7..0e8d513ad0 100644 --- a/src/packages/__VUE/backtop/doc.md +++ b/src/packages/__VUE/backtop/doc.md @@ -6,7 +6,7 @@ ### 安装 -```javascript +```js import { createApp } from 'vue'; import { Backtop } from '@nutui/nutui'; @@ -18,66 +18,23 @@ app.use(Backtop); :::demo -```html +```vue - ``` @@ -87,54 +44,19 @@ app.use(Backtop); :::demo -```html +```vue ``` @@ -144,54 +66,19 @@ app.use(Backtop); :::demo -```html +```vue ``` diff --git a/src/packages/__VUE/backtop/doc.taro.md b/src/packages/__VUE/backtop/doc.taro.md index 68ae598558..c79b10dbe2 100644 --- a/src/packages/__VUE/backtop/doc.taro.md +++ b/src/packages/__VUE/backtop/doc.taro.md @@ -6,7 +6,7 @@ ### 安装 -```javascript +```js import { createApp } from 'vue'; import { Backtop } from '@nutui/nutui-taro'; @@ -18,64 +18,16 @@ app.use(Backtop); ```html - + - ``` diff --git a/src/packages/__VUE/circleprogress/doc.en-US.md b/src/packages/__VUE/circleprogress/doc.en-US.md index 53ff83cac0..edd0f467ae 100644 --- a/src/packages/__VUE/circleprogress/doc.en-US.md +++ b/src/packages/__VUE/circleprogress/doc.en-US.md @@ -92,8 +92,7 @@ const gradientColor = { add ``` diff --git a/src/packages/__VUE/empty/doc.md b/src/packages/__VUE/empty/doc.md index 56cf46ab31..81d7edb225 100644 --- a/src/packages/__VUE/empty/doc.md +++ b/src/packages/__VUE/empty/doc.md @@ -45,6 +45,7 @@ app.use(Empty); ``` diff --git a/src/packages/__VUE/empty/doc.taro.md b/src/packages/__VUE/empty/doc.taro.md index 1c3670adc4..b6ed791bf2 100644 --- a/src/packages/__VUE/empty/doc.taro.md +++ b/src/packages/__VUE/empty/doc.taro.md @@ -45,6 +45,7 @@ app.use(Empty); ``` diff --git a/src/packages/__VUE/fixednav/doc.en-US.md b/src/packages/__VUE/fixednav/doc.en-US.md index 266dfb3b5a..258dec8347 100644 --- a/src/packages/__VUE/fixednav/doc.en-US.md +++ b/src/packages/__VUE/fixednav/doc.en-US.md @@ -6,7 +6,7 @@ Hover stow experience Interaction for quick navigation ### Install -```javascript +```js import { createApp } from 'vue'; import { FixedNav } from '@nutui/nutui'; @@ -18,44 +18,36 @@ app.use(FixedNav); :::demo -```html +```vue - ``` @@ -63,31 +55,130 @@ app.use(FixedNav); ### Left effect -```html - +:::demo + +```vue + + ``` +::: + ### Unmask background -```html - +:::demo + +```vue + + ``` +::: + ### Support drag and drop with drag -```html - - - +:::demo + +```vue + + ``` +::: + ### Custom use :::demo -```html +```vue - ``` diff --git a/src/packages/__VUE/fixednav/doc.md b/src/packages/__VUE/fixednav/doc.md index bf51e6b7d8..3bddd459eb 100644 --- a/src/packages/__VUE/fixednav/doc.md +++ b/src/packages/__VUE/fixednav/doc.md @@ -6,7 +6,7 @@ ### 安装 -```javascript +```js import { createApp } from 'vue'; import { FixedNav } from '@nutui/nutui'; @@ -18,44 +18,36 @@ app.use(FixedNav); :::demo -```html +```vue - ``` @@ -63,31 +55,130 @@ app.use(FixedNav); ### 左侧效果 -```html - +:::demo + +```vue + + ``` +::: + ### 取消背景遮罩 -```html - +:::demo + +```vue + + ``` -### 配合 Drag 支持拖拽 , 小程序暂不支持 +::: + +### 配合 Drag 支持拖拽 + +:::demo -```html - - - +```vue + + ``` +::: + ### 自定义使用 :::demo -```html +```vue - ``` diff --git a/src/packages/__VUE/fixednav/doc.taro.md b/src/packages/__VUE/fixednav/doc.taro.md index 32ad6884dc..e2ecf919c5 100644 --- a/src/packages/__VUE/fixednav/doc.taro.md +++ b/src/packages/__VUE/fixednav/doc.taro.md @@ -6,7 +6,7 @@ ### 安装 -```javascript +```js import { createApp } from 'vue'; import { FixedNav } from '@nutui/nutui-taro'; @@ -18,44 +18,36 @@ app.use(FixedNav); :::demo -```html +```vue - ``` @@ -63,31 +55,89 @@ app.use(FixedNav); ### 左侧效果 -```html - +:::demo + +```vue + + ``` -### 取消背景遮罩 +::: -```html - -``` +### 取消背景遮罩 -### 配合 Drag 支持拖拽 , 小程序暂不支持 +:::demo -```html - - - +```vue + + ``` +::: + ### 自定义使用 :::demo -```html +```vue - ``` diff --git a/src/packages/__VUE/form/doc.en-US.md b/src/packages/__VUE/form/doc.en-US.md index d504387139..b0a0db7032 100644 --- a/src/packages/__VUE/form/doc.en-US.md +++ b/src/packages/__VUE/form/doc.en-US.md @@ -65,70 +65,82 @@ app.use(FormItem); ``` ::: diff --git a/src/packages/__VUE/form/doc.md b/src/packages/__VUE/form/doc.md index 24a37e9847..34dc93aa09 100644 --- a/src/packages/__VUE/form/doc.md +++ b/src/packages/__VUE/form/doc.md @@ -67,68 +67,75 @@ app.use(FormItem); - + 添加 删除 - 提交 + 提交 重置提示状态 ``` ::: @@ -281,8 +288,19 @@ export default { }, 1000); }); }; - return { ruleForm, formData, validate, customValidator, customRulePropValidator, nameLengthValidator, asyncValidator, customBlurValidate, submit, reset }; - }; + return { + ruleForm, + formData, + validate, + customValidator, + customRulePropValidator, + nameLengthValidator, + asyncValidator, + customBlurValidate, + submit, + reset + }; + } }; ``` diff --git a/src/packages/__VUE/form/doc.taro.md b/src/packages/__VUE/form/doc.taro.md index e678c0c220..fe2c1ed88c 100644 --- a/src/packages/__VUE/form/doc.taro.md +++ b/src/packages/__VUE/form/doc.taro.md @@ -67,66 +67,73 @@ app.use(FormItem); - + 添加 删除 - 提交 + 提交 重置提示状态 ``` ::: @@ -277,8 +284,19 @@ export default { }, 1000); }); }; - return { ruleForm, formData, validate, customValidator, customRulePropValidator, nameLengthValidator, asyncValidator, customBlurValidate, submit, reset }; - }; + return { + ruleForm, + formData, + validate, + customValidator, + customRulePropValidator, + nameLengthValidator, + asyncValidator, + customBlurValidate, + submit, + reset + }; + } }; ``` diff --git a/src/packages/__VUE/infiniteloading/doc.en-US.md b/src/packages/__VUE/infiniteloading/doc.en-US.md index d39e18698a..ebce44c7d3 100644 --- a/src/packages/__VUE/infiniteloading/doc.en-US.md +++ b/src/packages/__VUE/infiniteloading/doc.en-US.md @@ -6,7 +6,7 @@ Scrolling to the bottom of the list automatically loads more data. ### Install -```javascript +```js import { createApp } from 'vue'; import { InfiniteLoading } from '@nutui/nutui'; @@ -18,88 +18,35 @@ app.use(InfiniteLoading); :::demo -```html +```vue - ``` @@ -109,94 +56,88 @@ app.use(InfiniteLoading); :::demo -```html +```vue - +``` + +::: + +### Use with PullRefresh + +:::demo + +```vue + + + + + ``` diff --git a/src/packages/__VUE/infiniteloading/doc.md b/src/packages/__VUE/infiniteloading/doc.md index f495e597f9..1cfe754a50 100644 --- a/src/packages/__VUE/infiniteloading/doc.md +++ b/src/packages/__VUE/infiniteloading/doc.md @@ -6,7 +6,7 @@ ### 安装 -```javascript +```js import { createApp } from 'vue'; import { InfiniteLoading } from '@nutui/nutui'; @@ -18,88 +18,35 @@ app.use(InfiniteLoading); :::demo -```html +```vue - ``` @@ -109,94 +56,88 @@ app.use(InfiniteLoading); :::demo -```html +```vue - +``` + +::: + +### 搭配 PullRefresh + +:::demo + +```vue + + + + + ``` diff --git a/src/packages/__VUE/invoice/doc.en-US.md b/src/packages/__VUE/invoice/doc.en-US.md index 70bd61bcef..dada251971 100644 --- a/src/packages/__VUE/invoice/doc.en-US.md +++ b/src/packages/__VUE/invoice/doc.en-US.md @@ -117,7 +117,6 @@ app.use(Invoice); }; return { - translate, data, formValue, submit, diff --git a/src/packages/__VUE/invoice/doc.md b/src/packages/__VUE/invoice/doc.md index c73bf3f6cd..ee7e7d948e 100644 --- a/src/packages/__VUE/invoice/doc.md +++ b/src/packages/__VUE/invoice/doc.md @@ -116,7 +116,6 @@ app.use(Invoice); }; return { - translate, data, formValue, submit, diff --git a/src/packages/__VUE/invoice/doc.taro.md b/src/packages/__VUE/invoice/doc.taro.md index 98bdfa25cc..29a24437cf 100644 --- a/src/packages/__VUE/invoice/doc.taro.md +++ b/src/packages/__VUE/invoice/doc.taro.md @@ -114,7 +114,6 @@ app.use(Invoice); }; return { - translate, data, formValue, submit, diff --git a/src/packages/__VUE/navbar/doc.en-US.md b/src/packages/__VUE/navbar/doc.en-US.md index 7026e351eb..c257e8928f 100644 --- a/src/packages/__VUE/navbar/doc.en-US.md +++ b/src/packages/__VUE/navbar/doc.en-US.md @@ -6,7 +6,7 @@ Provide navigation function, often used at the top of the page. ### Install -```javascript +```js import { createApp } from 'vue'; import { Navbar } from '@nutui/nutui'; @@ -18,14 +18,14 @@ app.use(Navbar); :::demo -```html +```vue - ``` @@ -88,7 +79,7 @@ app.use(Navbar); :::demo -```html +```vue