uppy/packages/@uppy/react
Merlijn Vos 7d6937300a
meta: enable prettier for markdown (#5133)
* meta: enable prettier for markdown

* Ignore changelogs

* revert CHANGELOG changes

* More formatting

---------

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-05-02 11:35:55 +02:00
..
src Remove JSX global type everywhere (#5117) 2024-04-25 16:20:28 +02:00
types meta: enforce use of .js extension in import type declarations (#5126) 2024-04-29 16:23:28 +02:00
.npmignore @uppy/react: refactor to TS (#5012) 2024-03-27 11:03:34 +01:00
CHANGELOG.md Release: uppy@3.24.0 (#5040) 2024-03-27 14:57:26 +00:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Release: uppy@3.25.0 (#5127) 2024-04-29 14:35:21 +00:00
README.md meta: enable prettier for markdown (#5133) 2024-05-02 11:35:55 +02:00
tsconfig.build.json @uppy/react: refactor to TS (#5012) 2024-03-27 11:03:34 +01:00
tsconfig.json @uppy/react: refactor to TS (#5012) 2024-03-27 11:03:34 +01:00

@uppy/react

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

React component wrappers around Uppys 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 Transloadits 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.