saaksin-ngx-dropzone-wrapper
v4.0.7
Published
Angular wrapper library for Dropzone
Downloads
42
Readme
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
npm run example
Running the example
cd example
npm install
npm start
예제 브라우저 주소
http://localhost:44444
Installing and usage
npm install saaksin-ngx-dropzone-wrapper --save-dev
Load the module for your app (with global configuration):
import { DropzoneModule } from 'saaksin-ngx-dropzone-wrapper';
import { DropzoneConfigInterface } from 'saaksin-ngx-dropzone-wrapper';
const DROPZONE_CONFIG: DropzoneConfigInterface = {
// Change this to your upload POST address:
server: '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 oridinarily be passed to Dropzone
with the dropzone component.
<dropzone [config]="config" [thumbnails]="thumbnails" [message]="'Click or drag images here to upload'" (error)="onUploadError($event)" (success)="onUploadSuccess($event)"></dropzone>
[config] // Custom config to override the global defaults.
[thumbnails] // 초기 서버 이미지 지정 [{name: '', size: 0, url: ''}]
[message] // Message to show for the user on the upload area.
[placeholder] // Placeholder image to be shown as the upload area.
(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.
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/4.3.0/dropzone.min.css';
Dropzone directive can be used in form or div element with optional custom configuration:
<div [dropzone]="config" [thumbnails]="thumbnails" (error)="onUploadError($event)" (success)="onUploadSuccess($event)"></div>
[dropzone] // Can be used to provide optional custom config.
[thumbnails] // 초기 서버 이미지 지정 [{name: '', size: 0, url: ''}]
(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.
Available configuration options (custom / global configuration):
This library supports all Dropzone configuration options and few custom extra options for easier usage.
LIBRARY OPTIONS
server // Server url for sending the upload request (Default: '').
params // Url parameters to be added to the server url (Default: null).
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
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 options see Dropzone documentation.