npmpackage.info

Gathering detailed insights and metrics for ngx-awesome-uploader-v2

ngx-awesome-uploader-v2

8.2.2

TypeScript

938.94 kB

Installations

npm install ngx-awesome-uploader-v2

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

12.13.0

NPM Version

6.13.4 Score

71.6

Supply Chain

95.7

Quality

75.5

Maintenance

Vulnerability

98.2

License

Pull Requests

Open

31

Total

47

Closed

12

Merged

4

Issues

Open

1

Total

1

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View All 4 Contributors

Languages

TypeScript

CSS

HTML

JavaScript

TypeScript (72.07%)

CSS (17.47%)

HTML (7.37%)

JavaScript (3.09%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

techaks

Download Statistics

Total Downloads

3,444

Last Day

Last Week

Last Month

Last Year

695

GitHub Statistics

25 Commits

2 Watchers

32 Branches

4 Contributors

Updated on Dec 26, 2019

Maintainers

Package Meta Information

Latest Version

8.2.2

Package Id

ngx-awesome-uploader-v2@8.2.2

Unpacked Size

938.94 kB

Size

191.55 kB

File Count

NPM Version

6.13.4

Node Version

12.13.0

Total Downloads

Cumulative downloads

Total Downloads

3,444

Last Day

Compared to previous day

Last Week

300%

Compared to previous week

Last Month

-75%

Compared to previous month

Last Year

20.9%

695

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tslib

Peer Dependencies

@angular/common @angular/core

ngx-awesome-uploader-v2

npm

This is an Angular Library for uploading files. It supports: File Upload and Preview (additionally preview images with lightbox), validation, image cropper , drag and drop with multi language support.

Tested on Angular 6/7/8. Supports Server Side Rendering.

Install
Usage
Configuration
File Validation _ Built-in validations _ Custom validation
Cropper
Custom template
Multi Language
Bonus

Quick-links

Example Application or StackBlitzDemo

Install

npm install ngx-awesome-uploader-v2 --save

Load the module for your app:

1import { FilePickerModule } from  'ngx-awesome-uploader-v2';
2@NgModule({
3imports:  [
4...
5FilePickerModule
6]
7})
8

Usage

In order to make library maximum compatible with apis you need to create and provide custom adapter which implements upload and remove requests. That's because I have no idea how to get file id in upload response json :) . So this libray exposes a FilePickerAdapter abstract class which you can import on your new class file definition:

import { FilePickerAdapter } from 'ngx-awesome-uploader-v2';

After importing it to your custom adapter implementation (EG: CustomAdapter.ts), you must implement those 2 methods which are abstract in the FilePickerAdapter base class which are:

public abstract uploadFile(fileItem: FilePreviewModel): Observable<number | string>;

public abstract removeFile(fileItem: FilePreviewModel): Observable<any>;

Note: Since uploadFile method will use http progress event, it has to return id of file (in string type only) in case of HttpEventType.Response type, or progress (in number type) in case of HttpEventType.UploadProgress. You will receive this id on removeFile method when you click remove.

You can check DEMO adapter here

Now you can use it in your template

1<ngx-file-picker [adapter]="adapter"> </ngx-file-picker>

and in the Component:

1import { HttpClient } from "@angular/common/http";
2import { DemoFilePickerAdapter } from "./demo-file-picker.adapter";
3import { Component } from "@angular/core";
4@Component({
5  selector: "demo-file-picker",
6  templateUrl: "./demo-file-picker.component.html",
7  styleUrls: ["./demo-file-picker.component.scss"]
8})
9export class DemoFilePickerComponent {
10  adapter = new DemoFilePickerAdapter(this.http);
11  constructor(private http: HttpClient) {}
12}

Note: As you see you should provide http instance to adapter. Still in Doubt? Check Minimal Setup Demo

api

1/** Whether to enable cropper. Default: disabled */
2@Input() enableCropper =  false;
3
4/** Whether to show default drag and drop template. Default:true */
5@Input() showeDragDropZone =  true;
6
7/** Single or multiple. Default: multi */
8@Input() uploadType =  'multi';
9
10/** Max size of selected file in MB. Default: no limit */
11@Input() fileMaxSize: number;
12
13/** Max count of file in multi-upload. Default: no limit */
14@Input() fileMaxCount: number;
15
16/** Total Max size limit of all files in MB. Default: no limit */
17@Input() totalMaxSize: number;
18
19/** Which file types to show on choose file dialog. Default: show all */
20@Input() accept: string;
21
22/** File extensions filter. Default: any exteion */
23@Input() fileExtensions: String;
24
25/** Cropper options if cropper enabled. Default:
26	dragMode: 'crop',
27	aspectRatio: 1,
28	autoCrop: true,
29	movable: true,
30	zoomable: true,
31	scalable: true,
32	autoCropArea: 0.8
33*/
34@Input() cropperOptions: Object;
35
36/** Custom Adapter for uploading/removing files. Required */
37@Input() adapter: FilePickerAdapter;
38
39/** Custom template for dropzone. Optional */
40@Input() dropzoneTemplate: TemplateRef<any>;
41
42/** Custom Preview Item template. Optional */
43@Input() itemTemplate: TemplateRef<any>;
44
45/** Whether to show default files preview container. Default: true */
46@Input() showPreviewContainer =  true;
47
48/** Custom validator function. Optional */
49@Input() customValidator: (file: File) => Observable<boolean>;
50  /** Custom captions input. Used for multi language support */
51@Input() captions: UploaderCaptions;
52
53  /** Custom predefined files */
54@Input() images: ImagePreviewModel;

Output events

1/** Emitted when file is uploaded via api successfully.
2Emitted for every file */
3@Output() uploadSuccess =  new  EventEmitter<FilePreviewModel>();
4/** Emitted when file is removed via api successfully.
5	Emitted for every file */
6@Output() removeSuccess =  new  EventEmitter<FilePreviewModel>();
7/** Emitted on file validation fail */
8@Output() validationError =  new  EventEmitter<ValidationError>();
9/** Emitted when file is added and passed validations. Not uploaded yet */
10@Output() fileAdded =  new  EventEmitter<FilePreviewModel>();

File-Validation

Built-in-validations

All validations are emitted through ValidationError event. To listen to validation errors (in case you provided validations), validationError event is emitted. validationError event implements interface ValidationError and which emits failed file and error type. Supported validations:

Validation Type	Description	Default
fileMaxSize: number	Max size of selected file in MB.	No limit
fileExtensions: String	Emitted when file does not satisfy provided extension	Any extension
uploadType: String	Upload type. Values: 'single' and 'multi'.	multi
totalMaxSize: number	Total Max size of files in MB. If cropper is enabled, the cropped image size is considered.	No limit
fileMaxCount: number	Limit total files to upload by count	No limit

Custom-validation

You can also provide your own custom validation along with built-in validations. You custom validation takes file: File and returns Observable<boolean>; So that means you can provide sync and async validations.

    myCustomValidator(file: File): Observable<boolean>  {
    	if (file.name.includes('panda')) {
		    return  of(true);
	      }
	    if (file.size  >  50) {
			return  this.http.get('url').pipe(map((res) => res ===  'OK' ));
	    }
	    return  of(false);
    }

and pass to Template:

1<ngx-file-picker [customValidator]="myCustomValidator"> </ngx-file-picker>

Check Demo

Cropper

Library uses cropperjs to crop images but you need import it to use it. Example: in index html

1<script
2  src="https://cdnjs.cloudflare.com/ajax/libs/cropperjs/1.4.3/cropper.min.js"
3  async
4></script>
5<link
6  rel="stylesheet"
7  href="https://cdnjs.cloudflare.com/ajax/libs/cropperjs/1.4.3/cropper.css"
8/>

Note: To use cropper, you should set enableCropper to true. Look at API section above. You can also provide your custom cropper options.

Custom-Template

You can provide custom template to library.

I) To provide custom template for drag and drop zone, use content projection. Example:

1<ngx-file-picker [adapter]="adapter">
2  <div class="dropzoneTemplate">
3    <button>Custom</button>
4  </div>
5</ngx-file-picker>

Note: The wrapper of your custom template must have a class dropzoneTemplate.

Checkout Demo

II) To use custom file preview template, pass your custom template as below:

1<ngx-file-picker #uploader [adapter]="adapter" [itemTemplate]="itemTemplate">
2</ngx-file-picker>
3
4<ng-template
5  #itemTemplate
6  let-fileItem="fileItem"
7  let-uploadProgress="uploadProgress"
8>
9  <p>{{fileItem.file.size}}</p>
10  <p>{{fileItem.fileName}}</p>
11  <p *ngIf="uploadProgress < 100">{{uploadProgress}}%</p>
12  <button (click)="uploader.removeFile(fileItem)">Remove</button>
13</ng-template>

In custom template uploadProgress and fileItem (which implements FilePrevieModel interface) are exposed .

Multi Language

You can add multi language support for library by providing captions object (which implements UploaderCaptions interface).

Check Demo

Bonus

You can also check out library router animations

Contribution

You can fork project from github. Pull requests are kindly accepted.

Building library: ng build file-picker
Running tests: ng test file-picker
Run demo: ng serve

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

146 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-c75v-2vq8-878f
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-j4f2-536g-r55m
Warn: Project is vulnerable to: GHSA-r7qp-cfhv-p84w
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-pc5p-h8pf-mvwp
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-jg8v-48h5-wgxg
Warn: Project is vulnerable to: GHSA-36fh-84j7-cv5h
Warn: Project is vulnerable to: GHSA-7x7c-qm48-pq9c
Warn: Project is vulnerable to: GHSA-rc3x-jf5g-xvc5
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-82v2-mx6x-wq7q
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9
Warn: Project is vulnerable to: GHSA-qm28-7hqv-wg5j
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-jmqm-f2gx-4fjv
Warn: Project is vulnerable to: GHSA-6fx8-h7jm-663j
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-fxwf-4rqh-v8g3
Warn: Project is vulnerable to: GHSA-25hc-qcg6-38wj
Warn: Project is vulnerable to: GHSA-xfhh-g9f5-x4m4
Warn: Project is vulnerable to: GHSA-qm95-pgcg-qqfq
Warn: Project is vulnerable to: GHSA-cqmj-92xf-r6r9
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-884p-74jh-xrg2
Warn: Project is vulnerable to: GHSA-j7fq-p9q7-5wfv
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-mgfv-m47x-4wqp
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4fc4-chg7-h8gh
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Warn: Project is vulnerable to: GHSA-72mh-269x-7mh5
Warn: Project is vulnerable to: GHSA-h4j5-c7cj-74xg
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.3

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More