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

fix(components): [select] add popper-options prop (#11734)

Browse Source
This commit is contained in:
류한경 2023-02-27 19:20:18 +09:00 committed by GitHub
parent 11925c8231
commit 8de2c9c450
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 46 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
docs/en-US/component/select.md
View File

@ -117,45 +117,47 @@ If the binding value of Select is an object, make sure to assign `value-key` as
## Select Attributes
| Name | Description | Type | Accepted Values | Default |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------------- |
| model-value / v-model | binding value | array / string / number / boolean / object | — | — |
| multiple | whether multiple-select is activated | boolean | true / false | false |
| disabled | whether Select is disabled | boolean | true / false | false |
| value-key | unique identity key name for value, required when value is an object | string | — | value |
| size | size of Input | string | large/default/small | default |
| clearable | whether select can be cleared | boolean | true / false | false |
| collapse-tags | whether to collapse tags to a text when multiple selecting | boolean | true / false | false |
| collapse-tags-tooltip | whether show all selected tags when mouse hover text of collapse-tags. To use this, `collapse-tags` must be true | boolean | true / false | false |
| multiple-limit | maximum number of options user can select when `multiple` is `true`. No limit when set to 0 | number | — | 0 |
| name | the name attribute of select input | string | — | — |
| effect | Tooltip theme, built-in theme: `dark` / `light` | string | string | light |
| autocomplete | the autocomplete attribute of select input | string | — | off |
| placeholder | placeholder | string | — | Select |
| filterable | whether Select is filterable | boolean | true / false | false |
| allow-create | whether creating new items is allowed. To use this, `filterable` must be true | boolean | true / false | false |
| filter-method | custom filter method | function | — | — |
| remote | whether options are loaded from server | boolean | true / false | false |
| remote-method | custom remote search method | function | — | — |
| remote-show-suffix | in remote search method show suffix icon | boolean | true / false | false |
| loading | whether Select is loading data from server | boolean | true / false | false |
| loading-text | displayed text while loading data from server | string | — | Loading |
| no-match-text | displayed text when no data matches the filtering query, you can also use slot `empty` | string | — | No matching data |
| no-data-text | displayed text when there is no options, you can also use slot `empty` | string | — | No data |
| popper-class | custom class name for Select's dropdown | string | — | — |
| reserve-keyword | when `multiple` and `filter` is true, whether to reserve current keyword after selecting an option | boolean | true / false | true |
| default-first-option | select first matching option on enter key. Use with `filterable` or `remote` | boolean | true / false | false |
| popper-append-to-body(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | boolean | true / false | true |
| teleported | whether select dropdown is teleported to the body | boolean | true / false | true |
| persistent | when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed | boolean | true / false | true |
| automatic-dropdown | for non-filterable Select, this prop decides if the option menu pops up when the input is focused | boolean | true / false | false |
| clear-icon | Custom clear icon component | `string \| Component` | — | CircleClose |
| fit-input-width | whether the width of the dropdown is the same as the input | boolean | true / false | false |
| suffix-icon | Custom suffix icon component | `string \| Component` | — | ArrowDown |
| suffix-transition<DeprecatedTag /> | animation when dropdown appears/disappears icon | boolean | true / false | true |
| tag-type | tag type | string | success/info/warning/danger | info |
| validate-event | whether to trigger form validation | boolean | true / false | true |
| placement | position of dropdown | string | top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end | bottom-start |
| Name | Description | Type | Accepted Values | Default |
| --------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------- | ---------------- |
| model-value / v-model | binding value | array / string / number / boolean / object | — | — |
| multiple | whether multiple-select is activated | boolean | true / false | false |
| disabled | whether Select is disabled | boolean | true / false | false |
| value-key | unique identity key name for value, required when value is an object | string | — | value |
| size | size of Input | string | large/default/small | default |
| clearable | whether select can be cleared | boolean | true / false | false |
| collapse-tags | whether to collapse tags to a text when multiple selecting | boolean | true / false | false |
| collapse-tags-tooltip | whether show all selected tags when mouse hover text of collapse-tags. To use this, `collapse-tags` must be true | boolean | true / false | false |
| multiple-limit | maximum number of options user can select when `multiple` is `true`. No limit when set to 0 | number | — | 0 |
| name | the name attribute of select input | string | — | — |
| effect | Tooltip theme, built-in theme: `dark` / `light` | string | string | light |
| autocomplete | the autocomplete attribute of select input | string | — | off |
| placeholder | placeholder | string | — | Select |
| filterable | whether Select is filterable | boolean | true / false | false |
| allow-create | whether creating new items is allowed. To use this, `filterable` must be true | boolean | true / false | false |
| filter-method | custom filter method | function | — | — |
| remote | whether options are loaded from server | boolean | true / false | false |
| remote-method | custom remote search method | function | — | — |
| remote-show-suffix | in remote search method show suffix icon | boolean | true / false | false |
| loading | whether Select is loading data from server | boolean | true / false | false |
| loading-text | displayed text while loading data from server | string | — | Loading |
| no-match-text | displayed text when no data matches the filtering query, you can also use slot `empty` | string | — | No matching data |
| no-data-text | displayed text when there is no options, you can also use slot `empty` | string | — | No data |
| popper-class | custom class name for Select's dropdown | string | — | — |
| popper-options | Customized popper option see more at [popper.js](https://popper.js.org/docs/v2/) | object | — | — |
| reserve-keyword | when `multiple` and `filter` is true, whether to reserve current keyword after selecting an option | boolean | true / false | true |
| default-first-option | select first matching option on enter key. Use with `filterable` or `remote` | boolean | true / false | false |
| popper-append-to-body(deprecated) | whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false | boolean | true / false | true |
| teleported | whether select dropdown is teleported to the body | boolean | true / false | true |
| persistent | when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed | boolean | true / false | true |
| automatic-dropdown | for non-filterable Select, this prop decides if the option menu pops up when the input is focused | boolean | true / false | false |
| clear-icon | Custom clear icon component | `string \| Component` | — | CircleClose |
| fit-input-width | whether the width of the dropdown is the same as the input | boolean | true / false | false |
| suffix-icon | Custom suffix icon component | `string \| Component` | — | ArrowDown |
| suffix-transition<DeprecatedTag /> | animation when dropdown appears/disappears icon | boolean | true / false | true |
| tag-type | tag type | string | success/info/warning/danger | info |
| validate-event | whether to trigger form validation | boolean | true / false | true |
| placement | position of dropdown | string | top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end | bottom-start |
:::warning

5
packages/components/select/src/select.vue
View File

@ -13,6 +13,7 @@
:placement="placement"
:teleported="teleported"
:popper-class="[nsSelect.e('popper'), popperClass]"
:popper-options="popperOptions"
:fallback-placements="['bottom-start', 'top-start', 'right', 'left']"
:effect="effect"
pure
@ -343,6 +344,10 @@ export default defineComponent({
type: String,
default: '',
},
popperOptions: {
type: Object as PropType<Partial<Options>>,
default: () => ({} as Partial<Options>),
},
remote: Boolean,
loadingText: String,
noMatchText: String,