uppy/packages/@uppy/react
Artur Paikin 4684a3e1f3
Merge pull request #924 from transloadit/export-plugin
Export Plugin class from @uppy/core.
2018-06-28 09:43:43 -04:00
..
src Export Plugin class from @uppy/core. 2018-06-28 12:20:21 +02:00
types Move React components to @uppy/react package. 2018-06-18 10:14:08 +02: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 Fix version numbers 2018-06-28 15:41:15 +02:00
README.md Move React components to @uppy/react package. 2018-06-18 10:14:08 +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 = 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.