Over a million developers have joined DZone.
{{announcement.body}}
{{announcement.title}}

Upload Files In .NET Core By Drag And Drop Using Dropzone.JS

DZone's Guide to

Upload Files In .NET Core By Drag And Drop Using Dropzone.JS

Learn a quick and easy drag and drop took, Dropzone.js, which will allow you to quickly customize your web site, while writing minimal code.

· Web Dev Zone ·
Free Resource

Deploying code to production can be filled with uncertainty. Reduce the risks, and deploy earlier and more often. Download this free guide to learn more. Brought to you in partnership with Rollbar.

Mostly all web applications out there have some amazing ways to upload a single file or multiple files. While surfing on Github I found this amazing library to upload the files to the server in a unique way with a lot of configurations. It supports parallel uploads along with cancellation of the files which are in the upload queue, along with a good looking progress bar to show the progress of the upload.

I got the drag and drop to work in just 5 minutes. It is super easy and has some powerful configurations. To install Dropzone you can use the Nuget command.

PM> Install-Package dropzone

Add reference of js and CSS files on your page. To get the UI ready, use this HTML:

<div class="row">
    <div class="col-md-9">
        <div id="dropzone">
            <form action="/Home/Upload" class="dropzone needsclick dz-clickable" id="uploader">
                <div class="dz-message needsclick">
                    Drop files here or click to upload.<br>
                </div>
            </form>
        </div>
    </div>
</div>


There are a few points to be noted in the above HTML. Notice the action and class attributes for the form element. You will also need the id attribute. as well. Here, the action attribute points to the ActionResult which is responsible for handling the file upload. I have pointed it to the Upload ActionResult in my controller class which accepts a parameter of the type, IFormFile. In the case of an MVC application, we would have used the HttpPostedFileBase class. Here is the complete code which handles the file upload.

[HttpPost]
public async Task<IActionResult> Upload(IFormFile file)
{
    var uploads = Path.Combine(_environment.WebRootPath, "uploads");
    if (file.Length > 0)
    {
        using (var fileStream = new FileStream(Path.Combine(uploads, file.FileName), FileMode.Create))
        {
            await file.CopyToAsync(fileStream);
        }
    }
    return RedirectToAction("Index");
}


The _environment variable you see in the above code is the instance of the IHostingEnvironment interface which I have injected into the controller. Always use the IHostingEnvironment interface to resolve the paths. You can hard code the file path, but it may not work on other platforms. The combined method returns the correct path based on the platform the code is executing. The WebRootPath property returns the path of wwwroot to the folder, and the second parameter, uploads, is then appended correctly with the path.

Now it is time to make some adjustments in the Dropzone configuration. Recall the id attribute of the form element. I named it uploader. The Dropzone library has a unique way to set the configuration. Like this:

<script>
    $(document).ready(function () {
        Dropzone.options.uploader = {
            paramName: "file",
            maxFilesize: 2,
            accept: function (file, done) {
                if (file.name == "test.jpg") {
                    alert("Can't upload a test file.");
                }
                else {
                    //Show a confirm alert and display the image on the page.
              }
           }
        };
});
</script>


You have to be a bit careful when setting this configuration. In the configuration above the paramName states the name that will be used to transfer the file. This name should be the same as the IFormFile parameter of the Upload method in the controller. In this case, I am using file and the same has to be there in the param of the Upload method. If the names mismatch, the files will not be uploaded. The other parameter I am using is the maxFileSize and is very much self-explanatory. I have set the size to be 2 MB and thus, because of this configuration, any file above this limit will not be uploaded. 

All the other files were uploaded successfully except one file which is 4.32 MB and is way beyond the limit I set in my Dropzone configuration. If you hover the file, you will see why it failed.

This is the simplest approach by which you can have drag and drop upload support in your applications. The configuration I am using here is the simplest and minimalistic configuration that can get you started in no time. There are some more powerful configurations like parallelUploads and uploadMultiple that you should also look into and use.

Deploying code to production can be filled with uncertainty. Reduce the risks, and deploy earlier and more often. Download this free guide to learn more. Brought to you in partnership with Rollbar.

Topics:
web dev ,javascript ,.net core

Published at DZone with permission of

Opinions expressed by DZone contributors are their own.

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}