uppy/packages/@uppy/react
ifedapoolarewaju 323233488f
Release
2020-04-15 20:07:42 +01:00
..
src react: fix typescript proptypes for DashboardModal, fixes #2124 (#2136) 2020-03-16 15:22:03 +01:00
types react: fix typescript proptypes for DashboardModal, fixes #2124 (#2136) 2020-03-16 15:22:03 +01:00
index.js
index.mjs
LICENSE
package.json Release 2020-04-15 20:07:42 +01:00
README.md

@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.