Merlijn Vos f01538ba41 Resolve all type `TODO`'s (#2963) 3 years ago
..
src f01538ba41 Resolve all type `TODO`'s (#2963) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
index.js 80b5ace47d Added FileInput component to React (#2706) 4 years ago
index.mjs 80b5ace47d Added FileInput component to React (#2706) 4 years ago
package.json a8003c873e core: force `new` keyword (#2949) 3 years ago

README.md

@uppy/react

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