uppy/packages/@uppy/react
Andrew Kachnic d7f8076fb3
Allowed HTML Attributes to be passed via props
This fix still needs some work, as certain attributes could be passed to Uppy or as an HTML attribute, such as target

When this is fixed, this will resolve #2403
2020-07-30 08:34:53 -04:00
..
src Allowed HTML Attributes to be passed via props 2020-07-30 08:34:53 -04:00
types react: fix typescript proptypes for DashboardModal, fixes #2124 (#2136) 2020-03-16 15:22:03 +01:00
index.js Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
index.mjs Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Release 2020-07-29 16:50:45 +02:00
README.md A few docs things (#2371) 2020-07-29 12:17:27 +02:00

@uppy/react

Uppy logo: a superman puppy in a pink suit

Build Status

React component wrappers around Uppy's officially maintained UI plugins.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

const Uppy = require('@uppy/core')
const { DashboardModal } = require('@uppy/react')

const uppy = new Uppy()

class Example extends React.Component {
  state = { open: false }
  render () {
    return (
      <DashboardModal
        uppy={uppy}
        open={this.state.open}
        onRequestClose={this.handleClose}
      />
    )
  }
  // ..snip..
}

Installation

$ npm install @uppy/react --save

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.