From a117a30c93373b213e30a03e50de0f06bf96c1c3 Mon Sep 17 00:00:00 2001 From: buchslava Date: Fri, 16 Oct 2015 11:06:06 +0300 Subject: [PATCH] Updated: readme for demo --- components/file-upload/readme.md | 46 +++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/components/file-upload/readme.md b/components/file-upload/readme.md index 7ed3a5c..948542a 100644 --- a/components/file-upload/readme.md +++ b/components/file-upload/readme.md @@ -1,4 +1,48 @@ ### Usage ```typescript -import {fileUpload} from 'ng2-file-upload'; +import {FileSelect, FileDrop, FileUploader} from 'ng2-file-upload'; ``` + +### Annotations +```typescript +// class FileSelect +@Directive({ + selector: '[ng2-file-select]', + properties: ['uploader'], + host: { + '(change)': 'onChange()' + } +}) +``` + +```typescript +// class FileDrop +@Directive({ + selector: '[ng2-file-drop]', + properties: ['uploader'], + events: ['fileOver'], + host: { + '(drop)': 'onDrop($event)', + '(dragover)': 'onDragOver($event)', + '(dragleave)': 'onDragLeave($event)' + } +}) +``` + +## FileSelect API + +### Properties + + - `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) + +## FileDrop API + +### Properties + + - `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) + +### Events + + - `file-over` - it fires during 'over' and 'out' events for Drop Area; returns `boolean`: `true` if file is over Drop Area, `false` in case of out. + See using in [ts demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) and + [html demo](https://github.com/valor-software/ng2-file-upload/blob/master/demo/components/file-upload/simple-demo.html)