2022-09-06 12:03:37 +00:00
|
|
|
<template>
|
|
|
|
<div :id="id" :class="containerClass" @focusout="onFocusout">
|
|
|
|
<span ref="firstHiddenFocusableElement" role="presentation" aria-hidden="true" class="p-hidden-accessible p-hidden-focusable" :tabindex="!disabled ? tabindex : -1" @focus="onFirstHiddenFocus"></span>
|
|
|
|
<slot name="header" :value="modelValue" :options="visibleOptions"></slot>
|
|
|
|
<div v-if="filter" class="p-listbox-header">
|
|
|
|
<div class="p-listbox-filter-container">
|
2022-09-14 11:26:01 +00:00
|
|
|
<input
|
|
|
|
ref="filterInput"
|
|
|
|
v-model="filterValue"
|
|
|
|
type="text"
|
|
|
|
class="p-listbox-filter p-inputtext p-component"
|
|
|
|
:placeholder="filterPlaceholder"
|
|
|
|
role="searchbox"
|
|
|
|
autocomplete="off"
|
|
|
|
:aria-owns="id + '_list'"
|
|
|
|
:aria-activedescendant="focusedOptionId"
|
|
|
|
:tabindex="!disabled && !focused ? tabindex : -1"
|
|
|
|
@input="onFilterChange"
|
|
|
|
@blur="onFilterBlur"
|
|
|
|
@keydown="onFilterKeyDown"
|
|
|
|
v-bind="filterInputProps"
|
|
|
|
/>
|
2022-12-08 11:04:25 +00:00
|
|
|
<span :class="['p-listbox-filter-icon', filterIcon]" />
|
2022-09-06 12:03:37 +00:00
|
|
|
</div>
|
|
|
|
<span role="status" aria-live="polite" class="p-hidden-accessible">
|
2022-09-14 11:26:01 +00:00
|
|
|
{{ filterResultMessageText }}
|
2022-09-06 12:03:37 +00:00
|
|
|
</span>
|
|
|
|
</div>
|
|
|
|
<div ref="listWrapper" class="p-listbox-list-wrapper" :style="listStyle">
|
|
|
|
<VirtualScroller :ref="virtualScrollerRef" v-bind="virtualScrollerOptions" :style="listStyle" :items="visibleOptions" :tabindex="-1" :disabled="virtualScrollerDisabled">
|
|
|
|
<template v-slot:content="{ styleClass, contentRef, items, getItemOptions, contentStyle, itemSize }">
|
2022-09-14 11:26:01 +00:00
|
|
|
<ul
|
|
|
|
:ref="(el) => listRef(el, contentRef)"
|
|
|
|
:id="id + '_list'"
|
|
|
|
:class="['p-listbox-list', styleClass]"
|
|
|
|
:style="contentStyle"
|
|
|
|
:tabindex="-1"
|
|
|
|
role="listbox"
|
|
|
|
:aria-multiselectable="multiple"
|
|
|
|
:aria-label="ariaLabel"
|
|
|
|
:aria-labelledby="ariaLabelledby"
|
|
|
|
:aria-activedescendant="focused ? focusedOptionId : undefined"
|
|
|
|
:aria-disabled="disabled"
|
|
|
|
@focus="onListFocus"
|
|
|
|
@blur="onListBlur"
|
|
|
|
@keydown="onListKeyDown"
|
|
|
|
>
|
2022-09-06 12:03:37 +00:00
|
|
|
<template v-for="(option, i) of items" :key="getOptionRenderKey(option, getOptionIndex(i, getItemOptions))">
|
2022-09-14 11:26:01 +00:00
|
|
|
<li v-if="isOptionGroup(option)" :id="id + '_' + getOptionIndex(i, getItemOptions)" :style="{ height: itemSize ? itemSize + 'px' : undefined }" class="p-listbox-item-group" role="option">
|
|
|
|
<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-listbox-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, getOptionIndex(i, getItemOptions))"
|
2023-01-09 12:19:04 +00:00
|
|
|
@mousedown="onOptionMouseDown($event, getOptionIndex(i, getItemOptions))"
|
2022-09-14 11:26:01 +00:00
|
|
|
@mousemove="onOptionMouseMove($event, getOptionIndex(i, getItemOptions))"
|
|
|
|
@touchend="onOptionTouchEnd()"
|
|
|
|
>
|
|
|
|
<slot name="option" :option="option" :index="getOptionIndex(i, getItemOptions)">{{ getOptionLabel(option) }}</slot>
|
2022-09-06 12:03:37 +00:00
|
|
|
</li>
|
|
|
|
</template>
|
|
|
|
<li v-if="filterValue && (!items || (items && items.length === 0))" class="p-listbox-empty-message" role="option">
|
2022-09-14 11:26:01 +00:00
|
|
|
<slot name="emptyfilter">{{ emptyFilterMessageText }}</slot>
|
2022-09-06 12:03:37 +00:00
|
|
|
</li>
|
2022-09-14 11:26:01 +00:00
|
|
|
<li v-else-if="!options || (options && options.length === 0)" class="p-listbox-empty-message" role="option">
|
|
|
|
<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>
|
2022-12-08 11:04:25 +00:00
|
|
|
<span v-if="!options || (options && options.length === 0)" role="status" aria-live="polite" class="p-hidden-accessible">
|
|
|
|
{{ emptyMessageText }}
|
|
|
|
</span>
|
|
|
|
<span role="status" aria-live="polite" class="p-hidden-accessible">
|
|
|
|
{{ selectedMessageText }}
|
|
|
|
</span>
|
2022-09-06 12:03:37 +00:00
|
|
|
<span ref="lastHiddenFocusableElement" role="presentation" aria-hidden="true" class="p-hidden-accessible p-hidden-focusable" :tabindex="!disabled ? tabindex : -1" @focus="onLastHiddenFocus"></span>
|
|
|
|
</div>
|
|
|
|
</template>
|
|
|
|
|
|
|
|
<script>
|
2022-09-14 11:26:01 +00:00
|
|
|
import { FilterService } from 'primevue/api';
|
2022-09-06 12:03:37 +00:00
|
|
|
import Ripple from 'primevue/ripple';
|
2022-12-08 11:04:25 +00:00
|
|
|
import { DomHandler, ObjectUtils, UniqueComponentId } from 'primevue/utils';
|
2022-09-06 12:03:37 +00:00
|
|
|
import VirtualScroller from 'primevue/virtualscroller';
|
|
|
|
|
|
|
|
export default {
|
|
|
|
name: 'Listbox',
|
|
|
|
emits: ['update:modelValue', 'change', 'focus', 'blur', 'filter'],
|
|
|
|
props: {
|
|
|
|
modelValue: null,
|
|
|
|
options: Array,
|
|
|
|
optionLabel: null,
|
|
|
|
optionValue: null,
|
|
|
|
optionDisabled: null,
|
|
|
|
optionGroupLabel: null,
|
|
|
|
optionGroupChildren: null,
|
2022-09-14 11:26:01 +00:00
|
|
|
listStyle: null,
|
2022-09-06 12:03:37 +00:00
|
|
|
disabled: Boolean,
|
|
|
|
dataKey: null,
|
|
|
|
multiple: Boolean,
|
|
|
|
metaKeySelection: Boolean,
|
|
|
|
filter: Boolean,
|
|
|
|
filterPlaceholder: String,
|
|
|
|
filterLocale: String,
|
|
|
|
filterMatchMode: {
|
|
|
|
type: String,
|
|
|
|
default: 'contains'
|
|
|
|
},
|
|
|
|
filterFields: {
|
|
|
|
type: Array,
|
|
|
|
default: null
|
|
|
|
},
|
|
|
|
filterInputProps: null,
|
|
|
|
virtualScrollerOptions: {
|
|
|
|
type: Object,
|
|
|
|
default: null
|
|
|
|
},
|
|
|
|
autoOptionFocus: {
|
|
|
|
type: Boolean,
|
|
|
|
default: true
|
|
|
|
},
|
2022-09-14 11:26:01 +00:00
|
|
|
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
|
|
|
|
},
|
2022-12-08 11:04:25 +00:00
|
|
|
filterIcon: {
|
|
|
|
type: String,
|
|
|
|
default: 'pi pi-search'
|
|
|
|
},
|
2022-09-06 12:03:37 +00:00
|
|
|
tabindex: {
|
|
|
|
type: Number,
|
|
|
|
default: 0
|
|
|
|
},
|
|
|
|
'aria-label': {
|
|
|
|
type: String,
|
|
|
|
default: null
|
|
|
|
},
|
|
|
|
'aria-labelledby': {
|
|
|
|
type: String,
|
|
|
|
default: null
|
|
|
|
}
|
|
|
|
},
|
|
|
|
list: null,
|
|
|
|
virtualScroller: null,
|
|
|
|
optionTouched: false,
|
|
|
|
startRangeIndex: -1,
|
|
|
|
searchTimeout: null,
|
|
|
|
searchValue: '',
|
|
|
|
focusOnHover: false,
|
|
|
|
data() {
|
|
|
|
return {
|
|
|
|
filterValue: null,
|
|
|
|
focused: false,
|
|
|
|
focusedOptionIndex: -1
|
2022-09-14 11:26:01 +00:00
|
|
|
};
|
2022-09-06 12:03:37 +00:00
|
|
|
},
|
|
|
|
watch: {
|
|
|
|
options() {
|
|
|
|
this.autoUpdateModel();
|
|
|
|
}
|
|
|
|
},
|
|
|
|
mounted() {
|
|
|
|
this.autoUpdateModel();
|
|
|
|
},
|
|
|
|
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;
|
|
|
|
},
|
|
|
|
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
|
|
|
},
|
|
|
|
onFirstHiddenFocus() {
|
2022-09-14 11:26:01 +00:00
|
|
|
DomHandler.focus(this.list);
|
2022-09-06 12:03:37 +00:00
|
|
|
|
|
|
|
const firstFocusableEl = DomHandler.getFirstFocusableElement(this.$el, ':not(.p-hidden-focusable)');
|
2022-09-14 11:26:01 +00:00
|
|
|
|
2022-09-06 12:03:37 +00:00
|
|
|
this.$refs.lastHiddenFocusableElement.tabIndex = ObjectUtils.isEmpty(firstFocusableEl) ? -1 : undefined;
|
|
|
|
this.$refs.firstHiddenFocusableElement.tabIndex = -1;
|
|
|
|
},
|
|
|
|
onLastHiddenFocus(event) {
|
|
|
|
const relatedTarget = event.relatedTarget;
|
|
|
|
|
|
|
|
if (relatedTarget === this.list) {
|
|
|
|
const firstFocusableEl = DomHandler.getFirstFocusableElement(this.$el, ':not(.p-hidden-focusable)');
|
2022-09-14 11:26:01 +00:00
|
|
|
|
|
|
|
DomHandler.focus(firstFocusableEl);
|
2022-09-06 12:03:37 +00:00
|
|
|
this.$refs.firstHiddenFocusableElement.tabIndex = undefined;
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
|
|
|
DomHandler.focus(this.$refs.firstHiddenFocusableElement);
|
2022-09-06 12:03:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
this.$refs.lastHiddenFocusableElement.tabIndex = -1;
|
|
|
|
},
|
|
|
|
onFocusout(event) {
|
|
|
|
if (!this.$el.contains(event.relatedTarget) && this.$refs.lastHiddenFocusableElement && this.$refs.firstHiddenFocusableElement) {
|
|
|
|
this.$refs.lastHiddenFocusableElement.tabIndex = this.$refs.firstHiddenFocusableElement.tabIndex = undefined;
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onListFocus(event) {
|
|
|
|
this.focused = true;
|
2023-01-09 12:19:04 +00:00
|
|
|
this.focusedOptionIndex = this.focusedOptionIndex !== -1 ? this.focusedOptionIndex : this.autoOptionFocus ? this.findFirstFocusedOptionIndex() : -1;
|
2022-09-06 12:03:37 +00:00
|
|
|
this.$emit('focus', event);
|
|
|
|
},
|
|
|
|
onListBlur(event) {
|
|
|
|
this.focused = false;
|
|
|
|
this.focusedOptionIndex = this.startRangeIndex = -1;
|
|
|
|
this.searchValue = '';
|
|
|
|
this.$emit('blur', event);
|
|
|
|
},
|
|
|
|
onListKeyDown(event) {
|
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);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'Home':
|
|
|
|
this.onHomeKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'End':
|
|
|
|
this.onEndKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'PageDown':
|
|
|
|
this.onPageDownKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'PageUp':
|
|
|
|
this.onPageUpKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'Enter':
|
|
|
|
case 'Space':
|
|
|
|
this.onSpaceKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'Tab':
|
|
|
|
//NOOP
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'ShiftLeft':
|
|
|
|
case 'ShiftRight':
|
|
|
|
this.onShiftKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
2022-09-14 11:26:01 +00:00
|
|
|
if (this.multiple && event.code === 'KeyA' && metaKey) {
|
|
|
|
const value = this.visibleOptions.filter((option) => this.isValidOption(option)).map((option) => this.getOptionValue(option));
|
|
|
|
|
2022-09-06 12:03:37 +00:00
|
|
|
this.updateModel(event, value);
|
|
|
|
|
|
|
|
event.preventDefault();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2022-09-14 11:26:01 +00:00
|
|
|
if (!metaKey && ObjectUtils.isPrintableCharacter(event.key)) {
|
2022-09-06 12:03:37 +00:00
|
|
|
this.searchOptions(event, event.key);
|
|
|
|
event.preventDefault();
|
|
|
|
}
|
|
|
|
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onOptionSelect(event, option, index = -1) {
|
|
|
|
if (this.disabled || this.isOptionDisabled(option)) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
this.multiple ? this.onOptionSelectMultiple(event, option) : this.onOptionSelectSingle(event, option);
|
|
|
|
this.optionTouched = false;
|
|
|
|
index !== -1 && (this.focusedOptionIndex = index);
|
|
|
|
},
|
2023-01-09 12:19:04 +00:00
|
|
|
onOptionMouseDown(event, index) {
|
|
|
|
this.changeFocusedOptionIndex(event, index);
|
|
|
|
},
|
2022-09-06 12:03:37 +00:00
|
|
|
onOptionMouseMove(event, index) {
|
|
|
|
if (this.focusOnHover) {
|
|
|
|
this.changeFocusedOptionIndex(event, index);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onOptionTouchEnd() {
|
|
|
|
if (this.disabled) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
this.optionTouched = true;
|
|
|
|
},
|
|
|
|
onOptionSelectSingle(event, option) {
|
|
|
|
let selected = this.isSelected(option);
|
|
|
|
let valueChanged = false;
|
|
|
|
let value = null;
|
|
|
|
let metaSelection = this.optionTouched ? false : this.metaKeySelection;
|
|
|
|
|
|
|
|
if (metaSelection) {
|
2022-09-14 11:26:01 +00:00
|
|
|
let metaKey = event.metaKey || event.ctrlKey;
|
2022-09-06 12:03:37 +00:00
|
|
|
|
|
|
|
if (selected) {
|
|
|
|
if (metaKey) {
|
|
|
|
value = null;
|
|
|
|
valueChanged = true;
|
|
|
|
}
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
2022-09-06 12:03:37 +00:00
|
|
|
value = this.getOptionValue(option);
|
|
|
|
valueChanged = true;
|
|
|
|
}
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
2022-09-06 12:03:37 +00:00
|
|
|
value = selected ? null : this.getOptionValue(option);
|
|
|
|
valueChanged = true;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (valueChanged) {
|
|
|
|
this.updateModel(event, value);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onOptionSelectMultiple(event, option) {
|
|
|
|
let selected = this.isSelected(option);
|
|
|
|
let value = null;
|
|
|
|
let metaSelection = this.optionTouched ? false : this.metaKeySelection;
|
|
|
|
|
|
|
|
if (metaSelection) {
|
2022-09-14 11:26:01 +00:00
|
|
|
let metaKey = event.metaKey || event.ctrlKey;
|
2022-09-06 12:03:37 +00:00
|
|
|
|
|
|
|
if (selected) {
|
|
|
|
value = metaKey ? this.removeOption(option) : [this.getOptionValue(option)];
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
|
|
|
value = metaKey ? this.modelValue || [] : [];
|
2022-09-06 12:03:37 +00:00
|
|
|
value = [...value, this.getOptionValue(option)];
|
|
|
|
}
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
|
|
|
value = selected ? this.removeOption(option) : [...(this.modelValue || []), this.getOptionValue(option)];
|
2022-09-06 12:03:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
this.updateModel(event, value);
|
|
|
|
},
|
|
|
|
onOptionSelectRange(event, start = -1, end = -1) {
|
|
|
|
start === -1 && (start = this.findNearestSelectedOptionIndex(end, true));
|
|
|
|
end === -1 && (end = this.findNearestSelectedOptionIndex(start));
|
|
|
|
|
|
|
|
if (start !== -1 && end !== -1) {
|
|
|
|
const rangeStart = Math.min(start, end);
|
|
|
|
const rangeEnd = Math.max(start, end);
|
2022-09-14 11:26:01 +00:00
|
|
|
const value = this.visibleOptions
|
|
|
|
.slice(rangeStart, rangeEnd + 1)
|
|
|
|
.filter((option) => this.isValidOption(option))
|
|
|
|
.map((option) => this.getOptionValue(option));
|
2022-09-06 12:03:37 +00:00
|
|
|
|
|
|
|
this.updateModel(event, value);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onFilterChange(event) {
|
2022-09-14 11:26:01 +00:00
|
|
|
this.$emit('filter', { originalEvent: event, value: event.target.value });
|
2022-09-06 12:03:37 +00:00
|
|
|
this.focusedOptionIndex = this.startRangeIndex = -1;
|
|
|
|
},
|
|
|
|
onFilterBlur() {
|
|
|
|
this.focusedOptionIndex = this.startRangeIndex = -1;
|
|
|
|
},
|
|
|
|
onFilterKeyDown(event) {
|
|
|
|
switch (event.code) {
|
|
|
|
case 'ArrowDown':
|
|
|
|
this.onArrowDownKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case 'ArrowUp':
|
|
|
|
this.onArrowUpKey(event);
|
|
|
|
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 'ShiftLeft':
|
|
|
|
case 'ShiftRight':
|
|
|
|
this.onShiftKey(event);
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
},
|
|
|
|
onArrowDownKey(event) {
|
|
|
|
const optionIndex = this.focusedOptionIndex !== -1 ? this.findNextOptionIndex(this.focusedOptionIndex) : this.findFirstFocusedOptionIndex();
|
|
|
|
|
|
|
|
if (this.multiple && event.shiftKey) {
|
|
|
|
this.onOptionSelectRange(event, this.startRangeIndex, optionIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.changeFocusedOptionIndex(event, optionIndex);
|
|
|
|
event.preventDefault();
|
|
|
|
},
|
|
|
|
onArrowUpKey(event) {
|
|
|
|
const optionIndex = this.focusedOptionIndex !== -1 ? this.findPrevOptionIndex(this.focusedOptionIndex) : this.findLastFocusedOptionIndex();
|
|
|
|
|
|
|
|
if (this.multiple && event.shiftKey) {
|
|
|
|
this.onOptionSelectRange(event, optionIndex, this.startRangeIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.changeFocusedOptionIndex(event, optionIndex);
|
|
|
|
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
|
|
|
let metaKey = event.metaKey || event.ctrlKey;
|
|
|
|
let optionIndex = this.findFirstOptionIndex();
|
|
|
|
|
|
|
|
if (this.multiple && event.shiftKey && metaKey) {
|
|
|
|
this.onOptionSelectRange(event, optionIndex, this.startRangeIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.changeFocusedOptionIndex(event, optionIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
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
|
|
|
let metaKey = event.metaKey || event.ctrlKey;
|
|
|
|
let optionIndex = this.findLastOptionIndex();
|
|
|
|
|
|
|
|
if (this.multiple && event.shiftKey && metaKey) {
|
|
|
|
this.onOptionSelectRange(event, this.startRangeIndex, optionIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
this.changeFocusedOptionIndex(event, optionIndex);
|
|
|
|
}
|
|
|
|
|
|
|
|
event.preventDefault();
|
|
|
|
},
|
|
|
|
onPageUpKey(event) {
|
|
|
|
this.scrollInView(0);
|
|
|
|
event.preventDefault();
|
|
|
|
},
|
|
|
|
onPageDownKey(event) {
|
|
|
|
this.scrollInView(this.visibleOptions.length - 1);
|
|
|
|
event.preventDefault();
|
|
|
|
},
|
|
|
|
onEnterKey(event) {
|
|
|
|
if (this.focusedOptionIndex !== -1) {
|
2022-09-14 11:26:01 +00:00
|
|
|
if (this.multiple && event.shiftKey) this.onOptionSelectRange(event, this.focusedOptionIndex);
|
|
|
|
else this.onOptionSelect(event, this.visibleOptions[this.focusedOptionIndex]);
|
2022-09-06 12:03:37 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
event.preventDefault();
|
|
|
|
},
|
|
|
|
onSpaceKey(event) {
|
|
|
|
this.onEnterKey(event);
|
|
|
|
},
|
|
|
|
onShiftKey() {
|
|
|
|
this.startRangeIndex = this.focusedOptionIndex;
|
|
|
|
},
|
|
|
|
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) {
|
|
|
|
const optionValue = this.getOptionValue(option);
|
|
|
|
|
2022-09-14 11:26:01 +00:00
|
|
|
if (this.multiple) return (this.modelValue || []).some((value) => ObjectUtils.equals(value, optionValue, this.equalityKey));
|
|
|
|
else return ObjectUtils.equals(this.modelValue, optionValue, 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;
|
|
|
|
},
|
|
|
|
findFirstSelectedOptionIndex() {
|
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
|
|
|
},
|
|
|
|
findLastSelectedOptionIndex() {
|
2022-09-14 11:26:01 +00:00
|
|
|
return this.hasSelectedOption ? ObjectUtils.findLastIndex(this.visibleOptions, (option) => this.isValidSelectedOption(option)) : -1;
|
2022-09-06 12:03:37 +00:00
|
|
|
},
|
|
|
|
findNextSelectedOptionIndex(index) {
|
2022-09-14 11:26:01 +00:00
|
|
|
const matchedOptionIndex = this.hasSelectedOption && index < this.visibleOptions.length - 1 ? this.visibleOptions.slice(index + 1).findIndex((option) => this.isValidSelectedOption(option)) : -1;
|
|
|
|
|
2022-09-06 12:03:37 +00:00
|
|
|
return matchedOptionIndex > -1 ? matchedOptionIndex + index + 1 : -1;
|
|
|
|
},
|
|
|
|
findPrevSelectedOptionIndex(index) {
|
2022-09-14 11:26:01 +00:00
|
|
|
const matchedOptionIndex = this.hasSelectedOption && index > 0 ? ObjectUtils.findLastIndex(this.visibleOptions.slice(0, index), (option) => this.isValidSelectedOption(option)) : -1;
|
|
|
|
|
2022-09-06 12:03:37 +00:00
|
|
|
return matchedOptionIndex > -1 ? matchedOptionIndex : -1;
|
|
|
|
},
|
|
|
|
findNearestSelectedOptionIndex(index, firstCheckUp = false) {
|
|
|
|
let matchedOptionIndex = -1;
|
|
|
|
|
|
|
|
if (this.hasSelectedOption) {
|
|
|
|
if (firstCheckUp) {
|
|
|
|
matchedOptionIndex = this.findPrevSelectedOptionIndex(index);
|
|
|
|
matchedOptionIndex = matchedOptionIndex === -1 ? this.findNextSelectedOptionIndex(index) : matchedOptionIndex;
|
2022-09-14 11:26:01 +00:00
|
|
|
} else {
|
2022-09-06 12:03:37 +00:00
|
|
|
matchedOptionIndex = this.findNextSelectedOptionIndex(index);
|
|
|
|
matchedOptionIndex = matchedOptionIndex === -1 ? this.findPrevSelectedOptionIndex(index) : matchedOptionIndex;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return matchedOptionIndex > -1 ? matchedOptionIndex : index;
|
|
|
|
},
|
|
|
|
findFirstFocusedOptionIndex() {
|
|
|
|
const selectedIndex = this.findFirstSelectedOptionIndex();
|
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.findLastSelectedOptionIndex();
|
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;
|
2022-09-14 11:26:01 +00:00
|
|
|
|
2022-09-06 12:03:37 +00:00
|
|
|
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 && 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);
|
|
|
|
},
|
|
|
|
removeOption(option) {
|
2022-09-14 11:26:01 +00:00
|
|
|
return this.modelValue.filter((val) => !ObjectUtils.equals(val, this.getOptionValue(option), this.equalityKey));
|
2022-09-06 12:03:37 +00:00
|
|
|
},
|
|
|
|
changeFocusedOptionIndex(event, index) {
|
|
|
|
if (this.focusedOptionIndex !== index) {
|
|
|
|
this.focusedOptionIndex = index;
|
|
|
|
this.scrollInView();
|
|
|
|
|
|
|
|
if (this.selectOnFocus && !this.multiple) {
|
2022-09-14 11:26:01 +00:00
|
|
|
this.onOptionSelect(event, this.visibleOptions[index]);
|
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: 'nearest' });
|
2022-09-14 11:26:01 +00:00
|
|
|
} else if (!this.virtualScrollerDisabled) {
|
2022-09-06 12:03:37 +00:00
|
|
|
this.virtualScroller && this.virtualScroller.scrollToIndex(index !== -1 ? index : this.focusedOptionIndex);
|
|
|
|
}
|
|
|
|
},
|
|
|
|
autoUpdateModel() {
|
2022-09-14 11:26:01 +00:00
|
|
|
if (this.selectOnFocus && this.autoOptionFocus && !this.hasSelectedOption && !this.multiple) {
|
2022-09-06 12:03:37 +00:00
|
|
|
this.focusedOptionIndex = this.findFirstFocusedOptionIndex();
|
2022-09-14 11:26:01 +00:00
|
|
|
this.onOptionSelect(null, this.visibleOptions[this.focusedOptionIndex]);
|
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;
|
|
|
|
}, []);
|
|
|
|
},
|
|
|
|
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-listbox p-component',
|
|
|
|
{
|
|
|
|
'p-focus': this.focused,
|
|
|
|
'p-disabled': this.disabled
|
|
|
|
}
|
|
|
|
];
|
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
|
|
|
|
|
|
|
return this.filterValue ? FilterService.filter(options, this.searchFields, this.filterValue, this.filterMatchMode, this.filterLocale) : options;
|
|
|
|
},
|
|
|
|
hasSelectedOption() {
|
|
|
|
return ObjectUtils.isNotEmpty(this.modelValue);
|
|
|
|
},
|
|
|
|
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}', this.multiple ? this.modelValue.length : '1') : this.emptySelectionMessageText;
|
|
|
|
},
|
2022-09-14 11:26:01 +00:00
|
|
|
id() {
|
|
|
|
return this.$attrs.id || UniqueComponentId();
|
|
|
|
},
|
2022-09-06 12:03:37 +00:00
|
|
|
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
|
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-listbox-list-wrapper {
|
|
|
|
overflow: auto;
|
|
|
|
}
|
|
|
|
|
|
|
|
.p-listbox-list {
|
|
|
|
list-style-type: none;
|
|
|
|
margin: 0;
|
|
|
|
padding: 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
.p-listbox-item {
|
|
|
|
cursor: pointer;
|
|
|
|
position: relative;
|
|
|
|
overflow: hidden;
|
|
|
|
}
|
|
|
|
|
|
|
|
.p-listbox-item-group {
|
|
|
|
cursor: auto;
|
|
|
|
}
|
|
|
|
|
|
|
|
.p-listbox-filter-container {
|
|
|
|
position: relative;
|
|
|
|
}
|
|
|
|
|
|
|
|
.p-listbox-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-listbox-filter {
|
|
|
|
width: 100%;
|
|
|
|
}
|
|
|
|
</style>
|