uppy/packages/@uppy/react
Mikael Finstad 8ed210545c
proposal: Cancel assemblies optional (#3575)
* change cancel logic

to make canceling assemblies optional
possibly fixes #3547

* add forgotten file

* rewrite to reason='user'

* try to fix crash

* change reason to unmount

* Apply suggestions from code review

* add close+unmount in more code examples

also fix rule of hooks issue

* improve reason docs

* add tests

* add options also to reset

* update doc

* also prevent canceling uploads on unmount

* Update website/src/docs/transloadit.md

Co-authored-by: Merlijn Vos <merlijn@soverin.net>

* remove conflicting file

Co-authored-by: Merlijn Vos <merlijn@soverin.net>
2022-05-06 01:53:46 +07:00
..
src proposal: Cancel assemblies optional (#3575) 2022-05-06 01:53:46 +07:00
types Fix React DashboardModal's target type (#3110) 2021-08-30 15:01:15 +02:00
index.js Added FileInput component to React (#2706) 2020-12-18 21:21:12 +00:00
index.mjs Added FileInput component to React (#2706) 2020-12-18 21:21:12 +00:00
LICENSE Move React components to @uppy/react package. 2018-06-18 10:14:08 +02:00
package.json Support React 18 in @uppy/react (#3680) 2022-05-04 17:38:08 +02:00
README.md Add retext to markdown linter (#3024) 2021-10-14 16:10:45 +02:00

@uppy/react

Uppy logo: a superman puppy in a pink suit

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

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 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.