Skip to content

Commit

Permalink
docs(components): [input-number] documentation updates (element-plus#…
Browse files Browse the repository at this point in the history 
…7727)

- Add version tag for `value-on-clear`.
- Add breaking change log for `value-on-clear`.
  • Loading branch information
@jw-foss
jw-foss authored May 17, 2022
1 parent 792265d commit 01a3edf
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 16 deletions.
12 changes: 12 additions & 0 deletions breakings/2.2.1/input-number.yml
View file
Original file line number Diff line number Diff line change
@@ -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 changes: 16 additions & 16 deletions docs/en-US/component/input-number.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 01a3edf

Please sign in to comment.