Browse Source

docs: Datepicker文案修改 (#1997)

* fix: popover

* fix: 代码回退

* feat: 文档修改

* feat: 修改Imagepreview

* feat: imagepreview文案修改

* feat: noticebar文案修改

* fix: noticebar小程序不能运行问题修改

* feat: 组件文档修改picker

* docs: 文案修改

* docs: countdown
yangxiaolu1993 3 years ago
parent
commit
354c26f4ee

+ 18 - 18
src/packages/__VUE/countdown/doc.en-US.md

@@ -151,7 +151,7 @@ Different countdown display text can be realized by setting the `format` attribu
 
 ### Manual Control
 
-Paused and restarted the countdown with the paused attribute
+Paused and restarted the countdown with the `paused` attribute
 
 :::demo
 ```html
@@ -302,18 +302,18 @@ Paused and restarted the countdown with the paused attribute
 
 ### Props
 
-| Attribute | Description | Type | Default
-| ----- | ----- | ----- | -----
-| v-model | Current Time | Object | {}
-| start-time | Start Time | String, Number | Date.now()
-| end-time | End Time | String, Number | Date.now()
-| format |  Format Time | String | HH:mm:ss
-| millisecond |  Whether to enable millisecond render | Boolean | false
-| auto-start |  Whether to auto start count down | Boolean | true
-| time | Total time, unit milliseconds | String,Number | 0
-| paused | Paused | Boolean | false
-| show-days | Show Text Day | Boolean | false
-| show-plain-text | Show Text | Boolean | false
+| Attribute | Description | Type | Default |
+| ----- | ----- | ----- | ----- |  
+| v-model | Current Time | object | `{}` |
+| start-time | Start Time | string \| number | `Date.now()` |
+| end-time | End Time | string \| number | `Date.now()` |
+| format |  Format Time | string | `HH:mm:ss` |
+| millisecond |  Whether to enable millisecond render | boolean | `false` |
+| auto-start |  Whether to auto start count down | boolean | `true` |
+| time | Total time, unit milliseconds | string \| number | `0` |
+| paused | Paused | boolean | `false` |
+| show-days | Show Text Day | boolean | `false` |
+| show-plain-text | Show Text | boolean | `false` |
 
 ### Format
 
@@ -348,8 +348,8 @@ Paused and restarted the countdown with the paused attribute
 
 The component provides the following CSS variables, which can be used to customize styles. Please refer to [ConfigProvider component](#/en-US/config-provider).
 
-| Name | Default Value | Description |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-countdown-display| _flex_ | -  |
-| --nut-countdown-color| _inherit_ | -  |
-| --nut-countdown-font-size| _initial_ | -  |
+| Name | Default Value | 
+| --------------------------------------- | -------------------------- | 
+| --nut-countdown-display| _flex_ | 
+| --nut-countdown-color| _inherit_ | 
+| --nut-countdown-font-size| _initial_ | 

+ 19 - 19
src/packages/__VUE/countdown/doc.md

@@ -43,7 +43,7 @@ app.use(Countdown);
 
 ### 自定义格式
 
-通过设置 format 属性可实现不同的倒计时展示文本
+通过设置 `format` 属性可实现不同的倒计时展示文本
 
 :::demo
 ```html
@@ -152,7 +152,7 @@ app.use(Countdown);
 
 ### 控制开始和暂停倒计时
 
-通过 paused 属性实现倒计时的暂停和重启
+通过 `paused` 属性实现倒计时的暂停和重启
 
 :::demo
 ```html
@@ -261,7 +261,7 @@ app.use(Countdown);
 
 ### 手动控制
 
-通过 ref 获取到组件实例后,可以调用 start、pause、reset 方法。在使用手动控制时,通过 time 属性实现倒计时总时长,单位为毫秒。startTime、endTime 属性失效
+通过 `ref` 获取到组件实例后,可以调用 `start``pause``reset` 方法。在使用手动控制时,通过 `time` 属性实现倒计时总时长,单位为毫秒。`startTime``endTime` 属性失效
 
 :::demo
 ```html
@@ -305,16 +305,16 @@ app.use(Countdown);
 
 ### Props
 
-| 字段 | 说明 | 类型 | 默认值
-| ----- | ----- | ----- | -----
-| v-model | 当前时间,自定义展示内容时生效 | Object | {}
-| start-time | 开始时间 | String, Number | Date.now()
-| end-time | 结束时间 | String, Number | Date.now()
-| format |  时间格式 | String | HH:mm:ss
-| millisecond |  是否开启毫秒级渲染 | Boolean | false
-| auto-start |  是否自动开始倒计时 | Boolean | true
-| time  | 倒计时显示时间,单位是毫秒。autoStart 为 false 时生效 | String,Number | 0
-| paused | 是否暂停 | Boolean | false
+| 字段 | 说明 | 类型 | 默认值 |
+| ----- | ----- | ----- | ----- |
+| v-model | 当前时间,自定义展示内容时生效 | object | `{}` |
+| start-time | 开始时间 | string \| number | `Date.now()` |
+| end-time | 结束时间 | string \| number | `Date.now()` |
+| format |  时间格式 | string | `HH:mm:ss` |
+| millisecond |  是否开启毫秒级渲染 | boolean | `false` |
+| auto-start |  是否自动开始倒计时 | boolean | `true` |
+| time  | 倒计时显示时间,单位是毫秒。autoStart 为 false 时生效 | string \| number | `0`|
+| paused | 是否暂停 | boolean | `false` |
 
 ### format 格式
 
@@ -344,7 +344,7 @@ app.use(Countdown);
 | ----- | ----- | 
 | start | 开始倒计时 | 
 | pause | 暂停倒计时 | 
-| reset | 重设倒计时,若 auto-start 为 true,重设后会自动开始倒计时 |
+| reset | 重设倒计时,若 `auto-start`为 true,重设后会自动开始倒计时 |
 
 ## 主题定制
 
@@ -352,8 +352,8 @@ app.use(Countdown);
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-countdown-display| _flex_ | -  |
-| --nut-countdown-color| _inherit_ | -  |
-| --nut-countdown-font-size| _initial_ | -  |
+| 名称                                    | 默认值                     | 
+| --------------------------------------- | -------------------------- | 
+| --nut-countdown-display| _flex_ | 
+| --nut-countdown-color| _inherit_ | 
+| --nut-countdown-font-size| _initial_ | 

+ 18 - 18
src/packages/__VUE/countdown/doc.taro.md

@@ -43,7 +43,7 @@ app.use(Countdown);
 
 ### 自定义格式
 
-通过设置 format 属性可实现不同的倒计时展示文本
+通过设置 `format` 属性可实现不同的倒计时展示文本
 
 :::demo
 ```html
@@ -152,7 +152,7 @@ app.use(Countdown);
 
 ### 控制开始和暂停倒计时
 
-通过 paused 属性实现倒计时的暂停和重启
+通过 `paused` 属性实现倒计时的暂停和重启
 
 :::demo
 ```html
@@ -261,7 +261,7 @@ app.use(Countdown);
 
 ### 手动控制
 
-通过 ref 获取到组件实例后,可以调用 start、pause、reset 方法。在使用手动控制时,通过 time 属性实现倒计时总时长,单位为毫秒。startTime、endTime 属性失效
+通过 `ref` 获取到组件实例后,可以调用 `start``pause``reset` 方法。在使用手动控制时,通过 `time` 属性实现倒计时总时长,单位为毫秒。`startTime``endTime` 属性失效
 
 :::demo
 ```html
@@ -305,16 +305,16 @@ app.use(Countdown);
 
 ### Props
 
-| 字段 | 说明 | 类型 | 默认值
-| ----- | ----- | ----- | -----
-| v-model | 当前时间,自定义展示内容时生效 | Object | {}
-| start-time | 开始时间 | String, Number | Date.now()
-| end-time | 结束时间 | String, Number | Date.now()
-| format |  时间格式 | String | HH:mm:ss
-| millisecond |  是否开启毫秒级渲染 | Boolean | false
-| auto-start |  是否自动开始倒计时 | Boolean | true
-| time | 倒计时显示时间,单位是毫秒。autoStart 为 false 时生效 | String,Number | 0
-| paused | 是否暂停 | Boolean | false
+| 字段 | 说明 | 类型 | 默认值 |
+| ----- | ----- | ----- | ----- |
+| v-model | 当前时间,自定义展示内容时生效 | object | `{}` |
+| start-time | 开始时间 | string \| number | `Date.now()` |
+| end-time | 结束时间 | string \| number | `Date.now()` |
+| format |  时间格式 | string | `HH:mm:ss` |
+| millisecond |  是否开启毫秒级渲染 | boolean | `false` |
+| auto-start |  是否自动开始倒计时 | boolean | `true` |
+| time  | 倒计时显示时间,单位是毫秒。autoStart 为 false 时生效 | string \| number | `0`|
+| paused | 是否暂停 | boolean | `false` |
 
 ### format 格式
 
@@ -352,8 +352,8 @@ app.use(Countdown);
 
 组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 [ConfigProvider 组件](#/zh-CN/config-provider)。
 
-| 名称                                    | 默认值                     | 描述 |
-| --------------------------------------- | -------------------------- | ---- |
-| --nut-countdown-display| _flex_ | -  |
-| --nut-countdown-color| _inherit_ | -  |
-| --nut-countdown-font-size| _initial_ | -  |
+| 名称                                    | 默认值                     | 
+| --------------------------------------- | -------------------------- | 
+| --nut-countdown-display| _flex_ | 
+| --nut-countdown-color| _inherit_ | 
+| --nut-countdown-font-size| _initial_ | 

+ 14 - 14
src/packages/__VUE/datepicker/doc.en-US.md

@@ -384,22 +384,22 @@ app.use(DatePicker);
     
 | Attribute         | Description                             | Type   | Default           |
 |-----------------|---------------------------------------------------|---------|----------|
-| v-model         | Default Date                                            | Date    | `null`   |
-| type            | Can be set to date time year-month month-day datehour | String  | `'date'` |
-| minute-step     | Option minute step                                        | Number  | `1`      |
-| is-show-chinese | Show Chinese                                  | Boolean | `false`  |
-| min-date        | Start date                                         | Date    | `Ten years ago on January 1` |
-| max-date        | End date                                          | Date    | `Ten years later on December 31` |
+| v-model         | Default Date                                            | date    | `null`   |
+| type            | Can be set to date time year-month month-day datehour | string  | `'date'` |
+| minute-step     | Option minute step                                        | number  | `1`      |
+| is-show-chinese | Show Chinese                                  | boolean | `false`  |
+| min-date        | Start date                                         | date    | `Ten years ago on January 1` |
+| max-date        | End date                                          | date    | `Ten years later on December 31` |
 | formatter   | Option text formatter                                          | (type: string, option: PickerOption) => PickerOption    |  |
 | filter   | Option filter                                         | (type: string, option: PickerOption) => PickerOption[]    |  |
-| title           | Title                                          | String  | `null`   |
-| ok-text           | Text of confirm button                                      | String  | confirm   |
-| cancel-text           | Text of cancel button                                          | String  | cancel   |
-| three-dimensional          | Turn on 3D effects               | Boolean  | true   |
-| swipe-duration           | Duration of the momentum animation        | Number、String  | 1000   |
-| visible-option-num          | Count of visible columns       | number \| string | 7               |
-| option-height         | Option height             | number \| string | 36     |
-| show-toolbar         | Whether to show toolbar             | Boolean | true    |
+| title           | Title                                          | string  | `null`   |
+| ok-text           | Text of confirm button                                      | string  | `confirm`   |
+| cancel-text           | Text of cancel button                                          | string  | `cancel`   |
+| three-dimensional          | Turn on 3D effects               | boolean  | `true`   |
+| swipe-duration           | Duration of the momentum animation        | number \| string  | `1000`  |
+| visible-option-num          | Count of visible columns       | number \| string | `7`               |
+| option-height         | Option height             | number \| string | `36`     |
+| show-toolbar         | Whether to show toolbar             | boolean | `true`    |
 
 ### Events
 

+ 18 - 18
src/packages/__VUE/datepicker/doc.md

@@ -110,7 +110,7 @@ app.use(DatePicker);
 
 ### 选择月日
 
-DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type 设置为 year-month 即可选择年份和月份,设置为 month-day 即可选择月份和日期。
+DatetimePicker 通过 `type` 属性来定义需要选择的时间类型。将 `type` 设置为 year-month 即可选择年份和月份,设置为 month-day 即可选择月份和日期。
 
 :::demo
 ```html
@@ -146,7 +146,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 :::
 ### 选择年月日时分
 
-将 type 设置为 datetime 即可选择完整的时间。
+将 `type` 设置为 datetime 即可选择完整的时间。
 
 :::demo
 
@@ -222,7 +222,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 
 ### 格式化选项
 
-通过传入 formatter 函数,可以对选项文字进行格式化处理。 isShowChinese 属性同样是也为选项后面添加文案,但 formatter 函数的优先级高于 isShowChinese 属性。
+通过传入 `formatter` 函数,可以对选项文字进行格式化处理。 `isShowChinese` 属性同样是也为选项后面添加文案,但 `formatter` 函数的优先级高于 `isShowChinese` 属性。
 
 :::demo
 ```html
@@ -320,7 +320,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 
 ### 过滤选项
 
-通过 filter 函数可以对选项数组进行过滤,实现自定义时间间隔。 
+通过 `filter` 函数可以对选项数组进行过滤,实现自定义时间间隔。 
 
 :::demo
 ```html
@@ -392,22 +392,22 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
     
 | 参数            | 说明                                              | 类型    | 默认值   |
 |-----------------|---------------------------------------------------|---------|----------|
-| v-model         | 初始值                                            | Date    | `null`   |
-| type            | 时间类型,可选值 date time year-month month-day datehour | String  | `'date'` |
-| minute-step     | 分钟步进值                                        | Number  | `1`      |
-| is-show-chinese | 每列是否展示中文                                  | Boolean | `false`  |
-| min-date        | 开始日期                                          | Date    | `十年前` |
-| max-date        | 结束日期                                          | Date    | `十年后` |
+| v-model         | 初始值                                            | date    | `null`   |
+| type            | 时间类型,可选值 date time year-month month-day datehour | string  | `'date'` |
+| minute-step     | 分钟步进值                                        | number  | `1`      |
+| is-show-chinese | 每列是否展示中文                                  | boolean | `false`  |
+| min-date        | 开始日期                                          | date    | `十年前` |
+| max-date        | 结束日期                                          | date    | `十年后` |
 | formatter   | 选项格式化函数                                          | (type: string, option: PickerOption) => PickerOption    |  |
 | filter    | 选项过滤函数                                          | (type: string, option: PickerOption) => PickerOption[]    |  |
-| title           | 设置标题                                          | String  | `null`   |
-| ok-text           | 确定按钮文案                                          | String  | 确定   |
-| cancel-text           | 取消按钮文案                                          | String  | 取消   |
-| three-dimensional           | 是否开启3D效果               | Boolean  | true   |
-| swipe-duration     | 惯性滚动时长               | Number、String  | 1000    |
-| visible-option-num          |可见的选项个数              | number \| string | 7               |
-| option-height         | 选项高度             | number \| string | 36     |
-| show-toolbar         | 是否显示顶部导航             | Boolean | true    |
+| title           | 设置标题                                          | string  | `null`   |
+| ok-text           | 确定按钮文案                                          | string  | `确定`   |
+| cancel-text           | 取消按钮文案                                          | string  | `取消`   |
+| three-dimensional           | 是否开启3D效果               | boolean  | `true`   |
+| swipe-duration     | 惯性滚动时长               | number \| string  | `1000`   |
+| visible-option-num          |可见的选项个数              | number \| string | `7`               |
+| option-height         | 选项高度             | number \| string | `36`     |
+| show-toolbar         | 是否显示顶部导航             | boolean | `true`    |
 
 ### Events
     

+ 17 - 20
src/packages/__VUE/datepicker/doc.taro.md

@@ -24,7 +24,6 @@ app.use(DatePicker);
       :min-date="minDate"
       :max-date="maxDate"
       :is-show-chinese="true"
-      :three-dimensional="false"
       @confirm="confirm"
   ></nut-date-picker> 
 </template>
@@ -66,7 +65,6 @@ app.use(DatePicker);
       :max-date="maxDate"
       @confirm="popupConfirm"
       :is-show-chinese="true"
-      :threeDimensional="false"
     >
       <nut-button block type="primary" @click="alwaysFun">永远有效</nut-button>
     </nut-date-picker>
@@ -108,7 +106,7 @@ app.use(DatePicker);
 
 ### 选择月日
 
-DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type 设置为 year-month 即可选择年份和月份,设置为 month-day 即可选择月份和日期。
+DatetimePicker 通过 `type` 属性来定义需要选择的时间类型。将 `type` 设置为 year-month 即可选择年份和月份,设置为 month-day 即可选择月份和日期。
 
 :::demo
 ```html
@@ -142,7 +140,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 :::
 ### 选择年月日时分
 
-将 type 设置为 datetime 即可选择完整的时间。
+将 `type` 设置为 datetime 即可选择完整的时间。
 
 :::demo
 
@@ -214,7 +212,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 
 ### 格式化选项
 
-通过传入 formatter 函数,可以对选项文字进行格式化处理。 isShowChinese 属性同样是也为选项后面添加文案,但 formatter 函数的优先级高于 isShowChinese 属性。
+通过传入 `formatter` 函数,可以对选项文字进行格式化处理。 `isShowChinese` 属性同样是也为选项后面添加文案,但 `formatter` 函数的优先级高于 `isShowChinese` 属性。
 
 :::demo
 ```html
@@ -308,7 +306,7 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
 
 ### 过滤选项
 
-通过 filter 函数可以对选项数组进行过滤,实现自定义时间间隔。 
+通过 `filter` 函数可以对选项数组进行过滤,实现自定义时间间隔。 
 
 :::demo
 ```html
@@ -378,22 +376,21 @@ DatetimePicker 通过 type 属性来定义需要选择的时间类型。将 type
     
 | 参数            | 说明                                              | 类型    | 默认值   |
 |-----------------|---------------------------------------------------|---------|----------|
-| v-model         | 初始值                                            | Date    | `null`   |
-| type            | 时间类型,可选值 date time year-month month-day datehour | String  | `'date'` |
-| minute-step     | 分钟步进值                                        | Number  | `1`      |
-| is-show-chinese | 每列是否展示中文                                  | Boolean | `false`  |
-| min-date        | 开始日期                                          | Date    | `十年前` |
-| max-date        | 结束日期                                          | Date    | `十年后` |
+| v-model         | 初始值                                            | date    | `null`   |
+| type            | 时间类型,可选值 date time year-month month-day datehour | string  | `'date'` |
+| minute-step     | 分钟步进值                                        | number  | `1`      |
+| is-show-chinese | 每列是否展示中文                                  | boolean | `false`  |
+| min-date        | 开始日期                                          | date    | `十年前` |
+| max-date        | 结束日期                                          | date    | `十年后` |
 | formatter   | 选项格式化函数                                          | (type: string, option: PickerOption) => PickerOption    |  |
 | filter    | 选项过滤函数                                          | (type: string, option: PickerOption) => PickerOption[]    |  |
-| title           | 设置标题                                          | String  | `null`   |
-| ok-text           | 确定按钮文案                                          | String  | 确定   |
-| cancel-text           | 取消按钮文案                                          | String  | 取消   |
-| three-dimensional           | 是否开启3D效果               | Boolean  | true   |
-| swipe-duration     | 惯性滚动时长               | Number、String  | 1000    |
-| visible-option-num          |可见的选项个数              | number \| string | 7               |
-| option-height         | 选项高度             | number \| string | 36     |
-| show-toolbar         | 是否显示顶部导航             | Boolean | true    |
+| title           | 设置标题                                          | string  | `null`   |
+| ok-text           | 确定按钮文案                                          | string  | `确定`   |
+| cancel-text           | 取消按钮文案                                          | string  | `取消`   |
+| swipe-duration     | 惯性滚动时长               | number \| string  | `1000`    |
+| visible-option-num          |可见的选项个数              | number \| string | `7`               |
+| option-height         | 选项高度             | number \| string | `36`     |
+| show-toolbar         | 是否显示顶部导航             | boolean | `true`    |
 
 ### Events