github-actions[bot] cc103ce5c9 Release: uppy@4.0.0-beta.5 (#5141) 11 months ago
..
src 82a5999260 Merge branch 'main' into 4.x 1 year ago
types b8f8f8a9dd Release: uppy@4.0.0-beta.4 (#5130) 1 year ago
.npmignore 462e8c61bd @uppy/react: refactor to TS (#5012) 1 year ago
CHANGELOG.md b8f8f8a9dd Release: uppy@4.0.0-beta.4 (#5130) 1 year ago
LICENSE c9b266ade1 Move React components to `@uppy/react` package. 6 years ago
README.md 7d6937300a meta: enable prettier for markdown (#5133) 1 year ago
package.json cc103ce5c9 Release: uppy@4.0.0-beta.5 (#5141) 11 months ago
tsconfig.build.json 915a563da9 @uppy/react: remove `useUppy` & reintroduce `useUppyState` (#5059) 1 year ago
tsconfig.json 915a563da9 @uppy/react: remove `useUppy` & reintroduce `useUppyState` (#5059) 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.