ifedapoolarewaju fa32da7cf3 Release 5 years ago
..
src ab3d7cb067 react: fix typescript proptypes for DashboardModal, fixes #2124 (#2136) 5 years ago
types ab3d7cb067 react: fix typescript proptypes for DashboardModal, fixes #2124 (#2136) 5 years ago
LICENSE c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
README.md fd6734be4d docs: update webpack homepage URLs 6 years ago
index.js c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
index.mjs c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
package.json fa32da7cf3 Release 5 years ago

README.md

@uppy/react

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.