现代化的上传组件。 https://uppy.io/

Renée Kooi dd383c79bf build: Add common-shakeify and browser-pack-flat for dist files. преди 7 години
assets 459f1aa191 .. преди 7 години
bin dd383c79bf build: Add common-shakeify and browser-pack-flat for dist files. преди 7 години
examples 9af6b2fea6 Merge pull request #170 from goto-bus-stop/feature/react преди 7 години
src e8ea5b2e21 Merge pull request #363 from goto-bus-stop/feature/setpluginstate преди 7 години
test 540c02b6b0 Add jest tests преди 7 години
website dd0d51b881 docs: link to react docs from readme & docs/index.md преди 7 години
.babelrc 246862c408 build: Use `babel-preset-es2015` with options. преди 8 години
.browsersync.js b988ef776d Decide on single-noun terminology преди 9 години
.editorconfig d257f8ff52 Add tests and eslint преди 9 години
.eslintignore c4e76e0522 inline file-type module, as opposed to using the NPM version преди 7 години
.eslintrc 540c02b6b0 Add jest tests преди 7 години
.gitignore 540c02b6b0 Add jest tests преди 7 години
.travis.yml 143068830d Bump node version to `6.11.3` for Travis builds преди 7 години
CHANGELOG.md 59b848838c Update CHANGELOG.md преди 7 години
CONTRIBUTING.md 0a1b99cb4b CONTRIBUTING.MD: fixed guide link преди 9 години
LICENSE 320c8a16ef Getting a sandbox going with the worst possible layout преди 9 години
Makefile ca28f5fbe6 fix npm install command преди 8 години
README.md dd0d51b881 docs: link to react docs from readme & docs/index.md преди 7 години
env.example.sh 36aca95a88 Marrying travis & sauce (#88) преди 9 години
package-lock.json dd383c79bf build: Add common-shakeify and browser-pack-flat for dist files. преди 7 години
package.json dd383c79bf build: Add common-shakeify and browser-pack-flat for dist files. преди 7 години
uppy-screenshot.jpg 925614c9b1 update screenshot again преди 8 години

README.md

Uppy

Build Status

Uppy is a sleek, modular file uploader that integrates seemlessly with any application. It’s fast, easy to use and lets you worry about more important problems than building a file uploader.

  • Fetch files from local disk, Google Drive, Dropbox, Instagram, or snap and record selfies with a camera;
  • Preview and edit metadata with a nice interface;
  • Upload to the final destination, optionally processing/encoding on the way;

Try Uppy | Read the docs

Uppy is being developed by the Transloadit team.

Features

  • Lightweight, modular plugin-based architecture, easy on dependencies :zap:
  • Resumable file uploads via the open tus standard
  • Supports picking files from: Webcam, Dropbox, Google Drive, Instagram, bypassing the user’s device where possible, syncing between servers directly via uppy-server
  • Works great with file encoding and processing backends, such as Transloadit, works great without (just roll your own Apache/Nginx/Node/etc backend)
  • Sleek user interface :sparkles:
  • Optional file recovering (after a browser crash) with Golden Retriever
  • Speaks multiple languages (i18n) :earth_africa:
  • Built with accessibility in mind
  • Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
  • Cute as a puppy, also accepts cat pictures :dog:

Installation

$ npm install uppy

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

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

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.Uppy object.

⚠️ The bundle currently consists of most Uppy plugins, so this method is not recommended for production, as your users will have to download all plugins, even if you are using just a few.

1. Add a script to the bottom of <body>:

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

2. Add CSS to <head>:

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

3. Initialize:

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

Documentation

  • Uppy — full list of options, methods and events.
  • Plugins — list of Uppy plugins and their options.
  • Server — setting up and running an Uppy Server instance, which adds support for Instagram, Dropbox, Google Drive and other remote sources.
  • React — components to integrate uppy UI plugins with react apps.
  • Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].

Plugins

  • Tus — resumable uploads via tus.io open standard
  • XHRUpload — regular uploads for any backend out there
  • Transloadit — support for Transloadit’s robust file encoding and processing backend
  • Dashboard — universal UI with previews, progress bars, metadata editor and all the cool stuff
  • DragDrop — plain and simple drag and drop area
  • FileInput — even more plain “select files” button
  • ProgressBar — minimal progress bar that fills itself when upload progresses
  • StatusBar — more detailed progress, pause/resume/cancel buttons, percentage, speed, uploaded/total sizes (included by default with Dashboard)
  • Informer — send notifications like “smile” before taking a selfie or “upload failed” when all is lost (also included by default with Dashboard)
  • RestoreFiles — restores files after a browser crash, like it’s nothing
  • GoogleDrive — select files from Google Drive
  • Dropbox — select files from Dropbox
  • Instagram — you guessed right — select files from Instagram
  • Webcam — snap and record those selfies 📷

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. Uppy-React component is in the works, in the meantime you can just use it as any other lib with React, see here.

Can I use it with Rails/Node/Go/PHP?

Yes, whatever you want on the backend will work with XHRUpload plugin, since it just does a POST or PUT request. If you want resumability, use one of tus implementations 👌🏼

Do I need to install special service/server for it?

No, as mentioned previously, XHRUpload plugin is old-school and just works with everything. However, you need uppy-server if you’d like your users to be able to pick files from Google Drive or Dropbox (more services coming). And you can add tus if you want resumability.

Does Uppy support S3 uploads?

Yes, since 0.18, there is an S3 plugin. Check out the docs for more information.

Contributions are welcome

License

The MIT License.