Pure-upload
The pure JS (TS) upload library with no dependencies compatible with Google Chrome, Firefox, IE10+ (IE9- with auto-start by default, manual-start optionally) and mobile browsers.
Installation
- Dowload as a ZIP file directly from GitHub pages and include to your project.
- Install with npm by
npm install pure-upload --save
. - Install with bower by
bower install pure-upload
.
Example
See a simple example.
Api
Uploader
Uploader manages upload queue and registers upload areas.
Initialization:
var uploader = pu.getUploader(uploadQueueOptions, uploadQueueCallbacks)
Upload queue options
maxParallelUploads?: number;
autoStart?: boolean;
autoRemove?: boolean;
Upload queue callbacks
onProgressCallback?: (file: IUploadFile) => void;
onCancelledCallback?: (file: IUploadFile) => void;
onFinishedCallback?: (file: IUploadFile) => void;
onUploadedCallback?: (file: IUploadFile) => void;
onErrorCallback?: (file: IUploadFile) => void;
onUploadStartedCallback?: (file: IUploadFile) => void;
onFileAddedCallback?: (file: IUploadFile) => void;
onFileRemovedCallback?: (file: IUploadFile) => void;
onAllFinishedCallback?: () => void;
onQueueChangedCallback?: (queue: IUploadFile[]) => void;
onFilesAddedErrorCallback?: (files: IUploadFile[]) => void;
Upload area
Upload area defines element registred in Uploader.
Registration:
var uploadArea = uploader.registerArea(element, uploadAreaOptions);
Registration for IE9- with manual-start:
var uploadArea = uploader.registerArea(element, uploadAreaOptions, compatibilityForm);
The compatibilityForm objects has to be form element containing one input element for file and one input element for submit.
Unregistration:
uploader.unregisterArea(uploadArea);
Upload area options
url: string;
method: string;
withCredentials?: boolean;
headers?: { [key: string]: any; };
params?: { [key: string]: any; };
maxFileSize?: number;
allowDragDrop?: boolean;
clickable?: boolean;
accept?: string;
multiple?: boolean;
Upload file
Standard File object extended with additional informations and methods to manage a file in queue.
guid: string;
uploadStatus: IUploadStatus;
responseCode: number;
responseText: string;
progress: number;
sentBytes: number;
cancel: () => void;
remove: () => void;
start: () => void;
Upload status
File statuses accesible by pu.uploadStatus
.
Library used by GMC Software Technology.