Compare commits

..
Author SHA1 Message Date
Matthew McSparranandGitHub f577becb29 Updated docs
The README has been updated to include information on adding extra fields to uploads when uploading multiple files.
2017-12-20 10:39:37 -05:00
5 changed files with 104 additions and 17211 deletions
+58 -2
View File
@@ -43,6 +43,63 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
```public uploader:FileUploader = new FileUploader({url: URL}); ```
## Using ***ng2-file-upload*** with multiple uploads and other parameters
To add extra information (i.e. title, description) when uploading multiple files:
In your template:
```
<tr *ngFor="let item of uploader.queue">
<td><strong>{{ item?.file?.name }}</strong></td>
**<td><input type="text" [(ngModel)]="item.formData['title']" placeholder="Title of File"></td>**
**<td><input type="text" [(ngModel)]="item.formData['description']" placeholder="File Description"></td>**
<td nowrap>{{ item?.file?.size/1024/1024 | number:'.2' }} MB</td>
<td >
<div class="progress" style="margin-bottom: 0;">
<div class="progress-bar" role="progressbar" [ngStyle]="{ 'width': item.progress + '%' }"></div>
</div>
</td>
<td class="text-center">
<span *ngIf="item.isSuccess"><i class="glyphicon glyphicon-ok"></i></span>
<span *ngIf="item.isCancel"><i class="glyphicon glyphicon-ban-circle"></i></span>
<span *ngIf="item.isError"><i class="glyphicon glyphicon-remove"></i></span>
</td>
<td nowrap>
<button type="button" class="btn btn-success btn-xs"
(click)="item.upload()" [disabled]="item.isReady || item.isUploading || item.isSuccess">
<span class="glyphicon glyphicon-upload"></span> Upload
</button>
<button type="button" class="btn btn-warning btn-xs"
(click)="item.cancel()" [disabled]="!item.isUploading">
<span class="glyphicon glyphicon-ban-circle"></span> Cancel
</button>
<button type="button" class="btn btn-danger btn-xs"
(click)="item.remove()">
<span class="glyphicon glyphicon-trash"></span> Remove
</button>
</td>
</tr>
```
You can add inputs outside of a form, and use ```[(ngModel)]``` to add keys to the ```item``` object.
```
**<td><input type="text" [(ngModel)]="item.formData['title']" placeholder="Title of File"></td>**
**<td><input type="text" [(ngModel)]="item.formData['description']" placeholder="File Description"></td>**
```
Inside your upload component, add the following:
```
this.uploader.onBuildItemForm = (item, form) => {
form.append('title', item.formData.title);
form.append('description', item.formData.description);
console.log(item);
};
```
If you are using `Node.js` with `multer`, the extra information will not show up in the `req.files` object. You will have to pull the data from the `req.body` object.
## API for `ng2FileSelect`
### Properties
@@ -67,8 +124,7 @@ Easy to use Angular2 directives for files upload ([demo](http://valor-software.g
5. `formatDataFunction` - Function to modify the request body. 'DisableMultipart' must be 'true' for this function to be called.
6. `formatDataFunctionIsAsync` - Informs if the function sent in 'formatDataFunction' is asynchronous. Defaults to false.
7. `parametersBeforeFiles` - States if additional parameters should be appended before or after the file. Defaults to false.
8. `uploadFilesInSingleRequest` - If 'true', all files in the queue will be uploaded using one multipart request. Defaults to false. Notice this cannot be combined with 'disableMultipart' is 'true'.
### 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.
@@ -18,9 +18,8 @@ export class SimpleDemoComponent {
constructor (){
this.uploader = new FileUploader({
url: URL,
disableMultipart: false, // 'DisableMultipart' must be 'true' for formatDataFunction to be called.
uploadFilesInSingleRequest: true,
formatDataFunctionIsAsync: false,
disableMultipart: true, // 'DisableMultipart' must be 'true' for formatDataFunction to be called.
formatDataFunctionIsAsync: true,
formatDataFunction: async (item) => {
return new Promise( (resolve, reject) => {
resolve({
-17113
View File
File diff suppressed because it is too large Load Diff
+1 -3
View File
@@ -7,9 +7,7 @@
"lite-server": "lite-server -c demo/bs-config.json",
"demo.serve": "run-s build link demo.build lite-server",
"demo.gh-pages": "run-s build demo.build demo.deploy",
"demo.build": "ng build",
"demo.build.watch": "ng build --watch",
"demo.buildOld": "ng build -prod --aot",
"demo.build": "ng build -prod --aot",
"demo.deploy": "gh-pages -d demo/dist",
"link": "ngm link -p src --here",
"lint": "exit 0",
+43 -90
View File
@@ -39,7 +39,6 @@ export interface FileUploaderOptions {
parametersBeforeFiles?: boolean;
formatDataFunction?: Function;
formatDataFunctionIsAsync?: boolean;
uploadFilesInSingleRequest?: boolean;
}
export class FileUploader {
@@ -60,19 +59,19 @@ export class FileUploader {
removeAfterUpload: false,
disableMultipart: false,
formatDataFunction: (item: FileItem) => item._file,
formatDataFunctionIsAsync: false,
uploadFilesInSingleRequest : false
formatDataFunctionIsAsync: false
};
protected _failFilterIndex: number;
public constructor(options: FileUploaderOptions) {
this.setOptions(options);
this.response = new EventEmitter<any>();
this.response = new EventEmitter<any>();
}
public setOptions(options: FileUploaderOptions): void {
this.options = Object.assign(this.options, options);
this.authToken = this.options.authToken;
this.authTokenHeader = this.options.authTokenHeader || 'Authorization';
this.autoUpload = this.options.autoUpload;
@@ -146,24 +145,16 @@ export class FileUploader {
this.progress = 0;
}
public uploadItem(value: FileItem): void {
this.uploadItems(new Array<FileItem>(value));
}
public uploadItems(values: FileItem[]): void {
values.forEach(element => {
let index = this.getIndexOfItem(element);
let item = this.queue[ index ];
item._prepareToUploading();
});
public uploadItem(value: FileItem): void {
let index = this.getIndexOfItem(value);
let item = this.queue[ index ];
let transport = this.options.isHTML5 ? '_xhrTransport' : '_iframeTransport';
item._prepareToUploading();
if (this.isUploading) {
return;
}
this.isUploading = true;
(this as any)[ transport ](values);
this.isUploading = true;
(this as any)[ transport ](item);
}
public cancelItem(value: FileItem): void {
@@ -175,20 +166,13 @@ export class FileUploader {
}
}
public uploadAll(): void {
public uploadAll(): void {
let items = this.getNotUploadedItems().filter((item: FileItem) => !item.isUploading);
if (!items.length) {
return;
}
items.map((item: FileItem) => item._prepareToUploading());
if (this.options.uploadFilesInSingleRequest){
this.uploadItems(items);
}
else{
items[ 0 ].upload();
}
items[ 0 ].upload();
}
public cancelAll(): void {
@@ -291,27 +275,12 @@ export class FileUploader {
public _onCompleteItem(item: FileItem, response: string, status: number, headers: ParsedResponseHeaders): void {
item._onComplete(response, status, headers);
this.onCompleteItem(item, response, status, headers);
if (!this.options.uploadFilesInSingleRequest)
{
let nextItem = this.getReadyItems()[ 0 ];
this.isUploading = false;
if (nextItem) {
nextItem.upload();
return;
}
this.onCompleteAll();
this.progress = this._getTotalProgress();
this._render();
}
}
public _onCompleteAllItems(items: FileItem[], response: string, status: number, headers: ParsedResponseHeaders): void {
items.forEach(item => {
item._onComplete(response, status, headers);
this.onCompleteItem(item, response, status, headers);
});
let nextItem = this.getReadyItems()[ 0 ];
this.isUploading = false;
if (nextItem) {
nextItem.upload();
return;
}
this.onCompleteAll();
this.progress = this._getTotalProgress();
this._render();
@@ -326,36 +295,22 @@ export class FileUploader {
};
}
protected _xhrTransport(items: FileItem[]): any {
protected _xhrTransport(item: FileItem): any {
let that = this;
let firstItem = items[0];
let xhr = firstItem._xhr = new XMLHttpRequest();
let xhr = item._xhr = new XMLHttpRequest();
let sendable: any;
this._onBeforeUploadItem(item);
items.forEach(item => {
this._onBeforeUploadItem(item);
});
items.forEach(item => {
if (typeof item._file.size !== 'number') {
throw new TypeError('The file specified is no longer valid');
}
});
if (typeof item._file.size !== 'number') {
throw new TypeError('The file specified is no longer valid');
}
if (!this.options.disableMultipart) {
sendable = new FormData();
items.forEach(item => {
this._onBuildItemForm(item, sendable);
});
const appendFiles = () => {
items.forEach(item => {
sendable.append(item.alias, item._file, item.file.name)
});
};
this._onBuildItemForm(item, sendable);
const appendFile = () => sendable.append(item.alias, item._file, item.file.name);
if (!this.options.parametersBeforeFiles) {
appendFiles();
appendFile();
}
// For AWS, Additional Parameters must come BEFORE Files
@@ -363,55 +318,53 @@ export class FileUploader {
Object.keys(this.options.additionalParameter).forEach((key: string) => {
let paramVal = this.options.additionalParameter[ key ];
// Allow an additional parameter to include the filename
if (!this.options.uploadFilesInSingleRequest && typeof paramVal === 'string' && paramVal.indexOf('{{file_name}}') >= 0) {
paramVal = paramVal.replace('{{file_name}}', firstItem.file.name);
if (typeof paramVal === 'string' && paramVal.indexOf('{{file_name}}') >= 0) {
paramVal = paramVal.replace('{{file_name}}', item.file.name);
}
sendable.append(key, paramVal);
});
}
if (this.options.parametersBeforeFiles) {
appendFiles();
appendFile();
}
} else {
sendable = this.options.formatDataFunction(firstItem);
sendable = this.options.formatDataFunction(item);
}
xhr.upload.onprogress = (event: any) => {
let progress = Math.round(event.lengthComputable ? event.loaded * 100 / event.total : 0);
this._onProgressItem(item, progress);
};
xhr.onload = () => {
let headers = this._parseHeaders(xhr.getAllResponseHeaders());
let response = this._transformResponse(xhr.response, headers);
let gist = this._isSuccessCode(xhr.status) ? 'Success' : 'Error';
let method = '_on' + gist + 'Item';
items.forEach(item => {
(this as any)[ method ](item, response, xhr.status, headers);
});
this._onCompleteAllItems(items, response, xhr.status, headers);
(this as any)[ method ](item, response, xhr.status, headers);
this._onCompleteItem(item, response, xhr.status, headers);
};
xhr.onerror = () => {
let headers = this._parseHeaders(xhr.getAllResponseHeaders());
let response = this._transformResponse(xhr.response, headers);
items.forEach(item => {
this._onErrorItem(firstItem, response, xhr.status, headers);
});
this._onCompleteAllItems(items, response, xhr.status, headers);
this._onErrorItem(item, response, xhr.status, headers);
this._onCompleteItem(item, response, xhr.status, headers);
};
xhr.onabort = () => {
let headers = this._parseHeaders(xhr.getAllResponseHeaders());
let response = this._transformResponse(xhr.response, headers);
items.forEach(item => {
this._onCancelItem(firstItem, response, xhr.status, headers);
});
this._onCompleteAllItems(items, response, xhr.status, headers);
this._onCancelItem(item, response, xhr.status, headers);
this._onCompleteItem(item, response, xhr.status, headers);
};
xhr.open(firstItem.method, firstItem.url, true);
xhr.withCredentials = firstItem.withCredentials;
xhr.open(item.method, item.url, true);
xhr.withCredentials = item.withCredentials;
if (this.options.headers) {
for (let header of this.options.headers) {
xhr.setRequestHeader(header.name, header.value);
}
}
if (firstItem.headers.length) {
for (let header of firstItem.headers) {
if (item.headers.length) {
for (let header of item.headers) {
xhr.setRequestHeader(header.name, header.value);
}
}