uppy/packages/@uppy/react
Andy Chong 59bfaf0d20
react/drag-drop: add a type test and document shared props (#2003)
* Update react-dragdrop.md

DragDrop component only accept `uppy` and `locale` props according to the type declared.
```
import { Uppy, Locale } from './CommonTypes';

export interface DragDropProps {
  uppy: Uppy;
  locale?: Locale;
}

/**
 * React component that renders an area in which files can be dropped to be
 * uploaded.
 */
declare const DragDrop: React.ComponentType<DragDropProps>;
export default DragDrop;```

* drag-drop: accept a number for width/height

* docs: add back dragdrop props

* docs: use the same option style as previously [skip ci]

Co-authored-by: Renée Kooi <renee@kooi.me>
2020-02-24 15:13:01 +01:00
..
src Actually check types (#1918) 2020-02-12 16:22:09 +01:00
types react/drag-drop: add a type test and document shared props (#2003) 2020-02-24 15:13:01 +01:00
index.js Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
index.mjs Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Release 2020-02-14 23:17:48 +01:00
README.md docs: update webpack homepage URLs 2019-03-04 13:43:37 +01:00

@uppy/react

Uppy logo: a superman puppy in a pink suit

Build Status

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

const Uppy = require('@uppy/core')
const { DashboardModal } = require('@uppy/react')

const uppy = 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 --save

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.