github-actions[bot] 960362b373 Release: uppy@3.24.0 (#5040) 1 year ago
..
src e46db4042a fixup! fix type imports (#5038) 1 year ago
types 34c78e9093 meta: run Prettier on existing files (#4713) 1 year ago
.npmignore c8f1af8d12 @uppy/box: refactor to TypeScript (#4979) 1 year ago
CHANGELOG.md 960362b373 Release: uppy@3.24.0 (#5040) 1 year ago
LICENSE 970ac8df5b companion,box: Box provider implementation (#2549) 4 years ago
README.md 7adacb74a7 meta: Fix logos in all the readmes (#4407) 2 years ago
package.json 960362b373 Release: uppy@3.24.0 (#5040) 1 year ago
tsconfig.build.json c8f1af8d12 @uppy/box: refactor to TypeScript (#4979) 1 year ago
tsconfig.json c8f1af8d12 @uppy/box: refactor to TypeScript (#4979) 1 year ago

README.md

@uppy/box

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 Transloadit’s 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.