github-actions[bot] 74f3d4d5de Release: uppy@2.10.0 (#3727) 2 years ago
..
src 934ba79f00 core: wrap plugins in div.uppy-Root and set dir attrubute in UIPlugin (#3692) 3 years ago
types 2ce0c8b4dc Fix React `DashboardModal`'s `target` type (#3110) 3 years ago
CHANGELOG.md 74f3d4d5de Release: uppy@2.10.0 (#3727) 2 years ago
LICENSE c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
README.md 55e0ffd04a Add retext to markdown linter (#3024) 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 74f3d4d5de Release: uppy@2.10.0 (#3727) 2 years ago

README.md

@uppy/react

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