uppy/packages/@uppy/box
Evgenia Karunus b7b65b9aeb
PartialTree - get rid of .onFirstRender() (#5187)
everywhere - get rid of `.onFirstRender()`
2024-05-30 06:06:21 +04:00
..
src PartialTree - get rid of .onFirstRender() (#5187) 2024-05-30 06:06:21 +04:00
.npmignore @uppy/box: refactor to TypeScript (#4979) 2024-03-10 11:22:34 +01:00
CHANGELOG.md Release: uppy@4.0.0-beta.1 (#5047) 2024-03-28 14:00:30 +00:00
LICENSE companion,box: Box provider implementation (#2549) 2020-11-13 15:37:00 +01:00
package.json Release: uppy@4.0.0-beta.5 (#5141) 2024-05-03 12:58:13 +00:00
README.md meta: enable prettier for markdown (#5133) 2024-05-02 11:35:55 +02:00
tsconfig.build.json @uppy/box: refactor to TypeScript (#4979) 2024-03-10 11:22:34 +01:00
tsconfig.json @uppy/box: refactor to TypeScript (#4979) 2024-03-10 11:22:34 +01:00

@uppy/box

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

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, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import Box from '@uppy/box'

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

Installation

$ npm install @uppy/box

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.