docs: Document CDN bundle property name for each plugin.

This commit is contained in:
Renée Kooi 2018-07-02 14:33:07 +02:00
parent 94f993a5a4
commit dccc819b1f
No known key found for this signature in database
GPG key ID: 8CDD5F0BC448F040
19 changed files with 114 additions and 0 deletions

View file

@ -23,6 +23,12 @@ This plugin is published as the `@uppy/aws-s3-multipart` package.
npm install @uppy/aws-s3-multipart
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const AwsS3Multipart = Uppy.AwsS3Multipart
```
## Options
### limit: 0

View file

@ -31,6 +31,12 @@ This plugin is published as the `@uppy/aws-s3` package.
npm install @uppy/aws-s3
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const AwsS3 = Uppy.AwsS3
```
## Options
### `id: 'AwsS3'`

View file

@ -34,6 +34,12 @@ Install from NPM:
npm install @uppy/dashboard
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Dashboard = Uppy.Dashboard
```
## CSS
The Dashboard plugin includes CSS for the Dashboard itself, and the plugins the Dashboard uses ([`@uppy/status-bar`](/docs/status-bar) and [`@uppy/informer`](/docs/informer)). If you also use the `@uppy/status-bar` or `@uppy/informer` plugin directly, you should not include their CSS files, but instead only use the one from the `@uppy/dashboard` plugin.

View file

@ -28,6 +28,12 @@ Install from NPM:
npm install @uppy/drag-drop
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const DragDrop = Uppy.DragDrop
```
## CSS
The DragDrop plugin includes some simple styles, like shown in the [example](/examples/dragdrop). You can also choose not to use it and provide your own styles instead.

View file

@ -27,6 +27,12 @@ This plugin is published as the `@uppy/dropbox` package.
npm install @uppy/dropbox
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Dropbox = Uppy.Dropbox
```
## Options
```js

View file

@ -29,6 +29,12 @@ Install from NPM:
npm install @uppy/file-input
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const FileInput = Uppy.FileInput
```
## CSS
The FileInput plugin includes some simple styles for use with the [`pretty`](#pretty-true) option, like shown in the [example](/examples/xhrupload). You can also choose not to use it and provide your own styles instead.

View file

@ -25,6 +25,12 @@ Install from NPM:
npm install @uppy/form
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Form = Uppy.Form
```
## Options
The Form plugin has the following configurable options:

View file

@ -15,6 +15,12 @@ This plugin is published as the `@uppy/golden-retriever` package.
npm install @uppy/golden-retriever
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const GoldenRetriever = Uppy.GoldenRetriever
```
## Usage
1\. Bundle your own service worker `sw.js` file with Uppy GoldenRetrievers service worker. If youre using Browserify, just bundle it separately, for Webpack there is a plugin [serviceworker-webpack-plugin](https://github.com/oliviertassinari/serviceworker-webpack-plugin).

View file

@ -27,6 +27,12 @@ This plugin is published as the `@uppy/google-drive` package.
npm install @uppy/google-drive
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const GoogleDrive = Uppy.GoogleDrive
```
## Options
```js

View file

@ -29,6 +29,12 @@ Install from NPM:
npm install @uppy/informer
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Informer = Uppy.Informer
```
## CSS
The Informer plugin includes CSS a file for styling. If you use the [`@uppy/dashboard`](/docs/dashboard) plugin, you do not need to include the styles for the Informer, because the Dashboard already includes it.

View file

@ -29,6 +29,12 @@ This plugin is published as the `@uppy/instagram` package.
npm install @uppy/instagram
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Instagram = Uppy.Instagram
```
## Options
```js

View file

@ -28,6 +28,12 @@ Install from NPM:
npm install @uppy/progress-bar
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const ProgressBar = Uppy.ProgressBar
```
## Options
The Progressbar plugin has the following configurable options:

View file

@ -29,6 +29,12 @@ Install from NPM:
npm install @uppy/status-bar
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const StatusBar = Uppy.StatusBar
```
## CSS
The StatusBar plugin includes CSS a file for styling. If you use the [`@uppy/dashboard`](/docs/dashboard) plugin, you do not need to include the styles for the StatusBar, because the Dashboard already includes it.

View file

@ -34,6 +34,12 @@ This plugin is published as the `@uppy/transloadit` package.
npm install @uppy/transloadit
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Transloadit = Uppy.Transloadit
```
## Properties
### `Transloadit.UPPY_SERVER`

View file

@ -28,6 +28,12 @@ Install from NPM:
npm install @uppy/tus
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Tus = Uppy.Tus
```
## Options
The Tus plugin supports all of [tus-js-client][]s options. In addition tot that, it has the following configurable options:

View file

@ -19,6 +19,12 @@ const uppy = Uppy()
npm install @uppy/core
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Core = Uppy.Core
```
## Options
```js

View file

@ -27,6 +27,12 @@ This plugin is published as the `@uppy/url` package.
npm install @uppy/url
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Url = Uppy.Url
```
## Options
```js

View file

@ -29,6 +29,12 @@ Install from NPM:
npm install @uppy/webcam
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const Webcam = Uppy.Webcam
```
## Options
The Webcam plugin has the following configurable options:

View file

@ -28,6 +28,12 @@ Install from NPM:
npm install @uppy/xhr-upload
```
In the [CDN package](/docs/#With-a-script-tag), it is available on the `Uppy` global object:
```js
const XHRUpload = Uppy.XHRUpload
```
## Options
The XHRUpload plugin has the following configurable options: