npmpackage.info

qpix-react-dropzone-s3-uploader

Drag and drop s3 file uploader via react-dropzone + react-s3-uploader

1.2.3

MIT

JavaScript

8.16 kB

2,880 1.7

Installations

npm install qpix-react-dropzone-s3-uploader

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

9.10.1

NPM Version

5.6.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

JavaScript

JavaScript (100%)

Developer

george-maged

Download Statistics

Total Downloads

2,880

Last Day

Last Week

Last Month

Last Year

241

GitHub Statistics

150 Commits

2 Watching

2 Branches

1 Contributors

Bundle Size

26.05 kB

Minified

8.16 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.2.3

Package Id

qpix-react-dropzone-s3-uploader@1.2.3

Unpacked Size

26.76 kB

Size

7.91 kB

File Count

NPM Version

5.6.0

Node Version

9.10.1

Total Downloads

Cumulative downloads

Total Downloads

2,880

Last day

Compared to previous day

Last week

20%

Compared to previous week

Last month

3,800%

Compared to previous month

Last year

-19.1%

241

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

prop-types react-dropzone react-s3-uploader

Dev Dependencies

babel babel-core babel-eslint eslint eslint-config-founderlab eslint-plugin-react expect

Versions

Drag and drop s3 file uploader for React

This component uploads files dropped into react-dropzone to s3 with react-s3-uploader.

For more detailed docs see the source packages

Usage (client)

Available props

s3Url and upload are the only props that require configuration. All others have sensible defaults that may be overridden.

Prop	Type	Description
s3Url	string.isRequired	The url of your s3 bucket (`https://my-bucket.s3.amazonaws.com`)
upload	object.isRequired	Upload options passed to react-s3-uploader. See react-s3-uploader for available options. Don't set `onProgress`, `onError` or `onFinish` here - use the ones below
filename	string	Used as the default value if present. Filename of an image already hosted on s3 (i.e. one that was uploaded previously)
notDropzoneProps	array	A list of props to not pass to `react-dropzone`
isImage	func	A function that takes a filename and returns true if it's an image
imageComponent	func	Component used to render an uploaded image
fileComponent	func	Component used to render an uploaded file
progressComponent	func	Component used to render upload progress
errorComponent	func	Component used to render an error
children	node \|\| func	If present the above components will be ignored in favour of the children
passChildrenProps	bool	If true we pass the current state to children of this component. Default is true. Set to false to avoid React warnings about unused props.
onDrop	func	Called when a file is dropped onto the uploader
onError	func	Called when an upload error occurs
onProgress	func	Called when a chunk has been uploaded
onFinish	func	Called when a file has completed uploading. Called once per file if multi=true
...rest		All other props are passed on to the `react-dropzone` component

Example

1import DropzoneS3Uploader from 'react-dropzone-s3-uploader'
2
3export default class S3Uploader extends React.Component {
4
5  handleFinishedUpload = info => {
6    console.log('File uploaded with filename', info.filename)
7    console.log('Access it on s3 at', info.fileUrl)
8  }
9
10  render() {
11    const uploadOptions = {
12      server: 'http://localhost:4000',
13      signingUrlQueryParams: {uploadType: 'avatar'},
14    }
15    const s3Url = 'https://my-bucket.s3.amazonaws.com'
16
17    return (
18      <DropzoneS3Uploader
19        onFinish={this.handleFinishedUpload}
20        s3Url={s3Url}
21        maxSize={1024 * 1024 * 5}
22        upload={uploadOptions}
23      />
24    )
25  }
26}

Custom display component

Specify your own component to display uploaded files. Passed a list of uploadedFile objects.

1
2// elsewhere
3class UploadDisplay extends React.Component {
4  
5  renderFileUpload = (uploadedFile, i) => {
6    const {
7      filename,   // s3 filename
8      fileUrl,    // full s3 url of the file
9      file,       // file descriptor from the upload
10    } = uploadedFile
11
12    return (
13      <div key={i}>
14        <img src={fileUrl} />
15        <p>{file.name}</p>
16      </div>
17    )
18  }
19
20  render() {
21    const {uploadedFiles, s3Url} = this.props
22    return (
23      <div> 
24        {uploadedFiles.map(this.renderFileUpload)}
25      </div>
26    )
27  }
28}
29
30// back in your uploader...
31class S3Uploader extends React.Component {
32
33  //...
34
35  render() {
36    return (
37      <DropzoneS3Uploader 
38        onFinish={this.handleFinishedUpload} 
39        upload={uploadOptions}
40      >
41        <UploadDisplay />
42      </DropzoneS3Uploader>
43    )
44  }
45}

Usage (server)

Use s3Router from react-s3-uploader to get signed urls for uploads.
react-dropzone-s3-uploader/s3router can be used as an alias for react-s3-uploader/s3router.
See react-s3-uploader for more details.

1app.use('/s3', require('react-dropzone-s3-uploader/s3router')({
2  bucket: 'MyS3Bucket',                           // required
3  region: 'us-east-1',                            // optional
4  headers: {'Access-Control-Allow-Origin': '*'},  // optional
5  ACL: 'private',                                 // this is the default - set to `public-read` to let anyone view uploads
6}));

No vulnerabilities found.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

0

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

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

57 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-rrc9-gqf8-8rwg
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-c6rq-rjc2-86v2
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
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-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
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-2m96-9w4j-wgv7
Warn: Project is vulnerable to: GHSA-h726-x36v-rx45
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5
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-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
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-662x-fhqg-9p8v
Warn: Project is vulnerable to: GHSA-394c-5j6w-4xmx
Warn: Project is vulnerable to: GHSA-78cj-fxph-m83p
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

1.7

/10

Last Scanned on 2025-01-27

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