Skip to content

fix: teleport dropdown to body to avoid clipping in scrollable contai… #1903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mattelen merged 3 commits into from
Jul 23, 2025
+66 −40
Merged

fix: teleport dropdown to body to avoid clipping in scrollable contai… #1903

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1653d8
fix: teleport dropdown to body to avoid clipping in scrollable contai…
Amirkian2023 Jul 14, 2025
5de8753
fix: prevent error when list ref is undefined (teleport context)
Amirkian2023 Jul 14, 2025
7e609b9
chore(multiselect): Fix Linting errors
mattelen Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 64 additions & 38 deletions src/Multiselect.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,30 +92,31 @@
</slot>
</span>
</div>
<transition name="multiselect">
<div
class="multiselect__content-wrapper"
v-show="isOpen"
@focus="activate"
tabindex="-1"
@mousedown.prevent
:style="{ maxHeight: optimizedHeight + 'px' }"
ref="list"
>
<teleport to="body">
<transition name="multiselect">
<div
class="multiselect__content-wrapper"
v-if="isOpen && ready"
@focus="activate"
tabindex="-1"
@mousedown.prevent
:style="[dropdownStyles, { maxHeight: optimizedHeight + 'px' }]"
ref="list"
>
<ul class="multiselect__content" :style="contentStyle" role="listbox" :id="'listbox-'+id" :aria-multiselectable="multiple">
<slot name="beforeList"></slot>
<li v-if="multiple && max === internalValue.length">
<slot name="beforeList"></slot>
<li v-if="multiple && max === internalValue.length">
<span class="multiselect__option">
<slot name="maxElements">Maximum of {{ max }} options selected. First remove a selected option to select another.</slot>
</span>
</li>
<template v-if="!max || internalValue.length < max">
<li class="multiselect__element"
v-for="(option, index) of filteredOptions"
:key="index"
:aria-selected="isSelected(option)"
v-bind:id="id + '-' + index"
v-bind:role="!(option && (option.$isLabel || option.$isDisabled)) ? 'option' : null">
</li>
<template v-if="!max || internalValue.length < max">
<li class="multiselect__element"
v-for="(option, index) of filteredOptions"
:key="index"
:aria-selected="isSelected(option)"
v-bind:id="id + '-' + index"
v-bind:role="!(option && (option.$isLabel || option.$isDisabled)) ? 'option' : null">
<span
v-if="!(option && (option.$isLabel || option.$isDisabled))"
:class="optionHighlight(index, option)"
Expand All @@ -129,34 +130,35 @@
<span>{{ getOptionLabel(option) }}</span>
</slot>
</span>
<span
v-if="option && (option.$isLabel || option.$isDisabled)"
:data-select="groupSelect && selectGroupLabelText"
:data-deselect="groupSelect && deselectGroupLabelText"
:class="groupHighlight(index, option)"
@mouseenter.self="groupSelect && pointerSet(index)"
@mousedown.prevent="selectGroup(option)"
class="multiselect__option">
<span
v-if="option && (option.$isLabel || option.$isDisabled)"
:data-select="groupSelect && selectGroupLabelText"
:data-deselect="groupSelect && deselectGroupLabelText"
:class="groupHighlight(index, option)"
@mouseenter.self="groupSelect && pointerSet(index)"
@mousedown.prevent="selectGroup(option)"
class="multiselect__option">
<slot name="option" :option="option" :search="search" :index="index">
<span>{{ getOptionLabel(option) }}</span>
</slot>
</span>
</li>
</template>
<li v-show="showNoResults && (filteredOptions.length === 0 && search && !loading)">
</li>
</template>
<li v-show="showNoResults && (filteredOptions.length === 0 && search && !loading)">
<span class="multiselect__option">
<slot name="noResult" :search="search">No elements found. Consider changing the search query.</slot>
</span>
</li>
</li>
<li v-show="showNoOptions && ((options.length === 0 || (hasOptionGroup === true && filteredOptions.length === 0)) && !search && !loading)">
<span class="multiselect__option">
<slot name="noOptions">List is empty.</slot>
</span>
</li>
<slot name="afterList"></slot>
</ul>
</div>
</transition>
</li>
<slot name="afterList"></slot>
</ul>
</div>
</transition>
</teleport>
</div>
</template>

Expand Down Expand Up @@ -337,6 +339,12 @@ export default {
default: false
}
},
data () {
return {
dropdownStyles: {},
ready: false
}
},
computed: {
hasOptionGroup () {
return this.groupValues && this.groupLabel && this.groupSelect
Expand Down Expand Up @@ -417,6 +425,24 @@ export default {
// if we have a value, any value, then this isn't required
return this.internalValue.length <= 0
}
},
watch: {
isOpen (val) {
if (val) {
this.ready = false
this.$nextTick(() => {
const rect = this.$el.getBoundingClientRect()
this.dropdownStyles = {
position: 'absolute',
top: `${rect.bottom + window.scrollY}px`,
left: `${rect.left + window.scrollX}px`,
width: `${rect.width}px`,
zIndex: 9999
}
this.ready = true
})
}
}
}
}
</script>
Expand Down Expand Up @@ -700,7 +726,7 @@ export default {
border-top: none;
border-bottom-left-radius: 5px;
border-bottom-right-radius: 5px;
z-index: 50;
z-index: 9999;
-webkit-overflow-scrolling: touch;
}

Expand Down
4 changes: 2 additions & 2 deletions src/pointerMixin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export default {
if (this.pointer < this.filteredOptions.length - 1) {
this.pointer++
/* istanbul ignore next */
if (this.$refs.list.scrollTop <= this.pointerPosition - (this.visibleElements - 1) * this.optionHeight) {
if (this.$refs.list?.scrollTop <= this.pointerPosition - (this.visibleElements - 1) * this.optionHeight) {
this.$refs.list.scrollTop = this.pointerPosition - (this.visibleElements - 1) * this.optionHeight
}
/* istanbul ignore else */
Expand All @@ -94,7 +94,7 @@ export default {
if (this.pointer > 0) {
this.pointer--
/* istanbul ignore else */
if (this.$refs.list.scrollTop >= this.pointerPosition) {
if (this.$refs.list?.scrollTop >= this.pointerPosition) {
this.$refs.list.scrollTop = this.pointerPosition
}
/* istanbul ignore else */
Expand Down