doc:add a version number identifier for new features

CHANGELOG.en-US.md

@@ -31,7 +31,7 @@ toc: hidden
   - `Cashier` change the presentation of channels [#77](https://github.com/didi/mand-mobile/issues/77)
   - `Capatcha` add support to customize button text and add `auto-countdown` prop to control whether auto send code or not [#84](https://github.com/didi/mand-mobile/issues/84)
   - `ActionSheet` add `maxHeight` [#86](https://github.com/didi/mand-mobile/issues/86)
-  - `InputItem` support `Number` type and other standard html input type [#95](https://github.com/didi/mand-mobile/issues/95)
+  - `InputItem` support `digit` type and other standard html input type [#95](https://github.com/didi/mand-mobile/issues/95)
   - `Picker`，`DatePicker`，`TabPicker` will cancel change when click mask or cancel button
 - Fix
   - Fix `DatePicker` bug [#75](https://github.com/didi/mand-mobile/issues/75)

CHANGELOG.md

@@ -31,7 +31,7 @@ toc: hidden
   - `Cashier`更改渠道展示方式，当支付渠道为两个直接展示 [#77](https://github.com/didi/mand-mobile/issues/77)
   - `Capatcha`支持自定义按钮文案，支持通过`auto-countdown`控制验证码是否自动发送 [#84](https://github.com/didi/mand-mobile/issues/84)
   - `ActionSheet`增加`maxHeight`控制展示区域最大高度 [#86](https://github.com/didi/mand-mobile/issues/86)
-  - `InputItem`增加类型`Number`, 支持其他Html Input标准类型 [#95](https://github.com/didi/mand-mobile/issues/95)
+  - `InputItem`增加类型`digit`, 支持其他Html Input标准类型 [#95](https://github.com/didi/mand-mobile/issues/95)
   - `Picker`，`DatePicker`，`TabPicker`点击取消或蒙层将会撤销选择更改
 - Fix
   - 修复`DatePicker`默认时间不在可选范围内的异常，将默认值教正至临近边界值 [#75](https://github.com/didi/mand-mobile/issues/75)

components/action-sheet/README.en-US.md

@@ -28,7 +28,7 @@ Vue.component(ActionSheet.name, ActionSheet)
 |default-index|default selected index|Boolean|0|-|
 |invalid-index|invalid index|Number| -1|-|
 |cancel-text|cancel text|String|-|-|
-|max-height|the maximum height of actionsheet area|Number|`400`|unit `px`|
+|max-height<sup class="version-after">1.3.0+</sup>|the maximum height of actionsheet area|Number|`400`|unit `px`|
 
 
 #### ActionSheet Events

components/action-sheet/README.md

@@ -27,7 +27,7 @@ Vue.component(ActionSheet.name, ActionSheet)
 |default-index|默认选中项| Boolean| `0`|-|
 |invalid-index|禁用选择项索引 |Number|`-1`|-|
 |cancel-text|取消按钮文案 |String |-|-|
-|max-height|面板最高高度, 超出后可滚动|Number|400|单位`px`|
+|max-height<sup class="version-after">1.3.0+</sup>|面板最高高度, 超出后可滚动|Number|400|单位`px`|
 
 #### ActionSheet Events
 

components/captcha/README.en-US.md

@@ -25,12 +25,12 @@ Vue.component(Captcha.name, Captcha)
 | maxlength | maxlength of string, set to `-1` as no restriction | Number | 4 |
 | mask | whether to mask code or not | Boolean | `false` |
 | system | Use system keyboard or simulated keyboard | Boolean | `false` |
-|auto-countdown|start the countdown automatically, otherwise need to manually call `countdown`|Boolean|`true`|
+| auto-countdown<sup class="version-after">1.3.0+</sup>|start the countdown automatically, otherwise need to manually call `countdown`|Boolean|`true`|
 | title| title of captcha | String | - |
 | append-to | portal node of dialog | HTML Element | `document.body` |
 | count | counter duration, set as `0` to hide resend button | Number | `60` |
-|countNormalText|text of send verification code button |String| `发送验证码` |
-|countActiveText|text of send verification code button in countdown state|String| `{$1}秒后重发` |
+| countNormalText<sup class="version-after">1.3.0+</sup>|text of send verification code button |String| `发送验证码` |
+| countActiveText<sup class="version-after">1.3.0+</sup>|text of send verification code button in countdown state|String| `{$1}秒后重发` |
 
 
 

components/captcha/README.md

@@ -26,12 +26,12 @@ Vue.component(Captcha.name, Captcha)
 |maxlength|字符最大输入长度, 若为`-1`则不限制输入长度|Number|`4`|
 |mask|是否掩码|Boolean|`false`|
 |system|是否使用系统默认键盘|Boolean|`false`|
-|auto-countdown|是否自动开始倒计时，否则需手动调用`countdown`|Boolean|`true`|
+|auto-countdown<sup class="version-after">1.3.0+</sup>|是否自动开始倒计时，否则需手动调用`countdown`|Boolean|`true`|
 |title|窗口标题|String|-|
 |appendTo|挂载节点|HTMLElement|`document.body`|
 |count|倒计时时长, 设置为0的时候不显示倒计时按钮|Number|`60`|
-|countNormalText|发送验证码正常状态文字|String| `'发送验证码'` |
-|countActiveText|发送验证码及倒计时按钮文案配置项|String| `'{$1}秒后重发'` |
+|countNormalText<sup class="version-after">1.3.0+</sup>|发送验证码正常状态文字|String| `发送验证码` |
+|countActiveText<sup class="version-after">1.3.0+</sup>|发送验证码及倒计时按钮文案配置项|String| `{$1}秒后重发` |
 
 #### Captcha Methods
 

components/cashier/README.en-US.md

@@ -28,19 +28,19 @@ Vue.component(Cashier.name, Cashier)
 |payment-title|payment amount title|String|`payment amount`|support `html fragment`|
 |payment-amount|payment amount|String|`0.00`|support `html fragment`|
 |payment-describe|the description of payment amount |String|-|support `html fragment`|
-|pay-button-text|confirm payment button text|String|`确认支付`|support `html fragment`|
-|more-button-text|more payment channels button text|String|`更多支付方式`|support `html fragment`|
+|pay-button-text<sup class="version-after">1.3.1+</sup>|confirm payment button text|String|`确认支付`|support `html fragment`|
+|more-button-text<sup class="version-after">1.3.1+</sup>|more payment channels button text|String|`更多支付方式`|support `html fragment`|
 
 
 #### Cashier Methods
 
 ##### next(scene, option)
 To the next step of Cashier
 
-|Parameters | Description | Type | Default|
-|----|-----|------|------|
-| scene | step identifier, 'captcha(Send verification code)', 'loading(Payment is in process)', 'success(Payment succeeds)', 'fail(Payment fails)' | String |-|
-| option | the configuration of current step | Object |properties are listed as follows|
+|Parameters | Description | Type | Default| Note|
+|-----|-----|-----|-----|-----|
+| scene | step identifier, 'captcha(Send verification code)', 'loading(Payment is in process)', 'success(Payment succeeds)', 'fail(Payment fails)' | String |-|-|
+| option | the configuration of current step | Object |properties are listed as follows|-|
 
 * `captcha` option
 
@@ -52,8 +52,8 @@ To the next step of Cashier
 |onSend|Callback of sending verification code| Function(countdown: Function) |-|`countdown` is the function of starting counting down|
 |onSubmit|Callback of submitting verification code | Function(code: String) |-|`code` is the verification code|
 |auto-countdown|start the countdown automatically, otherwise need to manually call `countdown`|Boolean|`true`|-|
-|countNormalText|text of send verification code button |String| `发送验证码` |-|
-|countActiveText|text of send verification code button in countdown state|String| `{$1}秒后重发`|-|
+|countNormalText<sup class="version-after">1.3.0+</sup>|text of send verification code button |String| `发送验证码` |-|
+|countActiveText<sup class="version-after">1.3.0+</sup>|text of send verification code button in countdown state|String| `{$1}秒后重发`|-|
 
 * `loading` option
 
@@ -66,7 +66,7 @@ To the next step of Cashier
 |Props | Description | Type | Default | Note|
 |----|-----|------|------|------|
 |text|The introduction of successful payment | String |`payment succeeds`|support `html fragment`|
-|buttonText| button text | String |`我知道了`|support `html fragment`|
+|buttonText<sup class="version-after">1.3.1+</sup>| button text | String |`我知道了`|support `html fragment`|
 |handler| button clickback | Function | - | - |
 
 
@@ -75,7 +75,7 @@ To the next step of Cashier
 |Props | Description | Type | Default | Note|
 |----|-----|------|------|------|
 |text|The introduction of unsuccessful payment | String |`payment fails, please try again later`|support `html fragment`|
-|buttonText| button text | String |`我知道了`|support `html fragment`|
+|buttonText<sup class="version-after">1.3.1+</sup>| button text | String |`我知道了`|support `html fragment`|
 |handler| button clickback | Function | - | - |
 
 #### Cashier Events

components/cashier/README.md

@@ -28,18 +28,18 @@ Vue.component(Cashier.name, Cashier)
 |payment-title|支付金额标题|String|`支付金额`|支持`html fragment`|
 |payment-amount|支付金额|String|`0.00`|支持`html fragment`|
 |payment-describe|支付金额说明|String|-|支持`html fragment`|
-|pay-button-text|确认支付按钮文案|String|`确认支付`|支持`html fragment`|
-|more-button-text|更多支付渠道按钮文案|String|`更多支付方式`|支持`html fragment`|
+|pay-button-text<sup class="version-after">1.3.1+</sup>|确认支付按钮文案|String|`确认支付`|支持`html fragment`|
+|more-button-text<sup class="version-after">1.3.1+</sup>|更多支付渠道按钮文案|String|`更多支付方式`|支持`html fragment`|
 
 #### Cashier Methods
 
 ##### next(scene, option)
 进入收银台下一步
 
-|参数 | 说明 | 类型 | 默认值|
-|----|-----|------|------|
-| scene | 步骤标识, 'captcha(发送验证码)', 'loading(支付中)', 'success(支付成功)', 'fail(支付失败)' | String |-|
-| option | 当前步骤配置 | Object |属性如下所示|
+|参数 | 说明 | 类型 | 默认值| 备注|
+|-----|-----|-----|-----|-----|
+| scene | 步骤标识, 'captcha(发送验证码)', 'loading(支付中)', 'success(支付成功)', 'fail(支付失败)' | String |-|-|
+| option | 当前步骤配置 | Object |属性如下所示|-|
 
 * `captcha` option
 
@@ -49,8 +49,8 @@ Vue.component(Cashier.name, Cashier)
 |maxlength|验证码位数 | Number  |`4`|若为`-1`则不限制输入长度|
 |count|验证码重新发送倒计时 | Number  |`60`|若为`0`则不显示重新发送|
 |auto-countdown|是否自动开始倒计时，否则需手动调用`countdown`|Boolean|`true`|-|
-|countNormalText|发送验证码正常状态文字|String| `'发送验证码'` |-|
-|countActiveText|发送验证码及倒计时按钮文案配置项|String| `'{$1}秒后重发'` |-|
+|countNormalText<sup class="version-after">1.3.0+</sup>|发送验证码正常状态文字|String| `发送验证码` |-|
+|countActiveText<sup class="version-after">1.3.0+</sup>|发送验证码及倒计时按钮文案配置项|String| `{$1}秒后重发` |-|
 |onSend|验证码发送回调 | Function(countdown: Function) |-|`countdown`为开始倒计时方法|
 |onSubmit|验证码提交回调 | Function(code: String) |-|`code`为输入的验证码|
 
@@ -65,15 +65,15 @@ Vue.component(Cashier.name, Cashier)
 |属性 | 说明 | 类型 | 默认值 | 备注|
 |----|-----|------|------|------|
 |text|支付成功说明 | String |`支付成功`|支持`html fragment`|
-|buttonText| 按钮文案 | String |`我知道了`|支持`html fragment`|
+|buttonText<sup class="version-after">1.3.1+</sup>| 按钮文案 | String |`我知道了`|支持`html fragment`|
 |handler| 按钮点击回调 | Function | - | - |
 
 * `fail` option
 
 |属性 | 说明 | 类型 | 默认值 | 备注|
 |----|-----|------|------|------|
 |text|支付失败说明 | String |`支付失败，请稍后重试`|支持`html fragment`|
-|buttonText| 按钮文案 | String |`我知道了`|支持`html fragment`|
+|buttonText<sup class="version-after">1.3.1+</sup>| 按钮文案 | String |`我知道了`|支持`html fragment`|
 |handler| 按钮点击回调 | Function | - | - |
 
 

components/image-reader/README.en-US.md

@@ -36,29 +36,29 @@ Vue.component(ImageReader.name, ImageReader)
 ##### @select(name, { files })
 Picture selection completed, while reading hasn't been started yet
 
-|Parameters | Description | Type|
-|----|-----|------|
-|name|identifier|String|
-|files|image file objects set|Array<File>|
+|Parameters | Description | Type| Note|
+|-----|-----|-----|-----|
+|name|identifier|String|-|
+|files<sup class="version-after">1.3.1+</sup>|image file objects set|Array<File>|-|
 
 ##### @complete(name, { dataUrl, blob, file })
 Picture reading completed
 
-|Parameters | Description | Type|
-|----|-----|------|
-|name|identifier|String|
-|dataUrl|base64|String|
-|blob|image Blob object for `formData`|Blob|
-|file|image file object|File|
+|Parameters | Description | Type| Note|
+|-----|-----|-----|-----|
+|name|identifier|String|-|
+|dataUrl|base64|String|-|
+|blob|image Blob object for `formData`|Blob|-|
+|file<sup class="version-after">1.3.1+</sup>|image file object|File|-|
 
 ##### @error(name, { code, msg })
 Picture selection and reading failed
 
-|Parameters | Description | Type|
-|----|-----|------|
-|name|identifier|String|
-|code|error identifier|String|
-|msg|error message|String|
+|Parameters | Description | Type| Note|
+|-----|-----|-----|-----|
+|name|identifier|String|-|
+|code|error identifier|String|-|
+|msg|error message|String|-|
 
 ### imageProcessor
 
@@ -81,7 +81,7 @@ imageProcessor(options[, fn])
 #### options
 
 |Props | Description | Type | Note |
-|----|-----|------|------|
+|-----|-----|-----|-----|
 |dataUrl|base64|String|-|
 |width|picture width|Number|unit `px`, scaled when width exceeds|
 |height|picture height|Number|unit `px`, scaled when height exceeds|

components/image-reader/README.md

@@ -34,29 +34,29 @@ Vue.component(ImageReader.name, ImageReader)
 ##### @select(name, { files })
 图片选择完成事件，还未开始读取
 
-|属性 | 说明 | 类型|
-|----|-----|------|
-|name|选择器标识|String|
-|files|图片对象集合|Array<File>|
+|属性 | 说明 | 类型| 备注|
+|-----|-----|-----|-----|
+|name|选择器标识|String|-|
+|files<sup class="version-after">1.3.1+</sup>|图片对象集合|Array<File>|-|
 
 ##### @complete(name, { dataUrl, blob, file })
 图片选择读取完成事件
 
-|属性 | 说明 | 类型|
-|----|-----|------|
-|name|选择器标识|String|
-|dataUrl|图片Base64|String|
-|blob|图片Blob对象，可用于`formData`|Blob|
-|file|图片对象|File|
+|属性 | 说明 | 类型| 备注|
+|-----|-----|-----|-----|
+|name|选择器标识|String|-|
+|dataUrl|图片Base64|String|-|
+|blob|图片Blob对象，可用于`formData`|Blob|-|
+|file<sup class="version-after">1.3.1+</sup>|图片对象|File|-|
 
 ##### @error(name, { code, msg })
 图片选择读取失败事件
 
-|属性 | 说明 | 类型|
-|----|-----|------|
-|name|选择器标识|String|
-|code|错误标识，见附录|String|
-|msg|错误信息，见附录|String|
+|属性 | 说明 | 类型| 备注|
+|-----|-----|-----|-----|
+|name|选择器标识|String|-|
+|code|错误标识，见附录|String|-|
+|msg|错误信息，见附录|String|-|
 
 ### imageProcessor
 
@@ -79,7 +79,7 @@ imageProcessor(options[, fn])
 #### options
 
 |属性 | 说明 | 类型| 备注|
-|----|-----|------|------|
+|-----|-----|-----|-----|
 |dataUrl|图片Base64|String|-|
 |width|图片宽度|Number|单位`px`, 宽度超出时等比缩放|
 |height|图片高度|Number|单位`px`, 高度超出时等比缩放|

components/image-viewer/README.en-US.md

@@ -22,7 +22,7 @@ Vue.component(ImageViewer.name, ImageViewer)
 #### ImageViewer Props
 |Props | Description | Type | Default | Note |
 |----|-----|------|------|------|
-| v-model | viewer display | Boolean | `false` |
+| v-model<sup class="version-after">1.1.0+</sup> | viewer display | Boolean | `false` |
 | list |show picture list | Array<String> | `[]` | -|
 | initial-index | initialize the index of displayed image | Number | `0` | - |
 | has-dots | display the index of picture| Boolean | `true` | - |

components/image-viewer/README.md

@@ -22,7 +22,7 @@ Vue.component(ImageViewer.name, ImageViewer)
 #### ImageViewer Props
 |属性 | 说明 | 类型 | 默认值 | 备注|
 |----|-----|------|------|------|
-| v-model | 是否显示查看器 | Boolean | `false` |
+| v-model<sup class="version-after">1.1.0+</sup> | 是否显示查看器 | Boolean | `false` |
 | list |展示图片列表 | Array<String> | `[]` | -|
 | initial-index | 初始索引值 | Number | `0` | - |
 | has-dots | 是否展示图片索引值 | Boolean | `true` | - |

components/selector/README.en-US.md

@@ -29,10 +29,10 @@ Vue.component(Selector.name, Selector)
 |title|the title of selector|String|-|-|
 |ok-text|confirmation text|String|-|if empty, it will be `confirmed mode`, that is, click to select directly|
 |cancel-text|cancellation text|String|`cancel`|-|
-|mask-closable|if the popup will be closed when clicking mask|Boolean|`true`|-|
+|mask-closable<sup class="version-after">1.3.0+</sup>|if the popup will be closed when clicking mask|Boolean|`true`|-|
 |is-check|has a `check` icon or not|Boolean|`false`|only for `confirmed mode`|
 |option-render|return rendering contents of each option|Function({value, text ,...}):String|-|`vue 2.1.0+` can use `slot-scope`, refer to `Radio`|
-|max-height|the maximum height of selectable area|Number|`400`|unit `px`|
+|max-height<sup class="version-after">1.3.0+</sup>|the maximum height of selectable area|Number|`400`|unit `px`|
 
 
 #### Selector Events

components/selector/README.md

@@ -29,10 +29,10 @@ Vue.component(Selector.name, Selector)
 |title|选择器标题|String|-|-|
 |ok-text|选择器确认文案|String|-|若为空则为`确认模式`，即点击选项直接选择|
 |cancel-text|选择器取消文案|String|`取消`|-|
-|mask-closable|点击蒙层是否可关闭弹出层|Boolean|`true`|-|
+|mask-closable<sup class="version-after">1.3.0+</sup>|点击蒙层是否可关闭弹出层|Boolean|`true`|-|
 |is-check|是否有`check`图标|Boolean|`false`|仅`确认模式`|
 |option-render|返回各选项渲染内容|Function({value, text ,...}):String|-|`vue 2.1.0+`可使用`slot-scope`，参考`Radio`|
-|max-height|选择器内容区域最高高度, 超出后可滚动|Number|400|单位`px`|
+|max-height<sup class="version-after">1.3.0+</sup>|选择器内容区域最高高度, 超出后可滚动|Number|400|单位`px`|
 
 
 #### Selector Events

components/tab-picker/README.en-US.md

@@ -54,7 +54,7 @@ Asynchronous cascading panel supports passing slots
 |title|the title of tabpicker|String|-|-|
 |ok-text|text of confirmation button|String|`confirm`|-|
 |cancel-text|text of cancellation button|String|`cancel`|-|
-|mask-closable|if the popup will be closed when clicking on the mask|Boolean|`true`|-|
+|mask-closable<sup class="version-after">1.3.0+</sup>|if the popup will be closed when clicking on the mask|Boolean|`true`|-|
 
 #### TabPicker Methods
 

components/tab-picker/README.md

@@ -52,7 +52,7 @@ tab切换的title支持自定义渲染（通过slot-scope）
 |title|弹窗标题|String|-|-|
 |ok-text|确认按钮文案|String|`确认`|-|
 |cancel-text|取消按钮文案|String|`取消`|-|
-|mask-closable|点击蒙层是否可关闭弹出层|Boolean|`true`|-|
+|mask-closable<sup class="version-after">1.3.0+</sup>|点击蒙层是否可关闭弹出层|Boolean|`true`|-|
 
 
 #### TabPicker Methods

components/toast/README.en-US.md

@@ -24,7 +24,7 @@ Dynamically create a toast
 | icon | name of icon | String | - |Refer to `Icon` component for customized icons|
 | content | content of message| String/Number | - |- |
 | duration | toast will be closed in milliseconds; if set duration as`0`, the toast will always be visible | Number | `3000` | - |
-| position | display position | String | `center` | `top/center/bottom` |
+| position <sup class="version-after">1.3.3+</sup>| display position | String | `center` | `top/center/bottom` |
 | hasMask | whether to show a transparent mask, which will prevent users from clicking| Boolean | `false` | - |
 | parentNode | portal node of toast | HTMLElement | `document.body`| - |
 

components/toast/README.md

@@ -26,7 +26,7 @@ Toast.succeed('操作成功')
 | icon | Icon组件图标名称 | String | - |如需自定义图标, 请查看`Icon`组件 |
 | content | 提示内容文本 | String | - |- |
 | duration | 显示多少毫秒后自动消失, 若为`0`则一直显示 | Number | `3000` | - |
-| position | 展示位置 | String | `center` | `top/center/bottom` |
+| position <sup class="version-after">1.3.3+</sup>| 展示位置 | String | `center` | `top/center/bottom` |
 | hasMask | 是否显示透明遮罩, 以此防止用户点击 | Boolean | `false` | - |
 | parentNode | 组件挂载节点 | HTMLElement | `document.body`|- |