mirror of
https://github.com/transloadit/uppy.git
synced 2026-07-29 04:50:05 +00:00
7d6937300a
* meta: enable prettier for markdown * Ignore changelogs * revert CHANGELOG changes * More formatting --------- Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# @uppy/box
|
||
|
||
<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">
|
||
|
||
[](https://www.npmjs.com/package/@uppy/box)
|
||
|
||
|
||
|
||
|
||
The Box plugin for Uppy lets users import files from their Box account.
|
||
|
||
A Companion instance is required for the Box plugin to work. Companion handles
|
||
authentication with Box, downloads files from Box and uploads them to the
|
||
destination. This saves the user bandwidth, especially helpful if they are on a
|
||
mobile connection.
|
||
|
||
Uppy is being developed by the folks at [Transloadit](https://transloadit.com),
|
||
a versatile file encoding service.
|
||
|
||
## Example
|
||
|
||
```js
|
||
import Uppy from '@uppy/core'
|
||
import Box from '@uppy/box'
|
||
|
||
const uppy = new Uppy()
|
||
uppy.use(Box, {
|
||
// Options
|
||
})
|
||
```
|
||
|
||
## Installation
|
||
|
||
```bash
|
||
$ npm install @uppy/box
|
||
```
|
||
|
||
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/box).
|
||
|
||
## License
|
||
|
||
[The MIT License](./LICENSE).
|