uppy/packages/@uppy/react
Renée Kooi b03c5af053
react: add useUppy() hook (#2666)
* react: add useUppy() hook

* add test

* docs: replace useRef/useEffect recommendation with useUppy()

* fix typo
2020-12-18 21:11:11 +00:00
..
src react: add useUppy() hook (#2666) 2020-12-18 21:11:11 +00:00
types react: add useUppy() hook (#2666) 2020-12-18 21:11:11 +00:00
index.js react: add useUppy() hook (#2666) 2020-12-18 21:11:11 +00:00
index.mjs react: add useUppy() hook (#2666) 2020-12-18 21:11:11 +00:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Release 2020-12-11 21:17:27 +01:00
README.md Remove the --save flag (#2503) 2020-09-04 14:32:21 +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

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.