uppy/packages/@uppy/url/README.md
Antoine du Hamel 6f9813d9b2
doc: update bundler recommendation (#3763)
With the switch to ESM, Browserify will no longer work with Uppy.
Instead, let's recommend bundlers that we actually test with.
2022-05-23 19:41:37 +02:00

1.6 KiB
Raw Blame History

@uppy/url

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

The Url plugin lets users import files from the Internet. Paste any URL and itll be added!

A Companion instance is required for the Url plugin to work. Companion will download the files and upload them to their destination. This saves bandwidth for the user (especially on mobile connections) and helps avoid CORS restrictions.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import Url from '@uppy/url'

const uppy = new Uppy()
uppy.use(Url, {
  // Options
})

Installation

$ npm install @uppy/url

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.