ngx-dropzone-wrapper

Angular Dropzone Wrapper

This is an Angular wrapper library for the Dropzone.

See a live example application here.

Building the library

npm install
npm run build

Running the example

cd example
npm install
npm start

Installing and usage

npm install ngx-dropzone-wrapper@4.6.6 --save

Load the module for your app (with global configuration):

import { DropzoneModule } from 'ngx-dropzone-wrapper';
import { DropzoneConfigInterface } from 'ngx-dropzone-wrapper';

const DROPZONE_CONFIG: DropzoneConfigInterface = {
  // Change this to your upload POST address:
  url: 'https://httpbin.org/post',
  maxFilesize: 50,
  acceptedFiles: 'image/*'
};

@NgModule({
  ...
  imports: [
    ...
    DropzoneModule.forRoot(DROPZONE_CONFIG)
  ]
})

Use it in your html template (with custom configuration):

This library provides two ways to create a Dropzone element, simple component and custom directive.

COMPONENT USAGE

Simply replace the element that would ordinarily be passed to Dropzone with the dropzone component.

NOTE: Component provides couple additional features from directive. Such as the placeholder image, if you don't need them or are heavily customizing the dropzone then you might want to use the directive instead.

<dropzone [config]="config" [message]="'Click or drag images here to upload'" (error)="onUploadError($event)" (success)="onUploadSuccess($event)"></dropzone>

[config]            // Custom config to override the global defaults.
[disabled]          // Disables / detaches dropzone from the element.

[message]           // Message to show for the user on the upload area.
[placeholder]       // Placeholder image to be shown as the upload area.

[useDropzoneClass]  // Use dropzone class (needed by the default styles).

[runInsideAngular]  // Run dropzone function calls inside the angular zone.

(error)             // Event handler for the dropzone upload error event.
(success)           // Event handler for the dropzone upload success event.
(canceled)          // Event handler for the dropzone upload canceled event.

(<dropzone-event>)  // All other dropzone events are also supported as bindings.

DIRECTIVE USAGE

When using only the directive you need to provide your own theming or import the default theme:

@import 'https://cdnjs.cloudflare.com/ajax/libs/dropzone/5.1.1/min/dropzone.min.css';

Dropzone directive can be used in form or div element with optional custom configuration:

<div [dropzone]="config" (error)="onUploadError($event)" (success)="onUploadSuccess($event)"></div>

[dropzone]          // Can be used to provide optional custom config.
[disabled]          // Disables / detaches dropzone from the element.

[useDropzoneClass]  // Use dropzone class (needed by the default styles).

[runInsideAngular]  // Run dropzone function calls inside the angular zone.

(error)             // Event handler for the dropzone upload error event.
(success)           // Event handler for the dropzone upload success event.
(canceled)          // Event handler for the dropzone upload canceled event.

(<dropzone-event>)  // All other dropzone events are also supported as bindings.

Available configuration options (custom / global configuration):

This library supports all Dropzone configuration options and few custom extra options for easier usage.

LIBRARY OPTIONS

autoReset         // Time for resetting component after upload (Default: null).
errorReset        // Time for resetting component after an error (Default: null).
cancelReset       // Time for resetting component after canceling (Default: null).

DROPZONE OPTIONS

url               // Upload url where to send the upload request (Default: '').
method            // HTTP method to use communicating with the server (Default: 'post').
headers           // Object of additional headers to send to the server (Default: null).
paramName         // Name of the file parameter that gets transferred (Default: 'file').
maxFilesize       // Maximum file size for the upload files in megabytes (Default: null).
acceptedFiles     // Comma separated list of mime types or file extensions (Default: null).

For more detailed documentation with all the supported dropzone events / options see Dropzone documentation.

Available control / helper functions (provided by the directive):

reset()            // Resets the dropzone upload area (removes all finished preview files).

Above functions can be accessed through the directive reference (available as directiveRef in the component).