uppy/packages/@uppy/react
Antoine du Hamel 56c86e2f18
doc: use ESM syntax in code snippets (#2953)
In preparation for a future release of Uppy which drop support for
CommonJS, we should start nudging our users to use ESM syntax.

Fixes: https://github.com/transloadit/uppy/issues/2951
2021-06-22 10:30:24 +02:00
..
src Split Plugin into BasePlugin and extended UIPlugin (#2944) 2021-06-18 13:23:16 +02:00
types Added FileInput component to React (#2706) 2020-12-18 21:21:12 +00:00
index.js Added FileInput component to React (#2706) 2020-12-18 21:21:12 +00:00
index.mjs Added FileInput component to React (#2706) 2020-12-18 21:21:12 +00:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Release 2021-05-28 11:54:17 +01:00
README.md doc: use ESM syntax in code snippets (#2953) 2021-06-22 10:30:24 +02:00

@uppy/react

Uppy logo: a superman puppy in a pink suit

CI status for Uppy tests CI status for Companion tests CI status for browser tests

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

import Uppy from '@uppy/core'
import { DashboardModal } from '@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.