Merlijn Vos 00094af525 Refactor locale scripts & generate types and docs (#3276) 3 years ago
..
src 00094af525 Refactor locale scripts & generate types and docs (#3276) 3 years ago
types 472766e48b UIPlugin fix: prevent Preact replacing contents of body element by using createDocumentFragment (#3072) 3 years ago
LICENSE 970ac8df5b companion,box: Box provider implementation (#2549) 4 years ago
README.md 55e0ffd04a Add retext to markdown linter (#3024) 3 years ago
package.json f0a478d21a meta: use `workspace:^` in peerDependencies (#3278) 3 years 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

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.