40 lines
1.5 KiB
Markdown
40 lines
1.5 KiB
Markdown
### Usage
|
|
```typescript
|
|
import { FileSelectDirective, FileDropDirective, FileUploader } from 'ng2-file-upload/ng2-file-upload';
|
|
```
|
|
|
|
### Annotations
|
|
```typescript
|
|
// class FileSelectDirective
|
|
@Directive({ selector: '[ng2FileSelect]' })
|
|
```
|
|
|
|
```typescript
|
|
// class FileDropDirective
|
|
@Directive({ selector: '[ng2FileDrop]' })
|
|
```
|
|
|
|
## 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)
|
|
|
|
Parameters supported by this object:
|
|
|
|
1. `url` - URL of File Uploader's route
|
|
2. `authToken` - auth token that will be applied as 'Authorization' header during file send.
|
|
3. `disableMultipart` - If 'true', disable using a multipart form for file upload and instead stream the file. Some APIs (e.g. Amazon S3) may expect the file to be streamed rather than sent via a form. Defaults to false.
|
|
|
|
## 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
|
|
|
|
- `fileOver` - 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)
|