primevue-mirror/components/fileupload/FileUpload.vue

550 lines
18 KiB
Vue
Raw Normal View History

2022-09-06 12:03:37 +00:00
<template>
2022-09-14 11:26:01 +00:00
<div v-if="isAdvanced" class="p-fileupload p-fileupload-advanced p-component">
2022-12-08 11:04:25 +00:00
<input ref="fileInput" type="file" @change="onFileSelect" :multiple="multiple" :accept="accept" :disabled="chooseDisabled" />
2022-09-06 12:03:37 +00:00
<div class="p-fileupload-buttonbar">
2022-12-08 11:04:25 +00:00
<slot name="header" :files="files" :uploadedFiles="uploadedFiles" :chooseCallback="choose" :uploadCallback="upload" :clearCallback="clear">
<span v-ripple :class="advancedChooseButtonClass" :style="style" @click="choose" @keydown.enter="choose" @focus="onFocus" @blur="onBlur" tabindex="0">
<span :class="advancedChooseIconClass"></span>
<span class="p-button-label">{{ chooseButtonLabel }}</span>
</span>
<FileUploadButton v-if="showUploadButton" :label="uploadButtonLabel" :icon="uploadIcon" @click="upload" :disabled="uploadDisabled" />
<FileUploadButton v-if="showCancelButton" :label="cancelButtonLabel" :icon="cancelIcon" @click="clear" :disabled="cancelDisabled" />
</slot>
2022-09-06 12:03:37 +00:00
</div>
<div ref="content" class="p-fileupload-content" @dragenter="onDragEnter" @dragover="onDragOver" @dragleave="onDragLeave" @drop="onDrop">
2022-12-08 11:04:25 +00:00
<slot name="content" :files="files" :uploadedFiles="uploadedFiles" :removeUploadedFileCallback="removeUploadedFile" :removeFileCallback="remove" :progress="progress" :messages="messages">
<FileUploadProgressBar v-if="hasFiles" :value="progress" :showValue="false" />
<FileUploadMessage v-for="msg of messages" :key="msg" severity="error" @close="onMessageClose">{{ msg }}</FileUploadMessage>
<FileContent v-if="hasFiles" :files="files" @remove="remove" :badgeValue="pendingLabel" :previewWidth="previewWidth" />
<FileContent :files="uploadedFiles" @remove="removeUploadedFile" :badgeValue="completedLabel" badgeSeverity="success" :previewWidth="previewWidth" />
</slot>
<div v-if="$slots.empty && !hasFiles && !hasUploadedFiles" class="p-fileupload-empty">
2022-09-06 12:03:37 +00:00
<slot name="empty"></slot>
</div>
</div>
</div>
2022-09-14 11:26:01 +00:00
<div v-else-if="isBasic" class="p-fileupload p-fileupload-basic p-component">
<FileUploadMessage v-for="msg of messages" :key="msg" severity="error" @close="onMessageClose">{{ msg }}</FileUploadMessage>
<span v-ripple :class="basicChooseButtonClass" :style="style" @mouseup="onBasicUploaderClick" @keydown.enter="choose" @focus="onFocus" @blur="onBlur" tabindex="0">
2022-09-06 12:03:37 +00:00
<span :class="basicChooseButtonIconClass"></span>
2022-09-14 11:26:01 +00:00
<span class="p-button-label">{{ basicChooseButtonLabel }}</span>
<input v-if="!hasFiles" ref="fileInput" type="file" :accept="accept" :disabled="disabled" :multiple="multiple" @change="onFileSelect" @focus="onFocus" @blur="onBlur" />
2022-09-06 12:03:37 +00:00
</span>
</div>
</template>
<script>
import Button from 'primevue/button';
import Message from 'primevue/message';
2022-12-08 11:04:25 +00:00
import ProgressBar from 'primevue/progressbar';
2022-09-06 12:03:37 +00:00
import Ripple from 'primevue/ripple';
2022-12-08 11:04:25 +00:00
import { DomHandler } from 'primevue/utils';
import FileContent from './FileContent.vue';
2022-09-06 12:03:37 +00:00
export default {
name: 'FileUpload',
2022-12-08 11:04:25 +00:00
emits: ['select', 'uploader', 'before-upload', 'progress', 'upload', 'error', 'before-send', 'clear', 'remove', 'remove-uploaded-file'],
2022-09-06 12:03:37 +00:00
props: {
name: {
type: String,
default: null
},
url: {
type: String,
default: null
},
mode: {
type: String,
default: 'advanced'
},
2022-09-14 11:26:01 +00:00
multiple: {
type: Boolean,
default: false
},
2022-09-06 12:03:37 +00:00
accept: {
type: String,
default: null
},
disabled: {
type: Boolean,
default: false
},
auto: {
type: Boolean,
default: false
},
maxFileSize: {
type: Number,
default: null
},
invalidFileSizeMessage: {
type: String,
default: '{0}: Invalid file size, file size should be smaller than {1}.'
},
invalidFileTypeMessage: {
type: String,
default: '{0}: Invalid file type, allowed file types: {1}.'
},
fileLimit: {
type: Number,
default: null
},
invalidFileLimitMessage: {
type: String,
default: 'Maximum number of files exceeded, limit is {0} at most.'
},
withCredentials: {
type: Boolean,
default: false
},
previewWidth: {
type: Number,
default: 50
},
chooseLabel: {
type: String,
default: null
},
uploadLabel: {
type: String,
default: null
},
cancelLabel: {
type: String,
default: null
},
customUpload: {
type: Boolean,
default: false
},
showUploadButton: {
type: Boolean,
default: true
},
showCancelButton: {
type: Boolean,
default: true
},
chooseIcon: {
type: String,
default: 'pi pi-plus'
},
uploadIcon: {
type: String,
default: 'pi pi-upload'
},
cancelIcon: {
type: String,
default: 'pi pi-times'
},
style: null,
class: null
},
duplicateIEEvent: false,
data() {
return {
uploadedFileCount: 0,
files: [],
messages: [],
focused: false,
2022-12-08 11:04:25 +00:00
progress: null,
uploadedFiles: []
2022-09-14 11:26:01 +00:00
};
2022-09-06 12:03:37 +00:00
},
methods: {
onFileSelect(event) {
if (event.type !== 'drop' && this.isIE11() && this.duplicateIEEvent) {
this.duplicateIEEvent = false;
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
return;
}
this.messages = [];
this.files = this.files || [];
let files = event.dataTransfer ? event.dataTransfer.files : event.target.files;
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
for (let file of files) {
if (!this.isFileSelected(file)) {
if (this.validate(file)) {
if (this.isImage(file)) {
file.objectURL = window.URL.createObjectURL(file);
}
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
this.files.push(file);
}
}
}
2022-09-14 11:26:01 +00:00
this.$emit('select', { originalEvent: event, files: this.files });
2022-09-06 12:03:37 +00:00
if (this.fileLimit) {
this.checkFileLimit();
}
if (this.auto && this.hasFiles && !this.isFileLimitExceeded()) {
this.upload();
}
if (event.type !== 'drop' && this.isIE11()) {
this.clearIEInput();
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
this.clearInputElement();
}
},
choose() {
this.$refs.fileInput.click();
},
upload() {
if (this.customUpload) {
if (this.fileLimit) {
this.uploadedFileCount += this.files.length;
}
2022-09-14 11:26:01 +00:00
this.$emit('uploader', { files: this.files });
this.clear();
} else {
2022-09-06 12:03:37 +00:00
let xhr = new XMLHttpRequest();
let formData = new FormData();
this.$emit('before-upload', {
2022-09-14 11:26:01 +00:00
xhr: xhr,
formData: formData
2022-09-06 12:03:37 +00:00
});
for (let file of this.files) {
formData.append(this.name, file, file.name);
}
xhr.upload.addEventListener('progress', (event) => {
if (event.lengthComputable) {
this.progress = Math.round((event.loaded * 100) / event.total);
}
this.$emit('progress', {
originalEvent: event,
progress: this.progress
});
});
xhr.onreadystatechange = () => {
if (xhr.readyState === 4) {
this.progress = 0;
if (xhr.status >= 200 && xhr.status < 300) {
if (this.fileLimit) {
this.uploadedFileCount += this.files.length;
}
this.$emit('upload', {
xhr: xhr,
files: this.files
});
2022-09-14 11:26:01 +00:00
} else {
2022-09-06 12:03:37 +00:00
this.$emit('error', {
xhr: xhr,
files: this.files
});
}
2022-12-08 11:04:25 +00:00
this.uploadedFiles.push(...this.files);
2022-09-06 12:03:37 +00:00
this.clear();
}
};
xhr.open('POST', this.url, true);
this.$emit('before-send', {
2022-09-14 11:26:01 +00:00
xhr: xhr,
formData: formData
2022-09-06 12:03:37 +00:00
});
xhr.withCredentials = this.withCredentials;
xhr.send(formData);
}
},
clear() {
this.files = [];
this.messages = null;
this.$emit('clear');
if (this.isAdvanced) {
this.clearInputElement();
}
},
onFocus() {
this.focused = true;
},
onBlur() {
this.focused = false;
},
isFileSelected(file) {
if (this.files && this.files.length) {
for (let sFile of this.files) {
2022-09-14 11:26:01 +00:00
if (sFile.name + sFile.type + sFile.size === file.name + file.type + file.size) return true;
2022-09-06 12:03:37 +00:00
}
}
return false;
},
isIE11() {
return !!window['MSInputMethodContext'] && !!document['documentMode'];
},
validate(file) {
if (this.accept && !this.isFileTypeValid(file)) {
2022-09-14 11:26:01 +00:00
this.messages.push(this.invalidFileTypeMessage.replace('{0}', file.name).replace('{1}', this.accept));
2022-09-06 12:03:37 +00:00
return false;
}
if (this.maxFileSize && file.size > this.maxFileSize) {
this.messages.push(this.invalidFileSizeMessage.replace('{0}', file.name).replace('{1}', this.formatSize(this.maxFileSize)));
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
return false;
}
return true;
},
isFileTypeValid(file) {
2022-09-14 11:26:01 +00:00
let acceptableTypes = this.accept.split(',').map((type) => type.trim());
for (let type of acceptableTypes) {
let acceptable = this.isWildcard(type) ? this.getTypeClass(file.type) === this.getTypeClass(type) : file.type == type || this.getFileExtension(file).toLowerCase() === type.toLowerCase();
2022-09-06 12:03:37 +00:00
if (acceptable) {
return true;
}
}
return false;
},
getTypeClass(fileType) {
return fileType.substring(0, fileType.indexOf('/'));
},
2022-09-14 11:26:01 +00:00
isWildcard(fileType) {
2022-09-06 12:03:37 +00:00
return fileType.indexOf('*') !== -1;
},
getFileExtension(file) {
return '.' + file.name.split('.').pop();
},
isImage(file) {
return /^image\//.test(file.type);
},
onDragEnter(event) {
if (!this.disabled) {
event.stopPropagation();
event.preventDefault();
}
},
onDragOver(event) {
if (!this.disabled) {
DomHandler.addClass(this.$refs.content, 'p-fileupload-highlight');
event.stopPropagation();
event.preventDefault();
}
},
onDragLeave() {
if (!this.disabled) {
DomHandler.removeClass(this.$refs.content, 'p-fileupload-highlight');
}
},
onDrop(event) {
if (!this.disabled) {
DomHandler.removeClass(this.$refs.content, 'p-fileupload-highlight');
event.stopPropagation();
event.preventDefault();
const files = event.dataTransfer ? event.dataTransfer.files : event.target.files;
const allowDrop = this.multiple || (files && files.length === 1);
if (allowDrop) {
this.onFileSelect(event);
}
}
},
onBasicUploaderClick() {
2022-09-14 11:26:01 +00:00
if (this.hasFiles) this.upload();
else this.$refs.fileInput.click();
2022-09-06 12:03:37 +00:00
},
remove(index) {
this.clearInputElement();
let removedFile = this.files.splice(index, 1)[0];
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
this.files = [...this.files];
this.$emit('remove', {
file: removedFile,
files: this.files
});
},
2022-12-08 11:04:25 +00:00
removeUploadedFile(index) {
let removedFile = this.uploadedFiles.splice(index, 1)[0];
this.uploadedFiles = [...this.uploadedFiles];
this.$emit('remove-uploaded-file', {
file: removedFile,
files: this.uploadedFiles
});
},
2022-09-06 12:03:37 +00:00
clearInputElement() {
this.$refs.fileInput.value = '';
},
clearIEInput() {
if (this.$refs.fileInput) {
this.duplicateIEEvent = true; //IE11 fix to prevent onFileChange trigger again
this.$refs.fileInput.value = '';
}
},
formatSize(bytes) {
if (bytes === 0) {
return '0 B';
}
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
let k = 1000,
2022-09-14 11:26:01 +00:00
dm = 3,
sizes = ['B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'],
i = Math.floor(Math.log(bytes) / Math.log(k));
2022-09-06 12:03:37 +00:00
return parseFloat((bytes / Math.pow(k, i)).toFixed(dm)) + ' ' + sizes[i];
},
isFileLimitExceeded() {
if (this.fileLimit && this.fileLimit <= this.files.length + this.uploadedFileCount && this.focused) {
this.focused = false;
}
return this.fileLimit && this.fileLimit < this.files.length + this.uploadedFileCount;
},
checkFileLimit() {
if (this.isFileLimitExceeded()) {
2022-09-14 11:26:01 +00:00
this.messages.push(this.invalidFileLimitMessage.replace('{0}', this.fileLimit.toString()));
2022-09-06 12:03:37 +00:00
}
},
onMessageClose() {
this.messages = null;
}
},
computed: {
isAdvanced() {
return this.mode === 'advanced';
},
isBasic() {
return this.mode === 'basic';
},
advancedChooseButtonClass() {
2022-09-14 11:26:01 +00:00
return [
'p-button p-component p-fileupload-choose',
this.class,
{
2022-09-06 12:03:37 +00:00
'p-disabled': this.disabled,
'p-focus': this.focused
}
];
},
basicChooseButtonClass() {
2022-09-14 11:26:01 +00:00
return [
'p-button p-component p-fileupload-choose',
this.class,
{
'p-fileupload-choose-selected': this.hasFiles,
'p-disabled': this.disabled,
'p-focus': this.focused
}
];
2022-09-06 12:03:37 +00:00
},
advancedChooseIconClass() {
return ['p-button-icon p-button-icon-left pi-fw', this.chooseIcon];
},
basicChooseButtonIconClass() {
2022-09-14 11:26:01 +00:00
return ['p-button-icon p-button-icon-left', !this.hasFiles || this.auto ? this.uploadIcon : this.chooseIcon];
2022-09-06 12:03:37 +00:00
},
basicChooseButtonLabel() {
2022-09-14 11:26:01 +00:00
return this.auto ? this.chooseButtonLabel : this.hasFiles ? this.files.map((f) => f.name).join(', ') : this.chooseButtonLabel;
2022-09-06 12:03:37 +00:00
},
hasFiles() {
return this.files && this.files.length > 0;
},
2022-12-08 11:04:25 +00:00
hasUploadedFiles() {
return this.uploadedFiles && this.uploadedFiles.length > 0;
},
2022-09-06 12:03:37 +00:00
chooseDisabled() {
return this.disabled || (this.fileLimit && this.fileLimit <= this.files.length + this.uploadedFileCount);
},
uploadDisabled() {
return this.disabled || !this.hasFiles || (this.fileLimit && this.fileLimit < this.files.length);
},
cancelDisabled() {
return this.disabled || !this.hasFiles;
},
chooseButtonLabel() {
return this.chooseLabel || this.$primevue.config.locale.choose;
},
uploadButtonLabel() {
return this.uploadLabel || this.$primevue.config.locale.upload;
},
cancelButtonLabel() {
return this.cancelLabel || this.$primevue.config.locale.cancel;
2022-12-08 11:04:25 +00:00
},
completedLabel() {
return this.$primevue.config.locale.completed;
},
pendingLabel() {
return this.$primevue.config.locale.pending;
2022-09-06 12:03:37 +00:00
}
},
components: {
2022-09-14 11:26:01 +00:00
FileUploadButton: Button,
FileUploadProgressBar: ProgressBar,
2022-12-08 11:04:25 +00:00
FileUploadMessage: Message,
FileContent
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-fileupload-content {
position: relative;
}
.p-fileupload-content .p-progressbar {
width: 100%;
position: absolute;
top: 0;
left: 0;
}
.p-button.p-fileupload-choose {
position: relative;
overflow: hidden;
}
2022-12-08 11:04:25 +00:00
.p-fileupload-buttonbar {
display: flex;
flex-wrap: wrap;
2022-09-06 12:03:37 +00:00
}
2022-12-08 11:04:25 +00:00
.p-fileupload > input[type='file'],
.p-fileupload-basic input[type='file'] {
2022-09-06 12:03:37 +00:00
display: none;
}
.p-fluid .p-fileupload .p-button {
width: auto;
}
2022-12-08 11:04:25 +00:00
.p-fileupload-file {
display: flex;
flex-wrap: wrap;
align-items: center;
}
.p-fileupload-file-thumbnail {
flex-shrink: 0;
}
.p-fileupload-file-actions {
margin-left: auto;
}
2022-09-06 12:03:37 +00:00
</style>