ホーム エクスプローラ ヘルプ
サインイン
biheng
/
uppy
1
0
フォーク 0
ファイル 課題 0 プルリクエスト 0 Wiki

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

ツリー: 73d25c2353
ブランチ タグ
uppy
Renée Kooi 73d25c2353 Include RestoreFiles in unpkg bundle. 7 年 前
assets 459f1aa191 .. 7 年 前
bin aac014abf6 raise limit 7 年 前
examples fbc66be79d clean up main.js example/dev file 7 年 前
src 73d25c2353 Include RestoreFiles in unpkg bundle. 7 年 前
test 5750efab90 transloadit: Add test for `alwaysRunAssembly` 7 年 前
website 5d36e25772 don’t include the codeblock, since we are inlining it 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 ae55424d1d Upgrade eslint & standard and fix linting accordingly 9 年 前
.gitignore c264d390f6 docs: non bundled example 7 年 前
.travis.yml f92db64f34 Set new bot token 8 年 前
ARCHITECTURE.md b3a2d84fb3 Update ARCHITECTURE.md 8 年 前
CHANGELOG.md 6991e8eaa8 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 a331a18131 readme: Fix references to Multipart plugin + add S3 doc url 7 年 前
SERVER-PLAN.md 0b23c26f82 Update SERVER-PLAN.md 9 年 前
UPPY-CALL.md caa792e6eb Agenda 8 年 前
env.example.sh 36aca95a88 Marrying travis & sauce (#88) 9 年 前
package-lock.json a77d3d405d Update namespace-emitter 7 年 前
package.json a77d3d405d Update namespace-emitter 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 framework. It fetches files from local disk, Google Drive, Dropbox, Instagram, remote URLs, cameras and other exciting locations, and then uploads them to the final destination. It’s fast, easy to use and let's you worry about more important problems than building a file uploader. Try it live.

Uppy is developed by the Transloadit team.

Check out docs and examples on uppy.io.

Features

  • Lightweight, modular plugin-based architecture, easy on dependencies :zap:
  • Use from a CDN or as a module to import
  • 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
  • A sleek user interface :sparkles:
  • Speaks multiple languages (i18n) :earth_africa:
  • Built with accessibility in mind
  • Free for the world, forever (as in beer 🍺, pizza 🍕, and liberty 🗽)
  • Works great with file encoding and processing backends, such as Transloadit, works great without (just roll your own Apache/Nginx/Node/etc backend)
  • 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/dist/uppy.min.js"></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.
  • Architecture & Making a Plugin — how to write a plugin for Uppy [documentation in progress].

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.