github-actions[bot] 0f84390107 Release: uppy@3.25.0 (#5127) 1 year ago
..
src 57b5909611 Remove JSX global type everywhere (#5117) 1 year ago
types faceaf0da3 meta: enforce use of `.js` extension in `import type` declarations (#5126) 1 year ago
.npmignore 462e8c61bd @uppy/react: refactor to TS (#5012) 1 year ago
CHANGELOG.md 960362b373 Release: uppy@3.24.0 (#5040) 1 year ago
LICENSE c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
README.md 7adacb74a7 meta: Fix logos in all the readmes (#4407) 2 years ago
package.json 0f84390107 Release: uppy@3.25.0 (#5127) 1 year ago
tsconfig.build.json 462e8c61bd @uppy/react: refactor to TS (#5012) 1 year ago
tsconfig.json 462e8c61bd @uppy/react: refactor to TS (#5012) 1 year 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

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.