mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-22 09:48:06 +00:00
6f9813d9b2
With the switch to ESM, Browserify will no longer work with Uppy. Instead, let's recommend bundlers that we actually test with.
55 lines
1.7 KiB
Markdown
55 lines
1.7 KiB
Markdown
# @uppy/react
|
||
|
||
<img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
||
|
||
[](https://www.npmjs.com/package/@uppy/react)
|
||
|
||
|
||
|
||
|
||
React component wrappers around Uppy’s officially maintained UI plugins.
|
||
|
||
Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
||
|
||
## Example
|
||
|
||
<!-- eslint-disable react/state-in-constructor -->
|
||
|
||
```js
|
||
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
|
||
|
||
```bash
|
||
$ 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](https://uppy.io/docs/#Installation) for instructions.
|
||
|
||
## Documentation
|
||
|
||
Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/react).
|
||
|
||
## License
|
||
|
||
[The MIT License](./LICENSE).
|