Introduction
The ability to upload files is a key requirement for many web and mobile applications. From uploading your photo on social media to post your resume on a job portal website, file upload is everywhere.
As a web developer, we must know that HTML provides the support of native file upload with a bit of help from JavaScript. With HTML5 the File API is added to the DOM. Using that, we can read the FileList and the File Object within it. This solves multiple use-cases with files, i.e, load them locally or send over the network to a server for processing, etc.
In this article, we will discuss 10 such usages of HTML file upload support. Hope you find it useful.
TL;DR
At any point in time, if you want to play with these file upload features, you can find it from here,
The source code of the demo is in my Github repo. ✋ Feel free to follow as I keep the code updated with examples. Please give a ⭐ if you find it useful.
1. Simple file upload
We can specify the input type as file to use the file uploader functionality in a web application.
<input type="file" id="file-uploader">
An input file type enables users with a button to upload one or more files. By default, it allows uploading a single file using the operating system's native file browser.
On successful upload, the File API makes it possible to read the File object using simple JavaScript code. To read the File object, we need to listen to the change event of the file uploader.
First, get the file uploader instance by id,
const fileUploader = document.getElementById('file-uploader');
Then add a change event listener to read the file object when the upload completes. We get the uploaded file information from the event.target.files property.
fileUploader.addEventListener('change', (event) => {
const files = event.target.files;
console.log('files', files);
});
Observe the output in the browser console. Note the FileList array with the File object having all the metadata information about the uploaded file.
Here is the CodePen for you with the same example to explore further
2. Multiple file uploads
We can upload multiple files at a time. To do that, we just need to add an attribute called, multiple to the input file tag.
<input type="file" id="file-uploader" multiple />
Now, the file browser will allow you to upload one or more files to upload. Just like the previous example, you can add a change event handler to capture the information about the files uploaded. Have you noticed, the FileList is an array? Right, for multiple file uploads the array will have information as,
Here is the CodePen link to explore multiple file uploads.
Whenever we upload a file, the File object has the metadata information like file name, size, last update time, type, etc. This information can be useful for further validations, decision-making.
const fileUploader = document.getElementById('file-uploader');
fileUploader.addEventListener('change', (event) => {
const files = event.target.files;
for (const file of files) {
const name = file.name;
const type = file.type ? file.type: 'NA';
const size = file.size;
const lastModified = file.lastModified;
console.log({ file, name, type, size, lastModified });
}
});
Here is the output for single file upload,
Use this CodePen to explore further,
4. Know about file accept property
We can use the accept attribute to limit the type of files to upload. You may want to show only the allowed types of images to browse from when a user is uploading a profile picture.
<input type="file" id="file-uploader" accept=".jpg, .png" multiple>
In the code above, the file browser will allow only the files with the extension jpg and png.
Note, in this case, the file browser automatically sets the file selection type as custom instead of all. However, you can always change it back to all files, if required.
Use this CodePen to explore the accept attribute,
5. Manage file content
You may want to show the file content after a successful upload of it. For profile pictures, it will be confusing if we do not show the uploaded picture to the user immediately after upload.
We can use the FileReader object to convert the file to a binary string. Then add a load event listener to get the binary string on successful file upload.
const reader = new FileReader();
fileUploader.addEventListener('change', (event) => {
const files = event.target.files;
const file = files[0];
reader.readAsDataURL(file);
reader.addEventListener('load', (event) => {
const img = document.createElement('img');
imageGrid.appendChild(img);
img.src = event.target.result;
img.alt = file.name;
});
});
Try selecting an image file in the CodePen below and see it renders.
6. Validate file size
As we have seen, we can read the size metadata of a file, we can actually use it for a file size validation. You may allow users to upload an image file up to 1MB. Let us see how to achieve that.
fileUploader.addEventListener('change', (event) => {
const file = event.target.files[0];
const size = file.size;
let msg = '';
if (size > 1024 * 1024) {
msg = `<span style="color:red;">The allowed file size is 1MB. The file you are trying to upload is of ${returnFileSize(size)}</span>`;
} else {
msg = `<span style="color:green;"> A ${returnFileSize(size)} file has been uploaded successfully. </span>`;
}
feedback.innerHTML = msg;
});
Try uploading a file of different sizes to see how the validation works,
7. Show file upload progress
The better usability is to let your users know about a file upload progress. We are now aware of the FileReader and the event to read and load the file.
const reader = new FileReader();
The FileReader has another event called, progress to know how much has been loaded. We can use HTML5's progress tag to create a progress bar with this information.
reader.addEventListener('progress', (event) => {
if (event.loaded && event.total) {
const percent = (event.loaded / event.total) * 100;
progress.value = percent;
}
});
How about you try uploading a bigger file and see the progress bar working in the CodePen below? Give it a try.
8. How about directory upload?
Can we upload an entire directory? Well, it is possible but with some limitations. There is a non-standard attribute(at least, while writing this article) called, webkitdirectory that allows us to upload an entire directory.
Though originally implemented only for WebKit-based browsers, webkitdirectory is also usable in Microsoft Edge as well as Firefox 50 and later. However, even though it has relatively broad support, it is still not standard and should not be used unless you have no alternative.
You can specify this attribute as,
<input type="file" id="file-uploader" webkitdirectory />
This will allow you to select a folder(aka, directory),
User has to provide a confirmation to upload a directory,
Once the user clicks the Upload button, the uploading takes place. One important point to note here. The FileList array will have information about all the files in the uploaded directory as a flat structure. But the key is, for each of the File objects, the webkitRelativePath attribute will have the directory path.
For example, let us consider a main directory and other folders and files under it,
Now the File objects will have the webkitRelativePath populated as,
You can use it to render the folder and files in any UI structure of your choice. Use this CodePen to explore further.
9. Let's drag, drop and upload
Not supporting a drag-and-drop for file upload is kinda old fashion, isn't it? Let us see how to achieve that with a few simple steps.
First, create a drop zone and optionally a section to show the uploaded file content. We will use an image as a file to drag and drop here.
<div id="container">
<h1>Drag & Drop an Image</h1>
<div id="drop-zone">
DROP HERE
</div>
<div id="content">
Your image to appear here..
</div>
</div>
Get the dropzone and the content areas by their respective ids.
const dropZone = document.getElementById('drop-zone');
const content = document.getElementById('content');
Add a dragover event handler to show the effect of something going to be copied,
dropZone.addEventListener('dragover', event => {
event.stopPropagation();
event.preventDefault();
event.dataTransfer.dropEffect = 'copy';
});
Next, define what we want to do when the image is dropped. We will need a drop event listener to handle that.
dropZone.addEventListener('drop', event => {
const files = event.dataTransfer.files;
});
Try to drag and drop an image file in the CodePen example below and see how it works. Do not forget to see the code to render the dropped image as well.
10. Handle files with objectURLs
There is a special method called, URL.createObjectURL() to create an unique URL from the file. You can also release it by using URL.revokeObjectURL() method.
The DOM URL.createObjectURL() and URL.revokeObjectURL() methods let you create simple URL strings that can be used to reference any data that can be referred to using a DOM File object, including local files on the user's computer.
A simple usage of the object URL is,
img.src = URL.createObjectURL(file);
Use this CodePen to explore the object URL further. Hint: Compare this approach with the approach mentioned in #5 previously.
Conclusion
I truly believe this,
Many times a native HTML feature may be enough for us to deal with the use-cases in hands. I found, file upload is one such that provides many cool options by default.
Let me know if this article was useful to you by commenting below. You may also like,
If it was useful to you, please Like/Share so that, it reaches others as well. Please hit the Subscribe button at the top of the page to get an email notification on my latest posts.
You can @ me on Twitter (@tapasadhikary) with comments, or feel free to follow me.
