uppy/packages/@uppy/react
2021-10-27 17:53:11 +02:00
..
src @uppy/react: update HTMLAttributes filter (#3215) 2021-09-28 16:58:50 +02:00
types Fix React DashboardModal's target type (#3110) 2021-08-30 15:01:15 +02: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 meta: use workspace:^ instead of workspace:* (#3278) 2021-10-27 17:53:11 +02:00
README.md Add retext to markdown linter (#3024) 2021-10-14 16:10:45 +02:00

@uppy/react

Uppy logo: a superman puppy in a pink suit

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

React component wrappers around Uppys officially maintained UI plugins.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import React from 'react'
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 Transloadits 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.