primevue-mirror/components/lib/treeselect/TreeSelect.vue

604 lines
19 KiB
Vue
Raw Normal View History

2022-09-06 12:03:37 +00:00
<template>
<div ref="container" :class="containerClass" @click="onClick">
<div class="p-hidden-accessible">
2022-09-14 11:26:01 +00:00
<input
ref="focusInput"
:id="inputId"
type="text"
role="combobox"
:class="inputClass"
:style="inputStyle"
readonly
:disabled="disabled"
:tabindex="!disabled ? tabindex : -1"
:aria-labelledby="ariaLabelledby"
:aria-label="ariaLabel"
aria-haspopup="tree"
:aria-expanded="overlayVisible"
:aria-controls="listId"
@focus="onFocus($event)"
@blur="onBlur($event)"
@keydown="onKeyDown($event)"
v-bind="inputProps"
/>
2022-09-06 12:03:37 +00:00
</div>
<div class="p-treeselect-label-container">
<div :class="labelClass">
<slot name="value" :value="selectedNodes" :placeholder="placeholder">
<template v-if="display === 'comma'">
2022-09-14 11:26:01 +00:00
{{ label || 'empty' }}
2022-09-06 12:03:37 +00:00
</template>
<template v-else-if="display === 'chip'">
2022-09-14 11:26:01 +00:00
<div v-for="node of selectedNodes" :key="node.key" class="p-treeselect-token">
<span class="p-treeselect-token-label">{{ node.label }}</span>
2022-09-06 12:03:37 +00:00
</div>
2022-09-14 11:26:01 +00:00
<template v-if="emptyValue">{{ placeholder || 'empty' }}</template>
2022-09-06 12:03:37 +00:00
</template>
</slot>
</div>
</div>
<div class="p-treeselect-trigger" role="button" aria-haspopup="tree" :aria-expanded="overlayVisible">
<slot name="indicator">
2023-04-04 12:43:10 +00:00
<component :is="'ChevronDownIcon'" class="p-treeselect-trigger-icon" />
2022-09-06 12:03:37 +00:00
</slot>
</div>
<Portal :appendTo="appendTo">
<transition name="p-connected-overlay" @enter="onOverlayEnter" @leave="onOverlayLeave" @after-leave="onOverlayAfterLeave">
2023-04-04 12:43:10 +00:00
<div v-if="overlayVisible" :ref="overlayRef" @click="onOverlayClick" :class="panelStyleClass" @keydown="onOverlayKeydown" v-bind="panelProps">
2022-09-06 12:03:37 +00:00
<slot name="header" :value="modelValue" :options="options"></slot>
2022-09-14 11:26:01 +00:00
<div class="p-treeselect-items-wrapper" :style="{ 'max-height': scrollHeight }">
<TSTree
2022-12-08 11:04:25 +00:00
ref="tree"
2022-09-14 11:26:01 +00:00
:id="listId"
:value="options"
:selectionMode="selectionMode"
@update:selectionKeys="onSelectionChange"
:selectionKeys="modelValue"
:expandedKeys="expandedKeys"
@update:expandedKeys="onNodeToggle"
:metaKeySelection="metaKeySelection"
@node-expand="$emit('node-expand', $event)"
@node-collapse="$emit('node-collapse', $event)"
@node-select="onNodeSelect"
@node-unselect="onNodeUnselect"
:level="0"
>
<template v-if="$slots.itemtogglericon" #togglericon="iconProps">
<slot name="itemtogglericon" :node="iconProps.node" :expanded="iconProps.expanded" :class="iconProps.class" />
</template>
<template v-if="$slots.itemcheckboxicon" #checkboxicon="iconProps">
<slot name="itemcheckboxicon" :checked="iconProps.checked" :partialChecked="iconProps.partialChecked" :class="iconProps.class" />
</template>
<template v-if="$slots.loadingicon" #loadingicon>
<slot name="loadingicon" />
</template>
<template v-if="$slots.searchicon" #searchicon>
<slot name="searchicon" />
</template>
</TSTree>
2022-09-06 12:03:37 +00:00
<div v-if="emptyOptions" class="p-treeselect-empty-message">
2022-09-14 11:26:01 +00:00
<slot name="empty">{{ emptyMessageText }}</slot>
2022-09-06 12:03:37 +00:00
</div>
</div>
<slot name="footer" :value="modelValue" :options="options"></slot>
</div>
</transition>
</Portal>
</div>
</template>
<script>
2023-04-04 12:43:10 +00:00
import ChevronDownIcon from 'primevue/icon/chevrondown';
2022-09-06 12:03:37 +00:00
import OverlayEventBus from 'primevue/overlayeventbus';
import Portal from 'primevue/portal';
2022-12-08 11:04:25 +00:00
import Ripple from 'primevue/ripple';
import Tree from 'primevue/tree';
import { ConnectedOverlayScrollHandler, DomHandler, UniqueComponentId, ZIndexUtils } from 'primevue/utils';
2022-09-06 12:03:37 +00:00
export default {
name: 'TreeSelect',
emits: ['update:modelValue', 'before-show', 'before-hide', 'change', 'show', 'hide', 'node-select', 'node-unselect', 'node-expand', 'node-collapse', 'focus', 'blur'],
props: {
modelValue: null,
options: Array,
2022-09-14 11:26:01 +00:00
scrollHeight: {
2022-09-06 12:03:37 +00:00
type: String,
2022-09-14 11:26:01 +00:00
default: '400px'
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
placeholder: {
2022-09-06 12:03:37 +00:00
type: String,
default: null
},
2022-09-14 11:26:01 +00:00
disabled: {
type: Boolean,
default: false
},
tabindex: {
type: Number,
default: null
},
selectionMode: {
type: String,
default: 'single'
},
2022-09-06 12:03:37 +00:00
appendTo: {
type: String,
default: 'body'
},
emptyMessage: {
type: String,
default: null
},
display: {
type: String,
default: 'comma'
},
metaKeySelection: {
type: Boolean,
default: true
},
2022-09-14 11:26:01 +00:00
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
},
panelProps: {
type: null,
default: null
},
2022-09-06 12:03:37 +00:00
'aria-labelledby': {
type: String,
2022-09-14 11:26:01 +00:00
default: null
2022-09-06 12:03:37 +00:00
},
'aria-label': {
type: String,
default: null
}
},
2022-09-14 11:26:01 +00:00
data() {
return {
focused: false,
overlayVisible: false,
expandedKeys: {}
};
},
2022-09-06 12:03:37 +00:00
watch: {
modelValue: {
2022-09-14 11:26:01 +00:00
handler: function () {
2022-09-06 12:03:37 +00:00
if (!this.selfChange) {
this.updateTreeState();
}
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
this.selfChange = false;
},
immediate: true
},
options() {
this.updateTreeState();
}
},
outsideClickListener: null,
resizeListener: null,
scrollHandler: null,
overlay: null,
selfChange: false,
selfClick: false,
2022-09-06 12:03:37 +00:00
beforeUnmount() {
this.unbindOutsideClickListener();
this.unbindResizeListener();
if (this.scrollHandler) {
this.scrollHandler.destroy();
this.scrollHandler = null;
}
if (this.overlay) {
ZIndexUtils.clear(this.overlay);
this.overlay = null;
}
},
mounted() {
this.updateTreeState();
},
methods: {
show() {
this.$emit('before-show');
this.overlayVisible = true;
},
hide() {
this.$emit('before-hide');
this.overlayVisible = false;
this.$refs.focusInput.focus();
},
onFocus(event) {
this.focused = true;
this.$emit('focus', event);
},
onBlur(event) {
this.focused = false;
this.$emit('blur', event);
},
onClick(event) {
if (!this.disabled && (!this.overlay || !this.overlay.contains(event.target)) && !DomHandler.hasClass(event.target, 'p-treeselect-close')) {
2022-09-14 11:26:01 +00:00
if (this.overlayVisible) this.hide();
else this.show();
2022-09-06 12:03:37 +00:00
this.$refs.focusInput.focus();
}
},
onSelectionChange(keys) {
this.selfChange = true;
this.$emit('update:modelValue', keys);
this.$emit('change', keys);
},
onNodeSelect(node) {
this.$emit('node-select', node);
if (this.selectionMode === 'single') {
this.hide();
}
},
onNodeUnselect(node) {
this.$emit('node-unselect', node);
},
onNodeToggle(keys) {
this.expandedKeys = keys;
},
onKeyDown(event) {
2022-09-14 11:26:01 +00:00
switch (event.code) {
2022-09-06 12:03:37 +00:00
case 'ArrowDown':
2022-12-08 11:04:25 +00:00
this.onArrowDownKey(event);
2022-09-14 11:26:01 +00:00
break;
2022-09-06 12:03:37 +00:00
case 'Space':
case 'Enter':
2022-12-08 11:04:25 +00:00
this.onEnterKey(event);
2022-09-14 11:26:01 +00:00
break;
2022-09-06 12:03:37 +00:00
case 'Escape':
2022-12-08 11:04:25 +00:00
this.onEscapeKey(event);
2022-09-14 11:26:01 +00:00
break;
2022-09-06 12:03:37 +00:00
default:
2022-09-14 11:26:01 +00:00
break;
2022-09-06 12:03:37 +00:00
}
},
2022-12-08 11:04:25 +00:00
onArrowDownKey(event) {
if (this.overlayVisible) return;
this.show();
this.$nextTick(() => {
const treeNodeEl = DomHandler.find(this.$refs.tree.$el, '.p-treenode');
const focusedElement = [...treeNodeEl].find((item) => item.getAttribute('tabindex') === '0');
DomHandler.focus(focusedElement);
});
event.preventDefault();
},
onEnterKey(event) {
if (this.overlayVisible) {
this.hide();
} else {
this.onArrowDownKey(event);
}
event.preventDefault();
},
onEscapeKey(event) {
if (this.overlayVisible) {
this.hide();
event.preventDefault();
}
},
2022-09-06 12:03:37 +00:00
onOverlayEnter(el) {
ZIndexUtils.set('overlay', el, this.$primevue.config.zIndex.overlay);
this.alignOverlay();
this.bindOutsideClickListener();
this.bindScrollListener();
this.bindResizeListener();
this.scrollValueInView();
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.selfClick && this.isOutsideClicked(event)) {
2022-09-06 12:03:37 +00:00
this.hide();
}
2023-04-17 12:19:26 +00:00
this.selfClick = false;
2022-09-06 12:03:37 +00:00
};
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;
}
},
isOutsideClicked(event) {
return !(this.$el.isSameNode(event.target) || this.$el.contains(event.target) || (this.overlay && this.overlay.contains(event.target)));
},
overlayRef(el) {
this.overlay = el;
},
onOverlayClick(event) {
OverlayEventBus.emit('overlay-click', {
originalEvent: event,
target: this.$el
});
this.selfClick = true;
2022-09-06 12:03:37 +00:00
},
2022-12-08 11:04:25 +00:00
onOverlayKeydown(event) {
if (event.code === 'Escape') this.hide();
},
2022-09-06 12:03:37 +00:00
findSelectedNodes(node, keys, selectedNodes) {
if (node) {
if (this.isSelected(node, keys)) {
selectedNodes.push(node);
delete keys[node.key];
}
if (Object.keys(keys).length && node.children) {
for (let childNode of node.children) {
this.findSelectedNodes(childNode, keys, selectedNodes);
}
}
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
for (let childNode of this.options) {
this.findSelectedNodes(childNode, keys, selectedNodes);
}
}
},
isSelected(node, keys) {
return this.selectionMode === 'checkbox' ? keys[node.key] && keys[node.key].checked : keys[node.key];
},
updateTreeState() {
2022-09-14 11:26:01 +00:00
let keys = { ...this.modelValue };
2022-09-06 12:03:37 +00:00
this.expandedKeys = {};
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
if (keys && this.options) {
this.updateTreeBranchState(null, null, keys);
}
},
updateTreeBranchState(node, path, keys) {
if (node) {
if (this.isSelected(node, keys)) {
this.expandPath(path);
delete keys[node.key];
}
if (Object.keys(keys).length && node.children) {
for (let childNode of node.children) {
path.push(node.key);
this.updateTreeBranchState(childNode, path, keys);
}
}
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
for (let childNode of this.options) {
this.updateTreeBranchState(childNode, [], keys);
}
}
},
expandPath(path) {
if (path.length > 0) {
for (let key of path) {
this.expandedKeys[key] = true;
}
}
},
scrollValueInView() {
if (this.overlay) {
let selectedItem = DomHandler.findSingle(this.overlay, 'li.p-highlight');
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
if (selectedItem) {
selectedItem.scrollIntoView({ block: 'nearest', inline: 'start' });
}
}
}
},
computed: {
containerClass() {
return [
'p-treeselect p-component p-inputwrapper',
{
'p-treeselect-chip': this.display === 'chip',
'p-disabled': this.disabled,
'p-focus': this.focused,
'p-inputwrapper-filled': !this.emptyValue,
'p-inputwrapper-focus': this.focused || this.overlayVisible
}
];
},
labelClass() {
return [
'p-treeselect-label',
{
'p-placeholder': this.label === this.placeholder,
'p-treeselect-label-empty': !this.placeholder && this.emptyValue
}
];
},
panelStyleClass() {
2022-09-14 11:26:01 +00:00
return [
'p-treeselect-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
},
selectedNodes() {
let selectedNodes = [];
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
if (this.modelValue && this.options) {
2022-09-14 11:26:01 +00:00
let keys = { ...this.modelValue };
2022-09-06 12:03:37 +00:00
this.findSelectedNodes(null, keys, selectedNodes);
}
return selectedNodes;
},
label() {
let value = this.selectedNodes;
2022-09-14 11:26:01 +00:00
return value.length ? value.map((node) => node.label).join(', ') : this.placeholder;
2022-09-06 12:03:37 +00:00
},
emptyMessageText() {
return this.emptyMessage || this.$primevue.config.locale.emptyMessage;
},
emptyValue() {
return !this.modelValue || Object.keys(this.modelValue).length === 0;
},
emptyOptions() {
return !this.options || this.options.length === 0;
},
listId() {
return UniqueComponentId() + '_list';
}
},
components: {
2022-09-14 11:26:01 +00:00
TSTree: Tree,
2023-04-04 12:43:10 +00:00
Portal: Portal,
ChevronDownIcon: ChevronDownIcon
2022-09-06 12:03:37 +00:00
},
directives: {
2022-09-14 11:26:01 +00:00
ripple: Ripple
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-treeselect {
display: inline-flex;
cursor: pointer;
position: relative;
user-select: none;
}
.p-treeselect-trigger {
display: flex;
align-items: center;
justify-content: center;
flex-shrink: 0;
}
.p-treeselect-label-container {
overflow: hidden;
flex: 1 1 auto;
cursor: pointer;
}
2022-09-14 11:26:01 +00:00
.p-treeselect-label {
2022-09-06 12:03:37 +00:00
display: block;
white-space: nowrap;
cursor: pointer;
overflow: hidden;
text-overflow: ellipsis;
}
.p-treeselect-label-empty {
overflow: hidden;
visibility: hidden;
}
.p-treeselect-token {
cursor: default;
display: inline-flex;
align-items: center;
flex: 0 0 auto;
}
.p-treeselect .p-treeselect-panel {
min-width: 100%;
}
.p-treeselect-panel {
position: absolute;
top: 0;
left: 0;
}
.p-treeselect-items-wrapper {
overflow: auto;
}
.p-fluid .p-treeselect {
display: flex;
}
</style>