mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-20 16:53:33 +00:00
c48064ba56
* doc: lint JS code snippets * deps: update `lint-staged` deps * Fix remaining lint warnings and errors Co-authored-by: Artur Paikin <artur@arturpaikin.com>
54 lines
1.9 KiB
Markdown
54 lines
1.9 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">
|
|
|
|
<a href="https://www.npmjs.com/package/@uppy/react"><img src="https://img.shields.io/npm/v/@uppy/react.svg?style=flat-square"></a>
|
|
<img src="https://github.com/transloadit/uppy/workflows/Tests/badge.svg" alt="CI status for Uppy tests"> <img src="https://github.com/transloadit/uppy/workflows/Companion/badge.svg" alt="CI status for Companion tests"> <img src="https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg" alt="CI status for browser tests">
|
|
|
|
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
|
|
```
|
|
|
|
We recommend installing from npm and then using a module bundler such as [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Rollup.js](http://rollupjs.org/).
|
|
|
|
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).
|