New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

uppy

Package Overview
Dependencies
Maintainers
4
Versions
282
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

uppy

Almost as cute as a Puppy :dog:

  • 0.10.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
18K
decreased by-3.96%
Maintainers
4
Weekly downloads
 
Created
Source

Uppy

Uppy logo — a superman puppy in a pink suit

Build Status

Uppy is (going to be) a cool JavaScript file uploader that fetches files for you from local disk, Google Drive, Dropbox, Instagram, remote URLs, cameras and other exciting locations, and then uploads them to wherever you want. Uppy is being developed by the Transloadit team because we want file uploading experience to be better — both for users and developers.

Check out uppy.io for docs, API, examples and stats.

Features (some in development)

  • Lightweight / easy on dependencies
  • Usable as a bundle straight from a CDN as well as a module to import
  • Resumable file uploads via the open tus standard
  • Uppy speaks multiple languages (i18n support)
  • Built with accessibility in mind
  • Works great with file encoding and processing backends, such as Transloadit
  • Small core, modular plugin-based architecture
  • Cute as a puppy :dog:, also accepts cat pictures

Demo

Uppy UI Demo: modal dialog with a few selected files and an upload button

Usage

:warning: Don’t use Uppy in production just yet, we’re working on it

Installing from NPM

It’s easy to start using Uppy, we recommend installing from npm:

npm install uppy --save

and then use a bundler like Browserify or Webpack:

// ES6
import { Core, DragDrop, Tus10 } from 'uppy'

const uppy = new Core({wait: false})
const files = uppy
  .use(DragDrop, {target: 'body'})
  .use(Tus10, {endpoint: 'http://master.tus.io:8080/files/'})
  .run()

or

// ES5
// warning: bundling with `require` will currently include the whole Uppy package, with all plugins.
// If you want to pick and choose, use `import`)
var Uppy = require('uppy')

var uppy = new Uppy.Core({wait: false})
var files = uppy
  .use(Uppy.DragDrop, {target: 'body'})
  .use(Uppy.Tus10, {endpoint: 'http://master.tus.io:8080/files/'})
  .run()

Add CSS uppy.min.css, either to head of your HTML or include in JS, if your bundler of choice supports it — transforms and plugins are available for Browserify and Webpack.

Give it a spin on RequireBin: http://requirebin.com/?gist=54e076cccc929cc567cb0aba38815105

Installing from CDN

But if you like, you can also use a pre-built bundle, for example from unpkg CDN. In that case Uppy will attach itself to the global window object.

1. Add a script to your the bottom of your HTML’s <body>:

<script src="https://unpkg.com/uppy/dist/uppy.min.js"></script>

2. Add CSS to your HTML’s <head>:

<link href="https://unpkg.com/uppy/dist/uppy.min.css" rel="stylesheet">

3. Initialize:

<script>
  var uppy = new Uppy.Core({locales: Uppy.locales.ru_RU, debug: true})
  uppy.use(Uppy.DragDrop, {target: '.UppyDragDrop'})
  uppy.use(Uppy.Tus10, {endpoint: 'http://master.tus.io:3020/files/'})
  uppy.run()
</script>

API

Uppy exposes events that you can subscribe to in your app:

Event core:upload-progress when file upload progress is available

uppy.on('core:upload-progress', (data) => {
  console.log(data.id, data.bytesUploaded, data.bytesTotal)
})

Event core:upload-success when one upload is complete

uppy.on('core:upload-success', (fileId, url) => {
  console.log(url)
  var img = new Image()
  img.width = 300
  img.alt = fileId
  img.src = url
  document.body.appendChild(img)
})

Event core:success when all uploads are complete

uppy.on('core:success', (fileCount) => {
  console.log(fileCount)
})

Browser Support

Sauce Test Status

Note: we aim to support IE10+ and recent versions of Safari, Edge, Chrome, Firefox and Opera. IE6 on the chart above means we recommend setting Uppy to target a <form> element, so when Uppy has not yet loaded or is not supported, upload still works. Even on the refrigerator browser. Or, yes, IE6.

FAQ

React support?

Yep. It’s in the works.

Contributions are welcome

License

The MIT License.

FAQs

Package last updated on 18 Oct 2016

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc