test/element-plus
1
0
Fork 0
mirror of https://gitee.com/element-plus/element-plus.git synced 2024-12-01 18:58:10 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

docs(components): [input-number] documentation updates (#7727)

Browse Source 
- Add version tag for `value-on-clear`.
- Add breaking change log for `value-on-clear`.
This commit is contained in:
JeremyWuuuuu 2022-05-17 10:47:09 +08:00 committed by GitHub
parent 792265d56a
commit 01a3edf619
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
breakings/2.2.1/input-number.yml Normal file
View File

@ -0,0 +1,12 @@
- scope: 'component'
name: 'el-input-number'
type: 'props'
version: '2.2.1'
commit_hash: '2577b06'
description: |
Add a default value setter on clear input number value. When clear event occurs, the value will be set to the
value from the new API.
props:
- api: 'value-on-clear'
before: ''
after: '"min" | "max" | null | number'

32
docs/en-US/component/input-number.md
View File

@ -81,22 +81,22 @@ input-number/controlled
## Attributes
| Attribute | Description | Type | Accepted Values | Default |
| --------------------- | ------------------------------------------------ | ---------------------- | --------------- | ----------- |
| model-value / v-model | binding value | number / undefined | — | — |
| min | the minimum allowed value | number | — | `-Infinity` |
| max | the maximum allowed value | number | — | `Infinity` |
| step | incremental step | number | — | 1 |
| step-strictly | whether input value can only be multiple of step | boolean | — | false |
| precision | precision of input value | number | — | — |
| size | size of the component | string | large/small | default |
| disabled | whether the component is disabled | boolean | — | false |
| controls | whether to enable the control buttons | boolean | — | true |
| controls-position | position of the control buttons | string | right | - |
| name | same as `name` in native input | string | — | — |
| label | label text | string | — | — |
| placeholder | placeholder in input | string | - | - |
| value-on-clear | value should be set when input box is cleared | string / number / null | min/max | - |
| Attribute | Description | Type | Accepted Values | Default |
| --------------------------------------------- | ------------------------------------------------ | ---------------------- | --------------- | ----------- |
| model-value / v-model | binding value | number / undefined | — | — |
| min | the minimum allowed value | number | — | `-Infinity` |
| max | the maximum allowed value | number | — | `Infinity` |
| step | incremental step | number | — | 1 |
| step-strictly | whether input value can only be multiple of step | boolean | — | false |
| precision | precision of input value | number | — | — |
| size | size of the component | string | large/small | default |
| disabled | whether the component is disabled | boolean | — | false |
| controls | whether to enable the control buttons | boolean | — | true |
| controls-position | position of the control buttons | string | right | - |
| name | same as `name` in native input | string | — | — |
| label | label text | string | — | — |
| placeholder | placeholder in input | string | - | - |
| value-on-clear <VersionTag version="2.2.1" /> | value should be set when input box is cleared | string / number / null | min/max | - |
## Events