Socket
Socket
Sign inDemoInstall

rc-upload

Package Overview
Dependencies
10
Maintainers
5
Versions
133
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    rc-upload

upload ui component for react


Version published
Weekly downloads
964K
decreased by-11.43%
Maintainers
5
Install size
597 kB
Created
Weekly downloads
 

Readme

Source

rc-upload

React Upload

NPM version dumi build status Test coverage Dependencies DevDependencies npm download bundle size

Development

npm install
npm start

Example

http://localhost:8000/

online example: https://upload.react-component.vercel.app/

Feature

  • support IE11+, Chrome, Firefox, Safari

install

rc-upload

Usage

var Upload = require('rc-upload');
var React = require('react');
React.render(<Upload />, container);

API

props

nametypedefaultdescription
namestringfilefile param post to server
styleobject{}root component inline style
classNamestring-root component className
disabledbooleanfalsewhether disabled
component"div""span""span"
actionstring | function(file): string | Promise<string>form action url
methodstringpostrequest method
directorybooleanfalsesupport upload whole directory
dataobject/function(file)other data object to post or a function which returns a data object(a promise object which resolve a data object)
headersobject{}http headers to post, available in modern browsers
acceptstringinput accept attribute
capturestringinput capture attribute
multiplebooleanfalseonly support ie10+
onStartfunctionstart upload file
onErrorfunctionerror callback
onSuccessfunctionsuccess callback
onProgressfunctionprogress callback, only for modern browsers
beforeUploadfunctionnullbefore upload check, return false or a rejected Promise will stop upload, only for modern browsers
customRequestfunctionnullprovide an override for the default xhr behavior for additional customization
withCredentialsbooleanfalseajax upload with cookie send
openFileDialogOnClickbooleantrueuseful for drag only upload as it does not trigger on enter key or click event
onError arguments
  1. err: request error message
  2. response: request response, not support on iframeUpload
  3. file: upload file

onSuccess arguments

  1. result: response body
  2. file: upload file
  3. xhr: 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 }): void
  • onError: (event: Error, body?: Object): void
  • onSuccess: (body: Object): void
  • data: Object
  • filename: String
  • file: File
  • withCredentials: Boolean
  • action: String
  • headers: Object

methods

abort(file?: File) => void: abort the uploading file

License

rc-upload is released under the MIT license.

Keywords

FAQs

Last updated on 21 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc