|
|
@@ -11,8 +11,12 @@ Plugins are what makes Uppy useful: they help select, manipulate and upload file
|
|
|
- [Dashboard](/docs/dashboard) — full featured sleek UI with file previews, metadata editing, upload/pause/resume/cancel buttons and more. Includes `StatusBar` and `Informer` plugins by default
|
|
|
- [DragDrop](/docs/dragdrop) — plain and simple drag and drop area
|
|
|
- [FileInput](/docs/fileinput) — even more plain and simple, just a button
|
|
|
- - [Provider Plugins](#Provider-Plugins) (remote sources that work through [Uppy Server](/docs/uppy-server/)): Instagram, GoogleDrive, Dropbox, Url (direct link)
|
|
|
- [Webcam](/docs/webcam) — upload selfies or audio / video recordings
|
|
|
+ - [Provider Plugins](/docs/providers) (remote sources that work through [Uppy Server](/docs/uppy-server/))
|
|
|
+ - [Dropbox](/docs/dropbox) – import files from Dropbox
|
|
|
+ - [GoogleDrive](/docs/google-drive) – import files from Google Drive
|
|
|
+ - [Instagram](/docs/instagram) – import files from Instagram
|
|
|
+ - [Url](/docs/url) – import files from any public URL
|
|
|
- **Uploaders:**
|
|
|
- [Tus](/docs/tus) — uploads using the [tus](https://tus.io) resumable upload protocol
|
|
|
- [XHRUpload](/docs/xhrupload) — classic multipart form uploads or binary uploads using XMLHTTPRequest
|
|
|
@@ -62,16 +66,6 @@ uppy.use(GoogleDrive, {target: Dashboard})
|
|
|
|
|
|
In the example above the `Dashboard` gets rendered into an element with ID `uppy`, while `GoogleDrive` is rendered into the `Dashboard` itself.
|
|
|
|
|
|
-### `host`
|
|
|
-
|
|
|
-Used by remote provider plugins, such as Google Drive, Instagram or Dropbox. Specifies the url to your running `uppy-server`. This allows uppy to know what server to connect to when server related operations are required by the provider plugin.
|
|
|
-
|
|
|
-```js
|
|
|
-// for Google Drive
|
|
|
-const GoogleDrive = require('uppy/lib/plugins/GoogleDrive')
|
|
|
-uppy.use(GoogleDrive, {target: Dashboard, host: 'http://localhost:3020'})
|
|
|
-```
|
|
|
-
|
|
|
### `locale: {}`
|
|
|
|
|
|
Same as with Uppy.Core’s setting from above, this allows you to override plugin’s locale string, so that instead of `Select files` in English, your users will see `Выберите файлы` in Russian. Example:
|
|
|
@@ -89,33 +83,4 @@ See plugin documentation pages for other plugin-specific options.
|
|
|
|
|
|
## Provider Plugins
|
|
|
|
|
|
-The Provider plugins help you connect to your accounts with remote file providers such as [Dropbox](https://dropbox.com), [Google Drive](https://drive.google.com), [Instagram](https://instagram.com) and remote urls (import a file by pasting a direct link to it). Because this requires server to server communication, they work tightly with [uppy-server](https://github.com/transloadit/uppy-server) to manage the server to server authorization for your account. Virtually most of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress of data consumption on the client.
|
|
|
-
|
|
|
-As of now, the supported providers are **Dropbox**, **GoogleDrive**, **Instagram**, and **Url**.
|
|
|
-
|
|
|
-Usage of the Provider plugins is not that different from any other *acquirer* plugin, except that it takes an extra option `host`, which specifies the url to your running `uppy-server`. This allows Uppy to know what server to connect to when server related operations are required by the provider plugin. Here's a quick example.
|
|
|
-
|
|
|
-```js
|
|
|
-const Uppy = require('uppy/lib/core')
|
|
|
-const Dashboard = require('uppy/lib/plugins/Dashboard')
|
|
|
-const uppy = Uppy()
|
|
|
-uppy.use(Dashboard, {
|
|
|
- trigger: '#pick-files'
|
|
|
-})
|
|
|
-
|
|
|
-// for Google Drive
|
|
|
-const GoogleDrive = require('uppy/lib/plugins/GoogleDrive')
|
|
|
-uppy.use(GoogleDrive, {target: Dashboard, host: 'http://localhost:3020'})
|
|
|
-
|
|
|
-// for Dropbox
|
|
|
-const Dropbox = require('uppy/lib/plugins/Dropbox')
|
|
|
-uppy.use(Dropbox, {target: Dashboard, host: 'http://localhost:3020'})
|
|
|
-
|
|
|
-// for Instagram
|
|
|
-const Instagram = require('uppy/lib/plugins/Instagram')
|
|
|
-uppy.use(Instagram, {target: Dashboard, host: 'http://localhost:3020'})
|
|
|
-
|
|
|
-// for Url
|
|
|
-const Url = require('uppy/lib/plugins/Url')
|
|
|
-uppy.use(Url, {target: Dashboard, host: 'http://localhost:3020'})
|
|
|
-```
|
|
|
+See the [Provider Plugins](/docs/providers) documentation page for information on provider plugins.
|
Renée Kooi