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): [button/input/scrollbar/autocomplete] object (#10891)

Browse Source
This commit is contained in:
Xc 2022-12-04 14:57:08 +08:00 committed by GitHub
parent 151ebede93
commit 4cac61f27f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/en-US/component/autocomplete.md
View File

@ -83,15 +83,15 @@ autocomplete/remote-search
| Name | Description | Type |
| ---------------- | ------------------------------------------- | ----------------------------------------- |
| activated | if autocomplete activated | ^[Object]`Ref<boolean>` |
| activated | if autocomplete activated | ^[object]`Ref<boolean>` |
| blur | blur the input element | ^[Function]`() => void` |
| close | collapse suggestion list | ^[Function]`() => void` |
| focus | focus the input element | ^[Function]`() => void` |
| handleSelect | triggers when a suggestion is clicked | ^[Function]`(item: any) => promise<void>` |
| handleKeyEnter | handle keyboard enter event | ^[Function]`() => promise<void>` |
| highlightedIndex | the index of the currently highlighted item | ^[Object]`Ref<number>` |
| highlightedIndex | the index of the currently highlighted item | ^[object]`Ref<number>` |
| highlight | highlight an item in a suggestion | ^[Function]`(itemIndex: number) => void` |
| inputRef | el-input component instance | ^[Object]`Ref<ElInputInstance>` |
| loading | remote search loading indicator | ^[Object]`Ref<boolean>` |
| popperRef | el-tooltip component instance | ^[Object]`Ref<ElTooltipInstance>` |
| suggestions | fetch suggestions result | ^[Object]`Ref<record<string, any>>` |
| inputRef | el-input component instance | ^[object]`Ref<ElInputInstance>` |
| loading | remote search loading indicator | ^[object]`Ref<boolean>` |
| popperRef | el-tooltip component instance | ^[object]`Ref<ElTooltipInstance>` |
| suggestions | fetch suggestions result | ^[object]`Ref<record<string, any>>` |

10
docs/en-US/component/button.md
View File

@ -159,11 +159,11 @@ button/custom
| Name | Description | Type |
| -------------- | -------------------- | -------------------------------------------------------------------------------------------------------------- |
| ref | button html element | ^[Object]`Ref<HTMLButtonElement>` |
| size | button size | ^[Object]`ComputedRef<'' \| 'small' \| 'default' \| 'large'>` |
| type | button type | ^[Object]`ComputedRef<'' \| 'default' \| 'primary' \| 'success' \| 'warning' \| 'info' \| 'danger' \| 'text'>` |
| disabled | button disabled | ^[Object]`ComputedRef<boolean>` |
| shouldAddSpace | whether adding space | ^[Object]`ComputedRef<boolean>` |
| ref | button html element | ^[object]`Ref<HTMLButtonElement>` |
| size | button size | ^[object]`ComputedRef<'' \| 'small' \| 'default' \| 'large'>` |
| type | button type | ^[object]`ComputedRef<'' \| 'default' \| 'primary' \| 'success' \| 'warning' \| 'info' \| 'danger' \| 'text'>` |
| disabled | button disabled | ^[object]`ComputedRef<boolean>` |
| shouldAddSpace | whether adding space | ^[object]`ComputedRef<boolean>` |
## ButtonGroup API

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

@ -127,7 +127,7 @@ input/length-limiting
| 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] | — |
| clearable | whether to show clear button, only works when `type` is not 'textarea' | ^[boolean] | false |
| clearable | whether to show clear button, only works when `type` is not 'textarea' | ^[boolean] | false |
| formatter | specifies the format of the value presented input.(only works when `type` is 'text') | ^[Function]`(value: string \| number) => string` | — |
| parser | specifies the value extracted from formatter input.(only works when `type` is 'text') | ^[Function]`(value: string) => string` | — |
| show-password | whether to show toggleable password input | ^[boolean] | false |
@ -177,9 +177,9 @@ input/length-limiting
| blur | blur the input element | ^[Function]`() => void` |
| clear | clear input value | ^[Function]`() => void` |
| focus | focus the input element | ^[Function]`() => void` |
| input | HTML input element | ^[Object]`Ref<HTMLInputElement>` |
| ref | HTML element, input or textarea | ^[Object]`Ref<HTMLInputElement \| HTMLTextAreaElement>` |
| input | HTML input element | ^[object]`Ref<HTMLInputElement>` |
| ref | HTML element, input or textarea | ^[object]`Ref<HTMLInputElement \| HTMLTextAreaElement>` |
| resizeTextarea | resize textarea | ^[Function]`() => void` |
| select | select the text in input element | ^[Function]`() => void` |
| textarea | HTML textarea element | ^[Object]`Ref<HTMLTextAreaElement>` |
| textareaStyle | style of textarea | ^[Object]`Ref<StyleValue>` |
| textarea | HTML textarea element | ^[object]`Ref<HTMLTextAreaElement>` |
| textareaStyle | style of textarea | ^[object]`Ref<StyleValue>` |

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

@ -78,4 +78,4 @@ scrollbar/manual-scroll
| setScrollTop | Set distance to scroll top | ^[Function]`(scrollTop: number) => void` |
| setScrollLeft | Set distance to scroll left | ^[Function]`(scrollLeft: number) => void` |
| update | update scrollbar state manually | ^[Function]`() => void` |
| wrapRef | scrollbar wrap ref | ^[Object]`Ref<HTMLDivElement>` |
| wrapRef | scrollbar wrap ref | ^[object]`Ref<HTMLDivElement>` |