Updating Naming and Files to Work With Services
This commit is contained in:
Paulo
42
README.md
42
README.md
@@ -1,31 +1,31 @@
|
||||
# ng2-file-upload [](http://badge.fury.io/js/ng2-file-upload) [](https://npmjs.org/ng2-file-upload)[](https://ngx-slack.herokuapp.com)
|
||||
Easy to use Angular2 directives for files upload ([demo](http://valor-software.github.io/ng2-file-upload/))
|
||||
# ng2-chunk-file-upload [](http://badge.fury.io/js/ng2-chunk-file-upload) [](https://npmjs.org/ng2-chunk-file-upload)[](https://ngx-slack.herokuapp.com)
|
||||
Easy to use Angular2 directives for files upload ([demo](http://valor-software.github.io/ng2-chunk-file-upload/))
|
||||
|
||||
[](https://github.com/mgechev/angular2-style-guide)
|
||||
[](https://travis-ci.org/valor-software/ng2-file-upload)
|
||||
[](https://david-dm.org/valor-software/ng2-file-upload)
|
||||
[](https://travis-ci.org/valor-software/ng2-chunk-file-upload)
|
||||
[](https://david-dm.org/valor-software/ng2-chunk-file-upload)
|
||||
|
||||
## Quick start
|
||||
|
||||
1. A recommended way to install ***ng2-file-upload*** is through [npm](https://www.npmjs.com/search?q=ng2-file-upload) package manager using the following command:
|
||||
1. A recommended way to install ***ng2-chunk-file-upload*** is through [npm](https://www.npmjs.com/search?q=ng2-chunk-file-upload) package manager using the following command:
|
||||
|
||||
`npm i ng2-file-upload --save`
|
||||
`npm i ng2-chunk-file-upload --save`
|
||||
|
||||
Alternatively, you can [download it in a ZIP file](https://github.com/valor-software/ng2-file-upload/archive/master.zip).
|
||||
Alternatively, you can [download it in a ZIP file](https://github.com/valor-software/ng2-chunk-file-upload/archive/master.zip).
|
||||
|
||||
2. Currently `ng2-file-upload` contains two directives: `ng2-file-select` and `ng2-file-drop`. `ng2-file-select` is used for 'file-input' field of form and
|
||||
2. Currently `ng2-chunk-file-upload` contains two directives: `ng2-file-select` and `ng2-file-drop`. `ng2-file-select` is used for 'file-input' field of form and
|
||||
`ng2-file-drop` is used for area that will be used for dropping of file or files.
|
||||
|
||||
3. More information regarding using of ***ng2-file-upload*** is located in
|
||||
[demo](http://valor-software.github.io/ng2-file-upload/) and [demo sources](https://github.com/valor-software/ng2-file-upload/tree/master/demo).
|
||||
3. More information regarding using of ***ng2-chunk-file-upload*** is located in
|
||||
[demo](http://valor-software.github.io/ng2-chunk-file-upload/) and [demo sources](https://github.com/valor-software/ng2-chunk-file-upload/tree/master/demo).
|
||||
|
||||
## Using ***ng2-file-upload*** in a project
|
||||
## Using ***ng2-chunk-file-upload*** in a project
|
||||
|
||||
1. Install as shown in the above section.
|
||||
|
||||
2. Import `FileUploadModule` into the module that declares the component using ***ng2-file-upload***:
|
||||
2. Import `FileUploadModule` into the module that declares the component using ***ng2-chunk-file-upload***:
|
||||
|
||||
```import { FileUploadModule } from 'ng2-file-upload';```
|
||||
```import { FileUploadModule } from 'ng2-chunk-file-upload';```
|
||||
|
||||
3. Add it to `[imports]` under `@NgModule`:
|
||||
|
||||
@@ -33,7 +33,7 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
|
||||
|
||||
4. Import `FileUploader` into the component:
|
||||
|
||||
```import { FileUploader } from 'ng2-file-upload';```
|
||||
```import { FileUploader } from 'ng2-chunk-file-upload';```
|
||||
|
||||
5. Create a variable for the API url:
|
||||
|
||||
@@ -47,7 +47,7 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
|
||||
|
||||
### 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)
|
||||
- `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-chunk-file-upload/blob/master/demo/components/file-upload/simple-demo.ts)
|
||||
|
||||
### Events
|
||||
- `onFileSelected` - fires when files are selected and added to the uploader queue
|
||||
@@ -56,7 +56,7 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
|
||||
|
||||
### 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)
|
||||
- `uploader` - (`FileUploader`) - uploader object. See using in [demo](https://github.com/valor-software/ng2-chunk-file-upload/blob/master/demo/components/file-upload/simple-demo.ts)
|
||||
|
||||
Parameters supported by this object:
|
||||
|
||||
@@ -76,15 +76,15 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
|
||||
### 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)
|
||||
See using in [ts demo](https://github.com/valor-software/ng2-chunk-file-upload/blob/master/demo/components/file-upload/simple-demo.ts) and
|
||||
[html demo](https://github.com/valor-software/ng2-chunk-file-upload/blob/master/demo/components/file-upload/simple-demo.html)
|
||||
- `onFileDrop` - it fires after a file has been dropped on a Drop Area; you can pass in `$event` to get the list of files that were dropped. i.e. `(onFileDrop)="dropped($event)"`
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
Please follow this guidelines when reporting bugs and feature requests:
|
||||
|
||||
1. Use [GitHub Issues](https://github.com/valor-software/ng2-file-upload/issues) board to report bugs and feature requests (not our email address)
|
||||
1. Use [GitHub Issues](https://github.com/valor-software/ng2-chunk-file-upload/issues) board to report bugs and feature requests (not our email address)
|
||||
2. Please **always** write steps to reproduce the error. That way we can focus on fixing the bug, not scratching our heads trying to reproduce it.
|
||||
|
||||
Thanks for understanding!
|
||||
@@ -106,7 +106,7 @@ Thanks for understanding!
|
||||
### Code snippet on how to use the Chunk File Feature on your code
|
||||
```typescript
|
||||
...
|
||||
import { FileUploader } from 'ng2-file-upload';
|
||||
import { FileUploader } from 'ng2-chunk-file-upload';
|
||||
...
|
||||
export class SimpleDemoComponent {
|
||||
...
|
||||
@@ -152,4 +152,4 @@ Thanks for understanding!
|
||||
|
||||
### License
|
||||
|
||||
The MIT License (see the [LICENSE](https://github.com/valor-software/ng2-file-upload/blob/master/LICENSE) file for the full text)
|
||||
The MIT License (see the [LICENSE](https://github.com/valor-software/ng2-chunk-file-upload/blob/master/LICENSE) file for the full text)
|
||||
|
||||
Reference in New Issue
Block a user