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

docs(components): [input][scrollbar] (#10593)

Browse Source 
* type connection symbol
This commit is contained in:
Xc 2022-11-14 10:26:42 +08:00 committed by GitHub
parent cb490ae3c1
commit 6ab5d7c248
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/en-US/component/input.md
View File

@ -122,8 +122,8 @@ input/length-limiting
| Name | Description | Type | Default |
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| type | type of input | ^[string]`'text' \| 'textarea' \| ...` [native input types](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#Form_%3Cinput%3E_types) | text |
| model-value / v-model | binding value | ^[string] \| ^[number] | — |
| maxlength | the max length | ^[string] \| ^[number] | — |
| model-value / v-model | binding value | ^[string] / ^[number] | — |
| maxlength | the max length | ^[string] / ^[number] | — |
| minlength | same as `minlength` in native input | ^[number] | — |
| show-word-limit | whether show word count, only works when `type` is 'text' or 'textarea' | ^[boolean] | false |
| placeholder | placeholder of Input | ^[string] | — |
@ -133,10 +133,10 @@ input/length-limiting
| show-password | whether to show toggleable password input | ^[boolean] | false |
| disabled | whether Input is disabled | ^[boolean] | false |
| size | size of Input, works when `type` is not 'textarea' | ^[enum]`'large' \| 'default' \| 'small'` | — |
| prefix-icon | prefix icon component | ^[string] \| ^[Component] | — |
| suffix-icon | suffix icon component | ^[string] \| ^[Component] | — |
| prefix-icon | prefix icon component | ^[string] / ^[Component] | — |
| suffix-icon | suffix icon component | ^[string] / ^[Component] | — |
| rows | number of rows of textarea, only works when `type` is 'textarea' | ^[number] | 2 |
| autosize | whether textarea has an adaptive height, only works when `type` is 'textarea'. Can accept an object, e.g. `{ minRows: 2, maxRows: 6 }` | ^[boolean] \| ^[object]`{ minRows?: number, maxRows?: number }` | false |
| autosize | whether textarea has an adaptive height, only works when `type` is 'textarea'. Can accept an object, e.g. `{ minRows: 2, maxRows: 6 }` | ^[boolean] / ^[object]`{ minRows?: number, maxRows?: number }` | false |
| autocomplete | same as `autocomplete` in native input | ^[string] | off |
| name | same as `name` in native input | ^[string] | — |
| readonly | same as `readonly` in native input | ^[boolean] | false |
@ -147,9 +147,9 @@ input/length-limiting
| autofocus | same as `autofocus` in native input | ^[boolean] | false |
| form | same as `form` in native input | `string` | — |
| label<A11yTag /> | same as `aria-label` in native input | ^[string] | — |
| tabindex | input tabindex | ^[string] \| ^[number] | — |
| tabindex | input tabindex | ^[string] / ^[number] | — |
| validate-event | whether to trigger form validation | ^[boolean] | true |
| input-style | the style of the input element or textarea element | ^[string] \| ^[object]`CSSProperties \| CSSProperties[] \| string[]` | {} |
| input-style | the style of the input element or textarea element | ^[string] / ^[object]`CSSProperties \| CSSProperties[] \| string[]` | {} |
### Events

30
docs/en-US/component/scrollbar.md
View File

@ -43,23 +43,23 @@ scrollbar/manual-scroll
### Attributes
| Name | Description | Type | Default |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | ------- |
| height | height of scrollbar | ^[string] \| ^[number] | — |
| max-height | max height of scrollbar | ^[string] \| ^[number] | — |
| native | whether to use the native scrollbar style | ^[boolean] | false |
| wrap-style | style of wrap container | ^[string] \| ^[object]`CSSProperties \| CSSProperties[] \| string[]` | — |
| wrap-class | class of wrap container | ^[string] | — |
| view-style | style of view | ^[string] \| ^[object]`CSSProperties \| CSSProperties[] \| string[]` | — |
| view-class | class of view | ^[string] | — |
| noresize | do not respond to container size changes, if the container size does not change, it is better to set it to optimize performance | ^[boolean] | false |
| tag | element tag of the view | ^[string] | div |
| always | always show scrollbar | ^[boolean] | false |
| min-size | minimum size of scrollbar | ^[number] | 20 |
| Name | Description | Type | Default |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ------- |
| height | height of scrollbar | ^[string] / ^[number] | — |
| max-height | max height of scrollbar | ^[string] / ^[number] | — |
| native | whether to use the native scrollbar style | ^[boolean] | false |
| wrap-style | style of wrap container | ^[string] / ^[object]`CSSProperties \| CSSProperties[] \| string[]` | — |
| wrap-class | class of wrap container | ^[string] | — |
| view-style | style of view | ^[string] / ^[object]`CSSProperties \| CSSProperties[] \| string[]` | — |
| view-class | class of view | ^[string] | — |
| noresize | do not respond to container size changes, if the container size does not change, it is better to set it to optimize performance | ^[boolean] | false |
| tag | element tag of the view | ^[string] | div |
| always | always show scrollbar | ^[boolean] | false |
| min-size | minimum size of scrollbar | ^[number] | 20 |
### Events
| Name | Description | Type |
| Name | Description | Type |
| ------ | ----------------------------------------------------- | ---------------------------------------------------------------- |
| scroll | triggers when scrolling, return distance of scrolling | ^[Function]`({ scrollLeft: number, scrollTop: number }) => void` |
@ -71,7 +71,7 @@ scrollbar/manual-scroll
### Exposes
| Method | Description | Type |
| Method | Description | Type |
| ------------- | ------------------------------------------ | -------------------------------------------------------------------------- |
| handleScroll | handle scroll event | ^[Function]`() => void` |
| scrollTo | scrolls to a particular set of coordinates | ^[Function]`(options: ScrollToOptions \| number, yCoord?: number) => void` |