A versatile and user-friendly file management system built with Vue.js and TypeScript that allows for single and multiple file uploading with a preview feature. It allows you to select files and preview them, returning an array of selected files. It allows customizing design by overriding the style classes.
Checkout the live demo on, codesandbox
- Features
- Getting Started
- Examples
- Properties and Events
- Usage
- Contributing
- License
- Contact Information
- Single File Upload: Users can upload or change a single file.
- Multiple File Management: Easily manage multiple files.
- File Preview: Provides a preview of uploaded files (e.g., images, videos, gifs).
- Responsive Design: Ensures a seamless experience on various devices.
- Fully customized: Customize file upload UI as per your requirements
Follow below instructions to configure this package into your project.
Before you begin, make sure you have the following software installed:
- Node.js - v20.x
- Vue3
- sass
Using npm:
npm install @canopassoftware/vue-file-upload
Using yarn:
yarn add @canopassoftware/vue-file-upload
We are providing some examples with design. so, you can easily take it and use into your project.
For over-riding the design of default buttons, you can over-ride it's CSS by class name.
For example.,
- Over-ride CSS of remove file button you can add it like,
.remove-btn {
color: white;
background-color: red;
font-size: 25px;
padding: 5px;
}- Over-ride CSS of submit/upload file button you can add it like,
.upload-btn {
color: white;
background-color: rgb(51, 65, 85);
font-size: 25px;
padding: 5px 10px;
}-
:callback="handleFileUploading"
required- Description: Add your upload callback function while receive the selected file/files
-
:uploadedFile="uploadedFile" - For single file component
required- Uploaded file object with below format,
{ fileType: string, fileUrl: string, fileName: string }
-
:uploadedFiles="uploadedFiles" - For multiple file component
required- Uploaded files array with below format,
[ { fileType: string, fileUrl: string, fileName: string } ]
-
:uploadBtnText="'Upload'"
- default : Upload
- Text for save or upload file button
-
:progressBtnText="'Uploading...'"
- default : Uploading...
- Text for the progress bar, showing file uploading under the process
-
:removeBtnText="'Uploading...'"
- default : x
- Text for remove file button
-
:accept="'image/jpg, image/jpeg, image/png, video/mp4, audio/mp3, application/zip'"
- Validation for file type. By default it will select all the type of file.
-
:(filetype)Preview="'(file location)'"
- default : Default file icons as per file types
- Set path for your customized icon if needed
To manage and preview files with this library, follow these steps:
// using CommonJS
const { SingleFileUpload, MultipleFileUpload } = require('@canopassoftware/vue-file-upload')
OR
// using esModules
import { SingleFileUpload, MultipleFileUpload } from '@canopassoftware/vue-file-upload'-
You can customize file uploading UI in
templateblock. -
The
fileslot containingfileobject with following keys, we will use this object to show preview.file = file: { previewType: 'video', // type of the preview. like, file is image or video previewUrl: 'data:image/jpeg;base64,/9j/D1AAAACRsdW1pAAAD...', // URL of the file preview previewName: 'a152148640581.62d918f12a0b4.mp4', // preview file name isDragging: false // you will get it `true` when you dragging the file on design }
<div class="flex flex-wrap">
<SingleFileUpload
:uploadBtnText="'Upload'"
:progressBtnText="'Uploading...'"
:isUploading="isUploading"
:accept="'image/jpg, image/jpeg, image/png, video/mp4, audio/mp3, application/zip'"
:pdfPreview="'../assets/images/pdf-icon.png'"
:textPreview="'../assets/images/text-icon.png'"
:audioPreview="'../assets/images/music-icon.png'"
:apkPreview="'../assets/images/apk-icon.png'"
:zipPreview="'../assets/images/zip-icon.png'"
:sqlPreview="'../assets/images/sql-icon.png'"
:filePreview="'../assets/images/file-icon.png'"
:uploadedFile="uploadedFile"
:callback="handleFileUploading"
>
<template v-slot="file">
<!-- write a code to manage file design or use code from examples -->
</template>
</SingleFileUpload>
</div><script lang="ts">
import { SingleFileUpload } from '@canopassoftware/vue-file-upload'
export default {
components: {
SingleFileUpload
},
data() {
return {
uploadedFile: {} as {
fileType: string
fileUrl: string
fileName: string
}
}
},
methods: {
async handleFileUploading(file: any) {
// add your fileuploading logic to server and set data to the uploadedFile
this.uploadedFile.fileType = 'image'
this.uploadedFile.fileUrl = 'https://picsum.photos/300/224'
this.uploadedFile.fileName = file.name
await new Promise((resolve) => setTimeout(resolve, 2000))
},
}
}
</script><div class="flex flex-wrap">
<MultipleFileUpload
:removeBtnText="'remove'"
:uploadBtn="'Upload'"
:progressBtnText="'Uploading...'"
:accept="'image/jpg, image/jpeg, image/png, video/mp4, audio/mp3, application/zip'"
:pdfPreview="'../assets/images/pdf-icon.png'"
:textPreview="'../assets/images/text-icon.png'"
:audioPreview="'../assets/images/music-icon.png'"
:apkPreview="'../assets/images/apk-icon.png'"
:zipPreview="'../assets/images/zip-icon.png'"
:sqlPreview="'../assets/images/sql-icon.png'"
:filePreview="'../assets/images/file-icon.png'"
:uploadedFiles="uploadedFiles"
:callback="handleFilesUploading"
>
<template v-slot="file">
<!-- write a code to manage file design or use code from examples -->
</template>
</MultipleFileUpload>
</div><script lang="ts">
import { MultipleFileUpload } from '@canopassoftware/vue-file-upload'
export default {
components: {
MultipleFileUpload
},
data() {
return {
uploadedFiles: [] as Array<{
fileType: string
fileUrl: string
fileName: string
}>
}
},
methods: {
async handleFilesUploading(files: any) {
// add your fileuploading to server logic and set data to the uploadedFiles
this.uploadedFiles = []
for (var i = 0; i < files.length; i++) {
this.uploadedFiles.push({
fileType: 'image',
fileUrl: 'https://picsum.photos/300/224',
fileName: files[i].name
})
}
await new Promise((resolve) => setTimeout(resolve, 2000))
}
}
}
</script>We welcome contributions from the community. To contribute to this project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your fork.
- Submit a pull request with a clear description of your changes.
- Please ensure your code follows the project's coding standards and includes appropriate documentation.
This project is licensed under the MIT.
Vue file upload i 6E42 s owned and maintained by the Canopas team. You can reach out them on Github at canopas for questions or need support.