Installations
npm install rc-uploadDeveloper
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
20.17.0
NPM Version
10.8.2
Statistics
785 Stars
412 Commits
320 Forks
32 Watching
17 Branches
77 Contributors
Updated on 12 Nov 2024
Bundle Size
22.99 kB
Minified
8.17 kB
Minified + Gzipped
Languages
TypeScript (96.64%)
JavaScript (3.36%)
Total Downloads
Cumulative downloads
Total Downloads
211,375,078
Last day
-5.8%
274,346
Compared to previous day
Last week
3.3%
1,447,729
Compared to previous week
Last month
9.6%
6,002,630
Compared to previous month
Last year
27.7%
61,621,942
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
rc-upload
React Upload
Development
npm install
npm start
Example
online example: https://upload.react-component.vercel.app/
Feature
- support IE11+, Chrome, Firefox, Safari
install
Usage
1var Upload = require('rc-upload'); 2var React = require('react'); 3React.render(<Upload />, container);
API
props
| name | type | default | description |
|---|---|---|---|
| name | string | file | file param post to server |
| style | object | {} | root component inline style |
| className | string | - | root component className |
| disabled | boolean | false | whether disabled |
| component | "div" | "span" | "span" |
| action | string | function(file): string | Promise<string> | form action url | |
| method | string | post | request method |
| directory | boolean | false | support upload whole directory |
| data | object/function(file) | other data object to post or a function which returns a data object(a promise object which resolve a data object) | |
| headers | object | {} | http headers to post, available in modern browsers |
| accept | string | input accept attribute | |
| capture | string | input capture attribute | |
| multiple | boolean | false | only support ie10+ |
| onStart | function | start upload file | |
| onError | function | error callback | |
| onSuccess | function | success callback | |
| onProgress | function | progress callback, only for modern browsers | |
| beforeUpload | function | null | before upload check, return false or a rejected Promise will stop upload, only for modern browsers |
| customRequest | function | null | provide an override for the default xhr behavior for additional customization |
| withCredentials | boolean | false | ajax upload with cookie send |
| openFileDialogOnClick | boolean | true | useful for drag only upload as it does not trigger on enter key or click event |
onError arguments
err: request error messageresponse: request response, not support on iframeUploadfile: upload file
onSuccess arguments
result: response bodyfile: upload filexhr: xhr header, only for modern browsers which support AJAX upload. since 2.4.0
customRequest
Allows for advanced customization by overriding default behavior in AjaxUploader. Provide your own XMLHttpRequest calls to interface with custom backend processes or interact with AWS S3 service through the aws-sdk-js package.
customRequest callback is passed an object with:
onProgress: (event: { percent: number }): voidonError: (event: Error, body?: Object): voidonSuccess: (body: Object): voiddata: Objectfilename: Stringfile: FilewithCredentials: Booleanaction: Stringheaders: Object
methods
abort(file?: File) => void: abort the uploading file
License
rc-upload is released under the MIT license.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
8 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 6
Reason
Found 10/22 approved changesets -- score normalized to 4
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/react-component-ci.yml:1
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 20 are checked with a SAST tool
Score
4.7
/10
Last Scanned on 2024-11-18
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