docs: 组件文档修改

penjj · Jan 4, 2023 · a3ac185 · a3ac185
1 parent 2964673
commit a3ac185
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 40 deletions.
diff --git a/src/packages/__VUE/countup/doc.en-US.md b/src/packages/__VUE/countup/doc.en-US.md
@@ -80,7 +80,7 @@ export default {
 ```
 :::
 
-### luck draw
+### luck draw(simulated rolling draw)
 :::demo
 
 ```html
@@ -150,7 +150,7 @@ export default {
 | during | rolling time to run | number | `1000`
 | num-width | Number width, often used to customize seamless scrolling | number | `20`
 | num-height | Number height, often used to customize seamless scrolling (required for lottery function) | number | `20`
-| scrolling | used for numeric scrolling display | boolean | `false`
+| scrolling | used for numeric scrolling display(taro environment does not support) | boolean | `false`
 | custom | for custom image scrolling | boolean | `false`
 | custom-change-num | The number to change (for custom pictures, initNum and endNum are invalid here) | number | `1`
 | custom-bg-img | Custom image (it is recommended to use Sprite image, and Sprite image must be used to use the lottery function) | - | `-`

diff --git a/src/packages/__VUE/countup/doc.md b/src/packages/__VUE/countup/doc.md
@@ -79,7 +79,7 @@ export default {
 ```
 :::
 
-### 抽奖
+### 抽奖（模拟滚动抽奖）
 :::demo
 
 ```html
@@ -149,7 +149,7 @@ export default {
 | during | 滚动一次运行时间 | number | `1000`
 | num-width | 数字宽度，常用于自定义无缝滚动 | number | `20`
 | num-height | 数字高度，常用于自定义无缝滚动（抽奖功能必传） | number | `20`
-| scrolling | 用于数字滚动展示 | boolean | `false`
+| scrolling | 用于数字滚动展示（taro 环境不支持） | boolean | `false`
 | custom | 用于自定义图片数字滚动 | boolean | `false`
 | custom-change-num | 要变化的数字（用于自定义图片，initNum、endNum在此无效） | number | `1`
 | custom-bg-img | 自定义图片（建议使用雪碧图实现，使用抽奖功能必须使用雪碧图） | - | `-`

diff --git a/src/packages/__VUE/countup/doc.taro.md b/src/packages/__VUE/countup/doc.taro.md
@@ -25,18 +25,8 @@ app.use(Countup);
     <nut-countup :init-num='1000.00' :end-num='0.00' :speed='50' :to-fixed='2'></nut-countup>
 </template>
 ```
-
 :::
-### 数字滚动
-:::demo
-
-```html
-<template>
-    <nut-countup :scrolling="true" :init-num='17.618' :during="600"></nut-countup>
-</template>
-```
 
-:::
 
 ### 自定义数字图片展示
 :::demo
@@ -150,7 +140,6 @@ export default {
 | during | 滚动一次运行时间 | number | `1000`
 | num-width | 数字宽度，常用于自定义无缝滚动 | number | `20`
 | num-height | 数字高度，常用于自定义无缝滚动（抽奖功能必传） | number | `20`
-| scrolling | 用于数字滚动展示 | boolean | `false`
 | custom | 用于自定义图片数字滚动 | boolean | `false`
 | custom-change-num | 要变化的数字（用于自定义图片，initNum、endNum在此无效） | number | `1`
 | custom-bg-img | 自定义图片（建议使用雪碧图实现，使用抽奖功能必须使用雪碧图） | - | `-`

diff --git a/src/packages/__VUE/layout/doc.en-US.md b/src/packages/__VUE/layout/doc.en-US.md
@@ -90,7 +90,7 @@ The Layout component provides a 24-column grid, by adding the span attribute on
 ```
 :::
 
-### Set element spacing
+### Column spacing
 
 :::demo
 ```html
@@ -232,7 +232,7 @@ The Layout component provides a 24-column grid, by adding the span attribute on
 
 ### Row Props
 
-| Field | Description | Type | Default
+| Attribute | Description | Type | Default
 |----- | ----- | ----- | -----
 | type | layout method, optional value is `flex` | string | `-`
 | gutter | spacing between column elements (`px`) | string \| number | `-`
@@ -242,19 +242,19 @@ The Layout component provides a 24-column grid, by adding the span attribute on
 
 ### Col Props
 
-| Field | Description | Type | Default
+| Attribute | Description | Type | Default
 |----- | ----- | ----- | -----
 | span | column element width (divided into 24 parts in total, for example, if there are 3 in a row, then the span value is 8) | string \| number | `24`
 | offset | column element offset distance | string \| number | `0`
 
 ### Row Events
 
-| field | description | callback parameter
+| event | description | callback parameter
 |----- | ----- | -----
 | click | Triggered when clicked | `event: MouseEvent`
 
 ### Col Events
 
-| field | description | callback parameter
+| name | description | callback parameter
 |----- | ----- | -----
 | click | Triggered when clicked | `event: MouseEvent`
diff --git a/src/packages/__VUE/layout/doc.md b/src/packages/__VUE/layout/doc.md
@@ -226,7 +226,7 @@ Layout 组件提供 24列栅格，通过在 Col 上添加 span 属性设置列
 
 ### Row Props
 
-| 字段 | 说明 | 类型 | 默认值
+| 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | type | 布局方式，可选值为 `flex` | string | `-`
 | gutter | 列元素之间的间距（单位为`px`） | string \| number | `-`
@@ -236,19 +236,19 @@ Layout 组件提供 24列栅格，通过在 Col 上添加 span 属性设置列
 
 ### Col Props
 
-| 字段 | 说明 | 类型 | 默认值
+| 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | span | 列元素宽度（共分为24份，例如设置一行3个，那么span值为8） | string \| number | `24`
 | offset | 列元素偏移距离 | string \| number | `0`
 
 ### Row Events
 
-| 字段 | 说明 | 回调参数
+| 事件名 | 说明 | 回调参数
 |----- | ----- | ----- 
 | click | 点击时触发 | `event: MouseEvent`
 
 ### Col Events
 
-| 字段 | 说明 | 回调参数
+| 名称 | 说明 | 回调参数
 |----- | ----- | ----- 
 | click | 点击时触发 | `event: MouseEvent`
diff --git a/src/packages/__VUE/layout/doc.taro.md b/src/packages/__VUE/layout/doc.taro.md
@@ -226,7 +226,7 @@ Layout 组件提供 24列栅格，通过在 Col 上添加 span 属性设置列
 
 ### Row Props
 
-| 字段 | 说明 | 类型 | 默认值
+| 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | type | 布局方式，可选值为 `flex` | string | `-`
 | gutter | 列元素之间的间距（单位为`px`） | string \| number | `-`
@@ -236,19 +236,19 @@ Layout 组件提供 24列栅格，通过在 Col 上添加 span 属性设置列
 
 ### Col Props
 
-| 字段 | 说明 | 类型 | 默认值
+| 参数 | 说明 | 类型 | 默认值
 |----- | ----- | ----- | ----- 
 | span | 列元素宽度（共分为24份，例如设置一行3个，那么span值为8） | string \| number | `24`
 | offset | 列元素偏移距离 | string \| number | `0`
 
 ### Row Events
 
-| 字段 | 说明 | 回调参数
+| 事件名 | 说明 | 回调参数
 |----- | ----- | ----- 
 | click | 点击时触发 | `event: MouseEvent`
 
 ### Col Events
 
-| 字段 | 说明 | 回调参数
+| 名称 | 说明 | 回调参数
 |----- | ----- | ----- 
 | click | 点击时触发 | `event: MouseEvent`
diff --git a/src/packages/__VUE/numberkeyboard/doc.md b/src/packages/__VUE/numberkeyboard/doc.md
@@ -16,7 +16,7 @@ app.use(NumberKeyboard);
 ```
 
 
-### 基础用法 默认键盘
+### 默认键盘
 在线调试请将浏览器变为手机模式
 :::demo
 ```html
@@ -236,7 +236,7 @@ export default{
 ```
 :::
 
-### 双向绑定：
+### 双向绑定
 
 :::demo
 ```html

diff --git a/src/packages/__VUE/numberkeyboard/doc.taro.md b/src/packages/__VUE/numberkeyboard/doc.taro.md
@@ -16,7 +16,7 @@ app.use(NumberKeyboard);
 ```
 
 
-### 基础用法 默认键盘
+### 默认键盘
 在线调试请将浏览器变为手机模式
 :::demo
 ```html
@@ -226,7 +226,7 @@ export default{
 ```
 :::
 
-### 双向绑定：
+### 双向绑定
 
 :::demo
 ```html

diff --git a/src/sites/mobile-taro/vue/src/dentry/pages/textarea/index.vue b/src/sites/mobile-taro/vue/src/dentry/pages/textarea/index.vue
@@ -6,12 +6,9 @@
     <nut-textarea v-model="value2" limit-show max-length="20" />
     <h2>高度自定义，拉伸</h2>
     <nut-textarea v-model="value3" autosize />
-    <h2>只读状态</h2>
+    <h2>只读、禁用</h2>
     <nut-textarea readonly model-value="textarea只读状态" />
-    <h2>禁用</h2>
     <nut-textarea disabled model-value="textarea禁用状态" limit-show max-length="20" />
-    <h2>自动获取焦点</h2>
-    <nut-textarea autofocus v-model="value4" />
   </div>
 </template>
 

diff --git a/src/sites/mobile-taro/vue/src/exhibition/pages/countup/index.vue b/src/sites/mobile-taro/vue/src/exhibition/pages/countup/index.vue
@@ -6,10 +6,6 @@
       <nut-countup :init-num="150.0" :end-num="0.0" :speed="6.18" :to-fixed="2"></nut-countup>
       <nut-countup :init-num="500.0" :end-num="0.0" :speed="17" :to-fixed="2"></nut-countup>
     </div>
-    <h2>数字滚动</h2>
-    <div class="show-demo">
-      <nut-countup :scrolling="true" :init-num="18.618" :during="600"></nut-countup>
-    </div>
     <h2>自定义滚动图片展示</h2>
     <div class="show-demo">
       <nut-countup