primevue-mirror/components/lib/dropdown/Dropdown.vue

1181 lines
43 KiB
Vue
Raw Normal View History

2022-09-06 12:03:37 +00:00
<template>
2023-05-07 20:37:26 +00:00
<div ref="container" :id="id" :class="containerClass" @click="onContainerClick" v-bind="ptm('root')">
2022-09-14 11:26:01 +00:00
<input
v-if="editable"
ref="focusInput"
:id="inputId"
type="text"
:style="inputStyle"
:class="inputStyleClass"
:value="editableInputValue"
:placeholder="placeholder"
:tabindex="!disabled ? tabindex : -1"
:disabled="disabled"
autocomplete="off"
role="combobox"
:aria-label="ariaLabel"
:aria-labelledby="ariaLabelledby"
aria-haspopup="listbox"
:aria-expanded="overlayVisible"
:aria-controls="id + '_list'"
:aria-activedescendant="focused ? focusedOptionId : undefined"
@focus="onFocus"
@blur="onBlur"
@keydown="onKeyDown"
@input="onEditableInput"
2023-05-07 20:37:26 +00:00
v-bind="{ ...inputProps, ...ptm('input') }"
2022-09-14 11:26:01 +00:00
/>
<span
v-else
ref="focusInput"
:id="inputId"
:style="inputStyle"
:class="inputStyleClass"
:tabindex="!disabled ? tabindex : -1"
role="combobox"
:aria-label="ariaLabel || (label === 'p-emptylabel' ? undefined : label)"
:aria-labelledby="ariaLabelledby"
aria-haspopup="listbox"
:aria-expanded="overlayVisible"
:aria-controls="id + '_list'"
:aria-activedescendant="focused ? focusedOptionId : undefined"
:aria-disabled="disabled"
@focus="onFocus"
@blur="onBlur"
@keydown="onKeyDown"
2023-05-07 20:37:26 +00:00
v-bind="{ ...inputProps, ...ptm('input') }"
2022-09-14 11:26:01 +00:00
>
<slot name="value" :value="modelValue" :placeholder="placeholder">{{ label === 'p-emptylabel' ? '&nbsp;' : label || 'empty' }}</slot>
2022-09-06 12:03:37 +00:00
</span>
<slot v-if="showClear && modelValue != null" name="clearicon" :onClick="onClearClick">
2023-05-07 20:37:26 +00:00
<component :is="clearIcon ? 'i' : 'TimesIcon'" :class="['p-dropdown-clear-icon', clearIcon]" @click="onClearClick" v-bind="{ ...clearIconProps, ...ptm('clearIcon') }" />
</slot>
2023-05-07 20:37:26 +00:00
<div class="p-dropdown-trigger" v-bind="ptm('trigger')">
<slot v-if="loading" name="loadingicon" class="p-dropdown-trigger-icon">
2023-05-07 20:37:26 +00:00
<span v-if="loadingIcon" :class="['p-dropdown-trigger-icon pi-spin', loadingIcon]" aria-hidden="true" v-bind="ptm('loadingIcon')" />
<SpinnerIcon v-else class="p-dropdown-trigger-icon" spin aria-hidden="true" v-bind="ptm('loadingIcon')" />
</slot>
<slot v-else name="dropdownicon" class="p-dropdown-trigger-icon">
2023-05-07 20:37:26 +00:00
<component :is="dropdownIcon ? 'span' : 'ChevronDownIcon'" :class="['p-dropdown-trigger-icon', dropdownIcon]" aria-hidden="true" v-bind="ptm('dropdownIcon')" />
</slot>
2022-09-06 12:03:37 +00:00
</div>
<Portal :appendTo="appendTo">
<transition name="p-connected-overlay" @enter="onOverlayEnter" @after-enter="onOverlayAfterEnter" @leave="onOverlayLeave" @after-leave="onOverlayAfterLeave">
2023-05-07 20:37:26 +00:00
<div v-if="overlayVisible" :ref="overlayRef" :style="panelStyle" :class="panelStyleClass" @click="onOverlayClick" @keydown="onOverlayKeyDown" v-bind="{ ...panelProps, ...ptm('panel') }">
<span ref="firstHiddenFocusableElementOnOverlay" role="presentation" aria-hidden="true" class="p-hidden-accessible p-hidden-focusable" :tabindex="0" @focus="onFirstHiddenFocus" v-bind="ptm('hiddenFirstFocusableEl')"></span>
2022-09-06 12:03:37 +00:00
<slot name="header" :value="modelValue" :options="visibleOptions"></slot>
2023-05-07 20:37:26 +00:00
<div v-if="filter" class="p-dropdown-header" v-bind="ptm('header')">
<div class="p-dropdown-filter-container" v-bind="ptm('filterContainer')">
2022-09-14 11:26:01 +00:00
<input
ref="filterInput"
type="text"
:value="filterValue"
@vue:mounted="onFilterUpdated"
2022-09-14 11:26:01 +00:00
class="p-dropdown-filter p-inputtext p-component"
:placeholder="filterPlaceholder"
role="searchbox"
autocomplete="off"
:aria-owns="id + '_list'"
:aria-activedescendant="focusedOptionId"
@keydown="onFilterKeyDown"
@blur="onFilterBlur"
@input="onFilterChange"
2023-05-07 20:37:26 +00:00
v-bind="{ ...filterInputProps, ...ptm('filterInput') }"
2022-09-14 11:26:01 +00:00
/>
<slot name="filtericon">
2023-05-07 20:37:26 +00:00
<component :is="filterIcon ? 'span' : 'FilterIcon'" :class="['p-dropdown-filter-icon', filterIcon]" v-bind="ptm('filterIcon')" />
</slot>
2022-09-06 12:03:37 +00:00
</div>
2023-05-07 20:37:26 +00:00
<span role="status" aria-live="polite" class="p-hidden-accessible" v-bind="ptm('hiddenFilterResult')">
2022-09-14 11:26:01 +00:00
{{ filterResultMessageText }}
2022-09-06 12:03:37 +00:00
</span>
</div>
2023-05-07 20:37:26 +00:00
<div class="p-dropdown-items-wrapper" :style="{ 'max-height': virtualScrollerDisabled ? scrollHeight : '' }" v-bind="ptm('wrapper')">
<VirtualScroller :ref="virtualScrollerRef" v-bind="{ ...virtualScrollerOptions, ...ptm('virtualScroller') }" :items="visibleOptions" :style="{ height: scrollHeight }" :tabindex="-1" :disabled="virtualScrollerDisabled">
2022-09-06 12:03:37 +00:00
<template v-slot:content="{ styleClass, contentRef, items, getItemOptions, contentStyle, itemSize }">
2023-05-07 20:37:26 +00:00
<ul :ref="(el) => listRef(el, contentRef)" :id="id + '_list'" :class="['p-dropdown-items', styleClass]" :style="contentStyle" role="listbox" v-bind="ptm('list')">
2022-09-06 12:03:37 +00:00
<template v-for="(option, i) of items" :key="getOptionRenderKey(option, getOptionIndex(i, getItemOptions))">
2023-05-07 20:37:26 +00:00
<li
v-if="isOptionGroup(option)"
:id="id + '_' + getOptionIndex(i, getItemOptions)"
:style="{ height: itemSize ? itemSize + 'px' : undefined }"
class="p-dropdown-item-group"
role="option"
v-bind="ptm('itemGroup')"
>
2022-09-14 11:26:01 +00:00
<slot name="optiongroup" :option="option.optionGroup" :index="getOptionIndex(i, getItemOptions)">{{ getOptionGroupLabel(option.optionGroup) }}</slot>
2022-09-06 12:03:37 +00:00
</li>
2022-09-14 11:26:01 +00:00
<li
v-else
:id="id + '_' + getOptionIndex(i, getItemOptions)"
v-ripple
:style="{ height: itemSize ? itemSize + 'px' : undefined }"
:class="['p-dropdown-item', { 'p-highlight': isSelected(option), 'p-focus': focusedOptionIndex === getOptionIndex(i, getItemOptions), 'p-disabled': isOptionDisabled(option) }]"
role="option"
:aria-label="getOptionLabel(option)"
:aria-selected="isSelected(option)"
:aria-disabled="isOptionDisabled(option)"
:aria-setsize="ariaSetSize"
:aria-posinset="getAriaPosInset(getOptionIndex(i, getItemOptions))"
@click="onOptionSelect($event, option)"
@mousemove="onOptionMouseMove($event, getOptionIndex(i, getItemOptions))"
2023-05-07 20:37:26 +00:00
v-bind="getPTOptions(option, getItemOptions, i, 'item')"
2022-09-14 11:26:01 +00:00
>
<slot name="option" :option="option" :index="getOptionIndex(i, getItemOptions)">{{ getOptionLabel(option) }}</slot>
2022-09-06 12:03:37 +00:00
</li>
</template>
2023-05-07 20:37:26 +00:00
<li v-if="filterValue && (!items || (items && items.length === 0))" class="p-dropdown-empty-message" role="option" v-bind="ptm('emptyMessage')">
2022-09-14 11:26:01 +00:00
<slot name="emptyfilter">{{ emptyFilterMessageText }}</slot>
2022-09-06 12:03:37 +00:00
</li>
2023-05-07 20:37:26 +00:00
<li v-else-if="!options || (options && options.length === 0)" class="p-dropdown-empty-message" role="option" v-bind="ptm('emptyMessage')">
2022-09-14 11:26:01 +00:00
<slot name="empty">{{ emptyMessageText }}</slot>
2022-09-06 12:03:37 +00:00
</li>
</ul>
</template>
<template v-if="$slots.loader" v-slot:loader="{ options }">
<slot name="loader" :options="options"></slot>
</template>
</VirtualScroller>
</div>
<slot name="footer" :value="modelValue" :options="visibleOptions"></slot>
2023-05-07 20:37:26 +00:00
<span v-if="!options || (options && options.length === 0)" role="status" aria-live="polite" class="p-hidden-accessible" v-bind="ptm('emptyMessage')">
2022-12-08 11:04:25 +00:00
{{ emptyMessageText }}
</span>
2023-05-07 20:37:26 +00:00
<span role="status" aria-live="polite" class="p-hidden-accessible" v-bind="ptm('hiddenSelectedMessage')">
2022-12-08 11:04:25 +00:00
{{ selectedMessageText }}
</span>
2023-05-07 20:37:26 +00:00
<span ref="lastHiddenFocusableElementOnOverlay" role="presentation" aria-hidden="true" class="p-hidden-accessible p-hidden-focusable" :tabindex="0" @focus="onLastHiddenFocus" v-bind="ptm('hiddenLastFocusableEl')"></span>
2022-09-06 12:03:37 +00:00
</div>
</transition>
</Portal>
</div>
</template>
<script>
2022-09-14 11:26:01 +00:00
import { FilterService } from 'primevue/api';
2023-05-07 20:37:26 +00:00
import BaseComponent from 'primevue/basecomponent';
import ChevronDownIcon from 'primevue/icons/chevrondown';
import FilterIcon from 'primevue/icons/filter';
import SpinnerIcon from 'primevue/icons/spinner';
import TimesIcon from 'primevue/icons/times';
2022-12-08 11:04:25 +00:00
import OverlayEventBus from 'primevue/overlayeventbus';
import Portal from 'primevue/portal';
2022-09-06 12:03:37 +00:00
import Ripple from 'primevue/ripple';
2022-12-08 11:04:25 +00:00
import { ConnectedOverlayScrollHandler, DomHandler, ObjectUtils, UniqueComponentId, ZIndexUtils } from 'primevue/utils';
2022-09-06 12:03:37 +00:00
import VirtualScroller from 'primevue/virtualscroller';
export default {
name: 'Dropdown',
2023-05-07 20:37:26 +00:00
extends: BaseComponent,
2022-09-06 12:03:37 +00:00
emits: ['update:modelValue', 'change', 'focus', 'blur', 'before-show', 'before-hide', 'show', 'hide', 'filter'],
props: {
modelValue: null,
options: Array,
optionLabel: null,
optionValue: null,
optionDisabled: null,
optionGroupLabel: null,
optionGroupChildren: null,
2022-09-14 11:26:01 +00:00
scrollHeight: {
type: String,
default: '200px'
},
filter: Boolean,
2022-09-06 12:03:37 +00:00
filterPlaceholder: String,
filterLocale: String,
filterMatchMode: {
type: String,
default: 'contains'
},
filterFields: {
type: Array,
default: null
},
2022-09-14 11:26:01 +00:00
editable: Boolean,
placeholder: {
type: String,
default: null
},
disabled: {
type: Boolean,
default: false
},
2022-09-06 12:03:37 +00:00
dataKey: null,
2022-09-14 11:26:01 +00:00
showClear: {
type: Boolean,
default: false
},
inputId: {
type: String,
default: null
},
inputClass: {
type: [String, Object],
2022-09-14 11:26:01 +00:00
default: null
},
inputStyle: {
type: Object,
2022-09-14 11:26:01 +00:00
default: null
},
inputProps: {
type: null,
default: null
},
panelClass: {
type: [String, Object],
2022-09-14 11:26:01 +00:00
default: null
},
panelStyle: {
type: Object,
2022-09-14 11:26:01 +00:00
default: null
},
panelProps: {
type: null,
default: null
},
filterInputProps: {
type: null,
default: null
},
clearIconProps: {
type: null,
default: null
},
2022-09-06 12:03:37 +00:00
appendTo: {
type: String,
default: 'body'
},
loading: {
type: Boolean,
default: false
},
2022-12-08 11:04:25 +00:00
clearIcon: {
type: String,
default: undefined
2022-12-08 11:04:25 +00:00
},
dropdownIcon: {
type: String,
default: undefined
2022-12-08 11:04:25 +00:00
},
filterIcon: {
type: String,
default: undefined
2022-12-08 11:04:25 +00:00
},
2022-09-06 12:03:37 +00:00
loadingIcon: {
type: String,
default: undefined
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
resetFilterOnHide: {
type: Boolean,
default: false
},
2022-09-06 12:03:37 +00:00
virtualScrollerOptions: {
type: Object,
default: null
},
autoOptionFocus: {
type: Boolean,
default: true
},
2022-09-14 11:26:01 +00:00
autoFilterFocus: {
type: Boolean,
default: false
},
selectOnFocus: {
type: Boolean,
default: false
},
2022-09-06 12:03:37 +00:00
filterMessage: {
type: String,
default: null
},
selectionMessage: {
type: String,
default: null
},
emptySelectionMessage: {
type: String,
default: null
},
emptyFilterMessage: {
type: String,
default: null
},
emptyMessage: {
type: String,
default: null
},
tabindex: {
type: Number,
default: 0
},
'aria-label': {
type: String,
default: null
},
'aria-labelledby': {
type: String,
default: null
}
},
outsideClickListener: null,
scrollHandler: null,
resizeListener: null,
overlay: null,
list: null,
virtualScroller: null,
searchTimeout: null,
searchValue: null,
isModelValueChanged: false,
focusOnHover: false,
data() {
return {
id: this.$attrs.id,
2022-09-06 12:03:37 +00:00
focused: false,
focusedOptionIndex: -1,
filterValue: null,
overlayVisible: false
2022-09-14 11:26:01 +00:00
};
2022-09-06 12:03:37 +00:00
},
watch: {
'$attrs.id': function (newValue) {
this.id = newValue || UniqueComponentId();
},
2022-09-06 12:03:37 +00:00
modelValue() {
this.isModelValueChanged = true;
},
options() {
this.autoUpdateModel();
}
},
mounted() {
this.id = this.id || UniqueComponentId();
2022-09-06 12:03:37 +00:00
this.autoUpdateModel();
},
updated() {
if (this.overlayVisible && this.isModelValueChanged) {
this.scrollInView(this.findSelectedOptionIndex());
}
this.isModelValueChanged = false;
},
beforeUnmount() {
this.unbindOutsideClickListener();
this.unbindResizeListener();
if (this.scrollHandler) {
this.scrollHandler.destroy();
this.scrollHandler = null;
}
if (this.overlay) {
ZIndexUtils.clear(this.overlay);
this.overlay = null;
}
},
methods: {
getOptionIndex(index, fn) {
2022-09-14 11:26:01 +00:00
return this.virtualScrollerDisabled ? index : fn && fn(index)['index'];
2022-09-06 12:03:37 +00:00
},
getOptionLabel(option) {
return this.optionLabel ? ObjectUtils.resolveFieldData(option, this.optionLabel) : option;
},
getOptionValue(option) {
return this.optionValue ? ObjectUtils.resolveFieldData(option, this.optionValue) : option;
},
getOptionRenderKey(option, index) {
return (this.dataKey ? ObjectUtils.resolveFieldData(option, this.dataKey) : this.getOptionLabel(option)) + '_' + index;
},
2023-05-07 20:37:26 +00:00
getPTOptions(option, itemOptions, index, key) {
return this.ptm(key, {
context: {
selected: this.isSelected(option),
focused: this.focusedOptionIndex === this.getOptionIndex(index, itemOptions),
disabled: this.isOptionDisabled(option)
}
});
},
2022-09-06 12:03:37 +00:00
isOptionDisabled(option) {
return this.optionDisabled ? ObjectUtils.resolveFieldData(option, this.optionDisabled) : false;
},
isOptionGroup(option) {
return this.optionGroupLabel && option.optionGroup && option.group;
},
getOptionGroupLabel(optionGroup) {
return ObjectUtils.resolveFieldData(optionGroup, this.optionGroupLabel);
},
getOptionGroupChildren(optionGroup) {
return ObjectUtils.resolveFieldData(optionGroup, this.optionGroupChildren);
},
getAriaPosInset(index) {
2022-09-14 11:26:01 +00:00
return (this.optionGroupLabel ? index - this.visibleOptions.slice(0, index).filter((option) => this.isOptionGroup(option)).length : index) + 1;
2022-09-06 12:03:37 +00:00
},
show(isFocus) {
this.$emit('before-show');
this.overlayVisible = true;
2022-09-14 11:26:01 +00:00
this.focusedOptionIndex = this.focusedOptionIndex !== -1 ? this.focusedOptionIndex : this.autoOptionFocus ? this.findFirstFocusedOptionIndex() : -1;
2022-09-06 12:03:37 +00:00
2022-09-14 11:26:01 +00:00
isFocus && DomHandler.focus(this.$refs.focusInput);
2022-09-06 12:03:37 +00:00
},
hide(isFocus) {
const _hide = () => {
this.$emit('before-hide');
this.overlayVisible = false;
this.focusedOptionIndex = -1;
this.searchValue = '';
2022-09-14 11:26:01 +00:00
this.resetFilterOnHide && (this.filterValue = null);
isFocus && DomHandler.focus(this.$refs.focusInput);
};
2022-09-06 12:03:37 +00:00
2022-09-14 11:26:01 +00:00
setTimeout(() => {
_hide();
}, 0); // For ScreenReaders
2022-09-06 12:03:37 +00:00
},
onFocus(event) {
if (this.disabled) {
// For ScreenReaders
return;
}
2022-09-06 12:03:37 +00:00
this.focused = true;
2022-12-08 11:04:25 +00:00
this.focusedOptionIndex = this.focusedOptionIndex !== -1 ? this.focusedOptionIndex : this.overlayVisible && this.autoOptionFocus ? this.findFirstFocusedOptionIndex() : -1;
2022-09-06 12:03:37 +00:00
this.overlayVisible && this.scrollInView(this.focusedOptionIndex);
this.$emit('focus', event);
},
onBlur(event) {
this.focused = false;
this.focusedOptionIndex = -1;
this.searchValue = '';
this.$emit('blur', event);
},
onKeyDown(event) {
if (this.disabled) {
event.preventDefault();
return;
}
2022-09-14 11:26:01 +00:00
const metaKey = event.metaKey || event.ctrlKey;
2022-09-06 12:03:37 +00:00
switch (event.code) {
case 'ArrowDown':
this.onArrowDownKey(event);
break;
case 'ArrowUp':
this.onArrowUpKey(event, this.editable);
break;
case 'ArrowLeft':
case 'ArrowRight':
this.onArrowLeftKey(event, this.editable);
break;
case 'Home':
this.onHomeKey(event, this.editable);
break;
case 'End':
this.onEndKey(event, this.editable);
break;
case 'PageDown':
this.onPageDownKey(event);
break;
case 'PageUp':
this.onPageUpKey(event);
break;
case 'Space':
this.onSpaceKey(event, this.editable);
break;
case 'Enter':
2022-12-08 11:04:25 +00:00
case 'NumpadEnter':
2022-09-06 12:03:37 +00:00
this.onEnterKey(event);
break;
case 'Escape':
this.onEscapeKey(event);
break;
case 'Tab':
this.onTabKey(event);
break;
case 'Backspace':
this.onBackspaceKey(event, this.editable);
break;
case 'ShiftLeft':
case 'ShiftRight':
//NOOP
break;
default:
2022-09-14 11:26:01 +00:00
if (!metaKey && ObjectUtils.isPrintableCharacter(event.key)) {
2022-09-06 12:03:37 +00:00
!this.overlayVisible && this.show();
!this.editable && this.searchOptions(event, event.key);
}
break;
}
},
onEditableInput(event) {
const value = event.target.value;
this.searchValue = '';
const matched = this.searchOptions(event, value);
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
!matched && (this.focusedOptionIndex = -1);
this.updateModel(event, value);
2022-09-06 12:03:37 +00:00
},
onContainerClick(event) {
if (this.disabled || this.loading) {
return;
}
if (DomHandler.hasClass(event.target, 'p-dropdown-clear-icon') || event.target.tagName === 'INPUT') {
return;
2022-09-14 11:26:01 +00:00
} else if (!this.overlay || !this.overlay.contains(event.target)) {
2022-09-06 12:03:37 +00:00
this.overlayVisible ? this.hide(true) : this.show(true);
}
},
onClearClick(event) {
this.updateModel(event, null);
},
onFirstHiddenFocus(event) {
2022-12-08 11:04:25 +00:00
const focusableEl = event.relatedTarget === this.$refs.focusInput ? DomHandler.getFirstFocusableElement(this.overlay, ':not(.p-hidden-focusable)') : this.$refs.focusInput;
2022-09-14 11:26:01 +00:00
2022-12-08 11:04:25 +00:00
DomHandler.focus(focusableEl);
2022-09-06 12:03:37 +00:00
},
2022-12-08 11:04:25 +00:00
onLastHiddenFocus(event) {
const focusableEl = event.relatedTarget === this.$refs.focusInput ? DomHandler.getLastFocusableElement(this.overlay, ':not(.p-hidden-focusable)') : this.$refs.focusInput;
DomHandler.focus(focusableEl);
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
onOptionSelect(event, option, isHide = true) {
2022-09-06 12:03:37 +00:00
const value = this.getOptionValue(option);
this.updateModel(event, value);
2022-09-14 11:26:01 +00:00
isHide && this.hide(true);
2022-09-06 12:03:37 +00:00
},
onOptionMouseMove(event, index) {
if (this.focusOnHover) {
this.changeFocusedOptionIndex(event, index);
}
},
onFilterChange(event) {
const value = event.target.value;
this.filterValue = value;
this.focusedOptionIndex = -1;
this.$emit('filter', { originalEvent: event, value });
!this.virtualScrollerDisabled && this.virtualScroller.scrollToIndex(0);
},
onFilterKeyDown(event) {
switch (event.code) {
case 'ArrowDown':
this.onArrowDownKey(event);
break;
case 'ArrowUp':
this.onArrowUpKey(event, true);
break;
case 'ArrowLeft':
case 'ArrowRight':
this.onArrowLeftKey(event, true);
break;
case 'Home':
this.onHomeKey(event, true);
break;
case 'End':
this.onEndKey(event, true);
break;
case 'Enter':
this.onEnterKey(event);
break;
case 'Escape':
this.onEscapeKey(event);
break;
case 'Tab':
this.onTabKey(event, true);
break;
default:
break;
}
},
onFilterBlur() {
this.focusedOptionIndex = -1;
},
onFilterUpdated() {
if (this.overlayVisible) {
this.alignOverlay();
}
},
onOverlayClick(event) {
OverlayEventBus.emit('overlay-click', {
originalEvent: event,
target: this.$el
});
},
onOverlayKeyDown(event) {
switch (event.code) {
case 'Escape':
this.onEscapeKey(event);
break;
default:
break;
}
},
onArrowDownKey(event) {
const optionIndex = this.focusedOptionIndex !== -1 ? this.findNextOptionIndex(this.focusedOptionIndex) : this.findFirstFocusedOptionIndex();
this.changeFocusedOptionIndex(event, optionIndex);
!this.overlayVisible && this.show();
event.preventDefault();
},
onArrowUpKey(event, pressedInInputText = false) {
if (event.altKey && !pressedInInputText) {
if (this.focusedOptionIndex !== -1) {
this.onOptionSelect(event, this.visibleOptions[this.focusedOptionIndex]);
}
this.overlayVisible && this.hide();
event.preventDefault();
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
const optionIndex = this.focusedOptionIndex !== -1 ? this.findPrevOptionIndex(this.focusedOptionIndex) : this.findLastFocusedOptionIndex();
this.changeFocusedOptionIndex(event, optionIndex);
!this.overlayVisible && this.show();
event.preventDefault();
}
},
onArrowLeftKey(event, pressedInInputText = false) {
pressedInInputText && (this.focusedOptionIndex = -1);
},
onHomeKey(event, pressedInInputText = false) {
if (pressedInInputText) {
event.currentTarget.setSelectionRange(0, 0);
this.focusedOptionIndex = -1;
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
this.changeFocusedOptionIndex(event, this.findFirstOptionIndex());
!this.overlayVisible && this.show();
}
event.preventDefault();
},
onEndKey(event, pressedInInputText = false) {
if (pressedInInputText) {
const target = event.currentTarget;
const len = target.value.length;
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
target.setSelectionRange(len, len);
this.focusedOptionIndex = -1;
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
this.changeFocusedOptionIndex(event, this.findLastOptionIndex());
!this.overlayVisible && this.show();
}
event.preventDefault();
},
onPageUpKey(event) {
this.scrollInView(0);
event.preventDefault();
},
onPageDownKey(event) {
this.scrollInView(this.visibleOptions.length - 1);
event.preventDefault();
},
onEnterKey(event) {
if (!this.overlayVisible) {
this.onArrowDownKey(event);
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
if (this.focusedOptionIndex !== -1) {
this.onOptionSelect(event, this.visibleOptions[this.focusedOptionIndex]);
}
this.hide();
}
event.preventDefault();
},
onSpaceKey(event, pressedInInputText = false) {
!pressedInInputText && this.onEnterKey(event);
},
onEscapeKey(event) {
this.overlayVisible && this.hide(true);
event.preventDefault();
},
onTabKey(event, pressedInInputText = false) {
if (!pressedInInputText) {
if (this.overlayVisible && this.hasFocusableElements()) {
2022-09-14 11:26:01 +00:00
DomHandler.focus(this.$refs.firstHiddenFocusableElementOnOverlay);
2022-09-06 12:03:37 +00:00
event.preventDefault();
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
if (this.focusedOptionIndex !== -1) {
this.onOptionSelect(event, this.visibleOptions[this.focusedOptionIndex]);
}
this.overlayVisible && this.hide(this.filter);
}
}
},
onBackspaceKey(event, pressedInInputText = false) {
if (pressedInInputText) {
!this.overlayVisible && this.show();
}
},
onOverlayEnter(el) {
ZIndexUtils.set('overlay', el, this.$primevue.config.zIndex.overlay);
this.alignOverlay();
this.scrollInView();
2022-09-14 11:26:01 +00:00
this.autoFilterFocus && DomHandler.focus(this.$refs.filterInput);
2022-09-06 12:03:37 +00:00
},
onOverlayAfterEnter() {
this.bindOutsideClickListener();
this.bindScrollListener();
this.bindResizeListener();
this.$emit('show');
},
onOverlayLeave() {
this.unbindOutsideClickListener();
this.unbindScrollListener();
this.unbindResizeListener();
this.$emit('hide');
this.overlay = null;
},
onOverlayAfterLeave(el) {
ZIndexUtils.clear(el);
},
alignOverlay() {
if (this.appendTo === 'self') {
DomHandler.relativePosition(this.overlay, this.$el);
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
this.overlay.style.minWidth = DomHandler.getOuterWidth(this.$el) + 'px';
DomHandler.absolutePosition(this.overlay, this.$el);
}
},
bindOutsideClickListener() {
if (!this.outsideClickListener) {
this.outsideClickListener = (event) => {
if (this.overlayVisible && this.overlay && !this.$el.contains(event.target) && !this.overlay.contains(event.target)) {
this.hide();
}
};
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
document.addEventListener('click', this.outsideClickListener);
}
},
unbindOutsideClickListener() {
if (this.outsideClickListener) {
document.removeEventListener('click', this.outsideClickListener);
this.outsideClickListener = null;
}
},
bindScrollListener() {
if (!this.scrollHandler) {
this.scrollHandler = new ConnectedOverlayScrollHandler(this.$refs.container, () => {
if (this.overlayVisible) {
this.hide();
}
});
}
this.scrollHandler.bindScrollListener();
},
unbindScrollListener() {
if (this.scrollHandler) {
this.scrollHandler.unbindScrollListener();
}
},
bindResizeListener() {
if (!this.resizeListener) {
this.resizeListener = () => {
if (this.overlayVisible && !DomHandler.isTouchDevice()) {
this.hide();
}
};
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
window.addEventListener('resize', this.resizeListener);
}
},
unbindResizeListener() {
if (this.resizeListener) {
window.removeEventListener('resize', this.resizeListener);
this.resizeListener = null;
}
},
hasFocusableElements() {
return DomHandler.getFocusableElements(this.overlay, ':not(.p-hidden-focusable)').length > 0;
},
isOptionMatched(option) {
return this.isValidOption(option) && this.getOptionLabel(option).toLocaleLowerCase(this.filterLocale).startsWith(this.searchValue.toLocaleLowerCase(this.filterLocale));
},
isValidOption(option) {
return option && !(this.isOptionDisabled(option) || this.isOptionGroup(option));
},
isValidSelectedOption(option) {
return this.isValidOption(option) && this.isSelected(option);
},
isSelected(option) {
2023-03-19 20:41:07 +00:00
return this.isValidOption(option) && ObjectUtils.equals(this.modelValue, this.getOptionValue(option), this.equalityKey);
2022-09-06 12:03:37 +00:00
},
findFirstOptionIndex() {
2022-09-14 11:26:01 +00:00
return this.visibleOptions.findIndex((option) => this.isValidOption(option));
2022-09-06 12:03:37 +00:00
},
findLastOptionIndex() {
2022-09-14 11:26:01 +00:00
return ObjectUtils.findLastIndex(this.visibleOptions, (option) => this.isValidOption(option));
2022-09-06 12:03:37 +00:00
},
findNextOptionIndex(index) {
2022-09-14 11:26:01 +00:00
const matchedOptionIndex = index < this.visibleOptions.length - 1 ? this.visibleOptions.slice(index + 1).findIndex((option) => this.isValidOption(option)) : -1;
2022-09-06 12:03:37 +00:00
return matchedOptionIndex > -1 ? matchedOptionIndex + index + 1 : index;
},
findPrevOptionIndex(index) {
2022-09-14 11:26:01 +00:00
const matchedOptionIndex = index > 0 ? ObjectUtils.findLastIndex(this.visibleOptions.slice(0, index), (option) => this.isValidOption(option)) : -1;
2022-09-06 12:03:37 +00:00
return matchedOptionIndex > -1 ? matchedOptionIndex : index;
},
findSelectedOptionIndex() {
2022-09-14 11:26:01 +00:00
return this.hasSelectedOption ? this.visibleOptions.findIndex((option) => this.isValidSelectedOption(option)) : -1;
2022-09-06 12:03:37 +00:00
},
findFirstFocusedOptionIndex() {
const selectedIndex = this.findSelectedOptionIndex();
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
return selectedIndex < 0 ? this.findFirstOptionIndex() : selectedIndex;
},
findLastFocusedOptionIndex() {
const selectedIndex = this.findSelectedOptionIndex();
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
return selectedIndex < 0 ? this.findLastOptionIndex() : selectedIndex;
},
searchOptions(event, char) {
this.searchValue = (this.searchValue || '') + char;
let optionIndex = -1;
let matched = false;
if (this.focusedOptionIndex !== -1) {
2022-09-14 11:26:01 +00:00
optionIndex = this.visibleOptions.slice(this.focusedOptionIndex).findIndex((option) => this.isOptionMatched(option));
optionIndex = optionIndex === -1 ? this.visibleOptions.slice(0, this.focusedOptionIndex).findIndex((option) => this.isOptionMatched(option)) : optionIndex + this.focusedOptionIndex;
} else {
optionIndex = this.visibleOptions.findIndex((option) => this.isOptionMatched(option));
2022-09-06 12:03:37 +00:00
}
if (optionIndex !== -1) {
matched = true;
}
if (optionIndex === -1 && this.focusedOptionIndex === -1) {
optionIndex = this.findFirstFocusedOptionIndex();
}
if (optionIndex !== -1) {
this.changeFocusedOptionIndex(event, optionIndex);
}
if (this.searchTimeout) {
clearTimeout(this.searchTimeout);
}
this.searchTimeout = setTimeout(() => {
this.searchValue = '';
this.searchTimeout = null;
}, 500);
return matched;
},
changeFocusedOptionIndex(event, index) {
if (this.focusedOptionIndex !== index) {
this.focusedOptionIndex = index;
this.scrollInView();
if (this.selectOnFocus) {
2022-09-14 11:26:01 +00:00
this.onOptionSelect(event, this.visibleOptions[index], false);
2022-09-06 12:03:37 +00:00
}
}
},
scrollInView(index = -1) {
const id = index !== -1 ? `${this.id}_${index}` : this.focusedOptionId;
const element = DomHandler.findSingle(this.list, `li[id="${id}"]`);
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
if (element) {
element.scrollIntoView && element.scrollIntoView({ block: 'nearest', inline: 'start' });
2022-09-14 11:26:01 +00:00
} else if (!this.virtualScrollerDisabled) {
2022-09-06 12:03:37 +00:00
setTimeout(() => {
this.virtualScroller && this.virtualScroller.scrollToIndex(index !== -1 ? index : this.focusedOptionIndex);
}, 0);
}
},
autoUpdateModel() {
if (this.selectOnFocus && this.autoOptionFocus && !this.hasSelectedOption) {
this.focusedOptionIndex = this.findFirstFocusedOptionIndex();
2022-09-14 11:26:01 +00:00
this.onOptionSelect(null, this.visibleOptions[this.focusedOptionIndex], false);
2022-09-06 12:03:37 +00:00
}
},
updateModel(event, value) {
this.$emit('update:modelValue', value);
this.$emit('change', { originalEvent: event, value });
},
flatOptions(options) {
return (options || []).reduce((result, option, index) => {
result.push({ optionGroup: option, group: true, index });
const optionGroupChildren = this.getOptionGroupChildren(option);
2022-09-14 11:26:01 +00:00
optionGroupChildren && optionGroupChildren.forEach((o) => result.push(o));
2022-09-06 12:03:37 +00:00
return result;
}, []);
},
overlayRef(el) {
this.overlay = el;
},
listRef(el, contentRef) {
this.list = el;
contentRef && contentRef(el); // For VirtualScroller
},
virtualScrollerRef(el) {
this.virtualScroller = el;
}
},
computed: {
containerClass() {
2022-09-14 11:26:01 +00:00
return [
'p-dropdown p-component p-inputwrapper',
{
'p-disabled': this.disabled,
'p-dropdown-clearable': this.showClear && !this.disabled,
'p-focus': this.focused,
'p-inputwrapper-filled': this.hasSelectedOption,
2022-09-14 11:26:01 +00:00
'p-inputwrapper-focus': this.focused || this.overlayVisible,
'p-overlay-open': this.overlayVisible
}
];
2022-09-06 12:03:37 +00:00
},
inputStyleClass() {
2022-09-14 11:26:01 +00:00
return [
'p-dropdown-label p-inputtext',
this.inputClass,
{
'p-placeholder': !this.editable && this.label === this.placeholder,
'p-dropdown-label-empty': !this.editable && !this.$slots['value'] && (this.label === 'p-emptylabel' || this.label.length === 0)
}
];
2022-09-06 12:03:37 +00:00
},
panelStyleClass() {
2022-09-14 11:26:01 +00:00
return [
'p-dropdown-panel p-component',
this.panelClass,
{
'p-input-filled': this.$primevue.config.inputStyle === 'filled',
'p-ripple-disabled': this.$primevue.config.ripple === false
}
];
2022-09-06 12:03:37 +00:00
},
visibleOptions() {
2022-09-14 11:26:01 +00:00
const options = this.optionGroupLabel ? this.flatOptions(this.options) : this.options || [];
2022-09-06 12:03:37 +00:00
2022-12-08 11:04:25 +00:00
if (this.filterValue) {
const filteredOptions = FilterService.filter(options, this.searchFields, this.filterValue, this.filterMatchMode, this.filterLocale);
if (this.optionGroupLabel) {
const optionGroups = this.options || [];
const filtered = [];
optionGroups.forEach((group) => {
const groupChildren = this.getOptionGroupChildren(group);
const filteredItems = groupChildren.filter((item) => filteredOptions.includes(item));
2022-12-08 11:04:25 +00:00
if (filteredItems.length > 0) filtered.push({ ...group, [typeof this.optionGroupChildren === 'string' ? this.optionGroupChildren : 'items']: [...filteredItems] });
2022-12-08 11:04:25 +00:00
});
return this.flatOptions(filtered);
}
return filteredOptions;
}
return options;
2022-09-06 12:03:37 +00:00
},
hasSelectedOption() {
return ObjectUtils.isNotEmpty(this.modelValue);
},
label() {
const selectedOptionIndex = this.findSelectedOptionIndex();
2022-09-14 11:26:01 +00:00
return selectedOptionIndex !== -1 ? this.getOptionLabel(this.visibleOptions[selectedOptionIndex]) : this.placeholder || 'p-emptylabel';
2022-09-06 12:03:37 +00:00
},
editableInputValue() {
const selectedOptionIndex = this.findSelectedOptionIndex();
2022-09-14 11:26:01 +00:00
return selectedOptionIndex !== -1 ? this.getOptionLabel(this.visibleOptions[selectedOptionIndex]) : this.modelValue || '';
2022-09-06 12:03:37 +00:00
},
equalityKey() {
return this.optionValue ? null : this.dataKey;
},
searchFields() {
return this.filterFields || [this.optionLabel];
},
filterResultMessageText() {
return ObjectUtils.isNotEmpty(this.visibleOptions) ? this.filterMessageText.replaceAll('{0}', this.visibleOptions.length) : this.emptyFilterMessageText;
},
filterMessageText() {
return this.filterMessage || this.$primevue.config.locale.searchMessage || '';
},
emptyFilterMessageText() {
return this.emptyFilterMessage || this.$primevue.config.locale.emptySearchMessage || this.$primevue.config.locale.emptyFilterMessage || '';
},
emptyMessageText() {
return this.emptyMessage || this.$primevue.config.locale.emptyMessage || '';
},
selectionMessageText() {
return this.selectionMessage || this.$primevue.config.locale.selectionMessage || '';
},
emptySelectionMessageText() {
return this.emptySelectionMessage || this.$primevue.config.locale.emptySelectionMessage || '';
},
selectedMessageText() {
return this.hasSelectedOption ? this.selectionMessageText.replaceAll('{0}', '1') : this.emptySelectionMessageText;
},
focusedOptionId() {
return this.focusedOptionIndex !== -1 ? `${this.id}_${this.focusedOptionIndex}` : null;
},
ariaSetSize() {
2022-09-14 11:26:01 +00:00
return this.visibleOptions.filter((option) => !this.isOptionGroup(option)).length;
2022-09-06 12:03:37 +00:00
},
virtualScrollerDisabled() {
return !this.virtualScrollerOptions;
}
},
directives: {
2022-09-14 11:26:01 +00:00
ripple: Ripple
2022-09-06 12:03:37 +00:00
},
components: {
2022-09-14 11:26:01 +00:00
VirtualScroller: VirtualScroller,
Portal: Portal,
TimesIcon: TimesIcon,
ChevronDownIcon: ChevronDownIcon,
SpinnerIcon: SpinnerIcon,
FilterIcon: FilterIcon
2022-09-06 12:03:37 +00:00
}
2022-09-14 11:26:01 +00:00
};
2022-09-06 12:03:37 +00:00
</script>
<style>
.p-dropdown {
display: inline-flex;
cursor: pointer;
position: relative;
user-select: none;
}
.p-dropdown-clear-icon {
position: absolute;
top: 50%;
2022-09-14 11:26:01 +00:00
margin-top: -0.5rem;
2022-09-06 12:03:37 +00:00
}
.p-dropdown-trigger {
display: flex;
align-items: center;
justify-content: center;
flex-shrink: 0;
}
.p-dropdown-label {
display: block;
white-space: nowrap;
overflow: hidden;
flex: 1 1 auto;
width: 1%;
text-overflow: ellipsis;
cursor: pointer;
}
.p-dropdown-label-empty {
overflow: hidden;
opacity: 0;
}
2022-09-14 11:26:01 +00:00
input.p-dropdown-label {
2022-09-06 12:03:37 +00:00
cursor: default;
}
.p-dropdown .p-dropdown-panel {
min-width: 100%;
}
.p-dropdown-panel {
position: absolute;
top: 0;
left: 0;
}
.p-dropdown-items-wrapper {
overflow: auto;
}
.p-dropdown-item {
cursor: pointer;
font-weight: normal;
white-space: nowrap;
position: relative;
overflow: hidden;
}
.p-dropdown-item-group {
cursor: auto;
}
.p-dropdown-items {
margin: 0;
padding: 0;
list-style-type: none;
}
.p-dropdown-filter {
width: 100%;
}
.p-dropdown-filter-container {
position: relative;
}
.p-dropdown-filter-icon {
position: absolute;
top: 50%;
2022-09-14 11:26:01 +00:00
margin-top: -0.5rem;
2022-09-06 12:03:37 +00:00
}
.p-fluid .p-dropdown {
display: flex;
}
.p-fluid .p-dropdown .p-dropdown-label {
width: 1%;
}
</style>