Kevin van Zonneveld 764c2ccada Update Linter (#2796) 4 years ago
..
src 764c2ccada Update Linter (#2796) 4 years ago
types 970ac8df5b companion,box: Box provider implementation (#2549) 4 years ago
LICENSE 970ac8df5b companion,box: Box provider implementation (#2549) 4 years ago
README.md c81780230d Add all the CI badges (#2725) 4 years ago
package.json 4bf1072363 Release 4 years ago

README.md

@uppy/box

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

const Uppy = require('@uppy/core')
const Box = require('@uppy/box')

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

Installation

$ npm install @uppy/box

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

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.