mirror/element-plus
2
0
Fork 0
mirror of https://github.com/element-plus/element-plus.git synced 2024-11-27 02:01:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): [mention] the document display format is unified (#18352)

Browse Source 
docs(docs): the document display format is unified
This commit is contained in:
Kylin 2024-09-24 18:19:56 +08:00 committed by GitHub
parent a76b6b129d
commit 755fbdbd80
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/en-US/component/mention.md
View File

@ -88,20 +88,20 @@ and please go to the original component to view the documentation.
| Name | Description | Type | Default |
| ------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------- |
| options | mention options list | ^[array]`MentionOption[]` | [] |
| options | mention options list | ^[array]`MentionOption[]` | `[]` |
| prefix | prefix character to trigger mentions. The string length must be exactly 1 | ^[string] \| ^[array]`string[]` | `'@'` |
| split | character to split mentions. The string length must be exactly 1 | ^[string] | `' '` |
| filter-option | customize filter option logic | ^[false] \| ^[Function]`(pattern: string, option: MentionOption) => boolean` | - |
| filter-option | customize filter option logic | ^[false] \| ^[Function]`(pattern: string, option: MentionOption) => boolean` | — |
| placement | set popup placement | ^[string]`'bottom' \| 'top'` | `'bottom'` |
| show-arrow | whether the dropdown panel has an arrow | ^[boolean] | `false` |
| offset | offset of the dropdown panel | ^[number] | `0` |
| whole | when backspace is pressed to delete, whether the mention content is deleted as a whole | ^[boolean] | `false` |
| check-is-whole | when backspace is pressed to delete, check if the mention is a whole | ^[Function]`(pattern: string, prefix: string) => boolean` | - |
| check-is-whole | when backspace is pressed to delete, check if the mention is a whole | ^[Function]`(pattern: string, prefix: string) => boolean` | — |
| loading | whether the dropdown panel of mentions is in a loading state | ^[boolean] | `false` |
| model-value / v-model | input value | ^[string] | - |
| popper-class | custom class name for dropdown panel | ^[string] | - |
| popper-options | [popper.js](https://popper.js.org/docs/v2/) parameters | ^[object] refer to [popper.js doc](https://popper.js.org/docs/v2/) | - |
| [input props](./input.md#attributes) | - | - | - |
| model-value / v-model | input value | ^[string] | — |
| popper-class | custom class name for dropdown panel | ^[string] | — |
| popper-options | [popper.js](https://popper.js.org/docs/v2/) parameters | ^[object] refer to [popper.js doc](https://popper.js.org/docs/v2/) | — |
| [input props](./input.md#attributes) | — | — | — |
### Events
@ -109,17 +109,17 @@ and please go to the original component to view the documentation.
| --------------------------------- | ----------------------------------- | ------------------------------------------------------------ |
| search | trigger when prefix hit | ^[Function]`(pattern: string, prefix: string) => void` |
| select | trigger when user select the option | ^[Function]`(option: MentionOption, prefix: string) => void` |
| [input events](./input.md#events) | - | - |
| [input events](./input.md#events) | — | — |
### Slots
| Name | Description | Type |
| ------------------------------- | ------------------------------------- | ------------------------------------------------- |
| label | content as option label | ^[object]`{ item: MentionOption, index: number }` |
| loading | content as option loading | - |
| header | content at the top of the dropdown | - |
| footer | content at the bottom of the dropdown | - |
| [input slots](./input.md#slots) | - | - |
| loading | content as option loading | — |
| header | content at the top of the dropdown | — |
| footer | content at the bottom of the dropdown | — |
| [input slots](./input.md#slots) | — | — |
### Exposes