mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-28 12:37:00 +00:00
42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
# @uppy/url
|
||
|
||
<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/url"><img src="https://img.shields.io/npm/v/@uppy/url.svg?style=flat-square"></a>
|
||
<a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
|
||
|
||
The Url plugin lets users import files from the Internet. Paste any URL and it’ll 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](https://transloadit.com), a versatile file encoding service.
|
||
|
||
## Example
|
||
|
||
```js
|
||
const Uppy = require('@uppy/core')
|
||
const Url = require('@uppy/url')
|
||
|
||
const uppy = Uppy()
|
||
uppy.use(Url, {
|
||
// Options
|
||
})
|
||
```
|
||
|
||
## Installation
|
||
|
||
```bash
|
||
$ npm install @uppy/url --save
|
||
```
|
||
|
||
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/url).
|
||
|
||
## License
|
||
|
||
[The MIT License](./LICENSE).
|