From dccc819b1f9670b2b606dc47cfa7dcb83d2c46ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9e=20Kooi?= Date: Mon, 2 Jul 2018 14:33:07 +0200 Subject: [PATCH] docs: Document CDN bundle property name for each plugin. --- website/src/docs/aws-s3-multipart.md | 6 ++++++ website/src/docs/aws-s3.md | 6 ++++++ website/src/docs/dashboard.md | 6 ++++++ website/src/docs/dragdrop.md | 6 ++++++ website/src/docs/dropbox.md | 6 ++++++ website/src/docs/fileinput.md | 6 ++++++ website/src/docs/form.md | 6 ++++++ website/src/docs/golden-retriever.md | 6 ++++++ website/src/docs/google-drive.md | 6 ++++++ website/src/docs/informer.md | 6 ++++++ website/src/docs/instagram.md | 6 ++++++ website/src/docs/progressbar.md | 6 ++++++ website/src/docs/statusbar.md | 6 ++++++ website/src/docs/transloadit.md | 6 ++++++ website/src/docs/tus.md | 6 ++++++ website/src/docs/uppy.md | 6 ++++++ website/src/docs/url.md | 6 ++++++ website/src/docs/webcam.md | 6 ++++++ website/src/docs/xhrupload.md | 6 ++++++ 19 files changed, 114 insertions(+) diff --git a/website/src/docs/aws-s3-multipart.md b/website/src/docs/aws-s3-multipart.md index e8fdee277..aa7d7bb29 100644 --- a/website/src/docs/aws-s3-multipart.md +++ b/website/src/docs/aws-s3-multipart.md @@ -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 diff --git a/website/src/docs/aws-s3.md b/website/src/docs/aws-s3.md index 15733b904..033707c73 100644 --- a/website/src/docs/aws-s3.md +++ b/website/src/docs/aws-s3.md @@ -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'` diff --git a/website/src/docs/dashboard.md b/website/src/docs/dashboard.md index 48c29b55e..d16b012de 100644 --- a/website/src/docs/dashboard.md +++ b/website/src/docs/dashboard.md @@ -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. diff --git a/website/src/docs/dragdrop.md b/website/src/docs/dragdrop.md index 4147e6b1f..a46cfbeb4 100644 --- a/website/src/docs/dragdrop.md +++ b/website/src/docs/dragdrop.md @@ -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. diff --git a/website/src/docs/dropbox.md b/website/src/docs/dropbox.md index fbc979ffd..1f654fe23 100644 --- a/website/src/docs/dropbox.md +++ b/website/src/docs/dropbox.md @@ -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 diff --git a/website/src/docs/fileinput.md b/website/src/docs/fileinput.md index 33195f7d8..d98b4667a 100644 --- a/website/src/docs/fileinput.md +++ b/website/src/docs/fileinput.md @@ -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. diff --git a/website/src/docs/form.md b/website/src/docs/form.md index f5b569a62..7fc9f81f5 100644 --- a/website/src/docs/form.md +++ b/website/src/docs/form.md @@ -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: diff --git a/website/src/docs/golden-retriever.md b/website/src/docs/golden-retriever.md index 9a8a99a36..d4e656a56 100644 --- a/website/src/docs/golden-retriever.md +++ b/website/src/docs/golden-retriever.md @@ -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 GoldenRetriever’s service worker. If you’re using Browserify, just bundle it separately, for Webpack there is a plugin [serviceworker-webpack-plugin](https://github.com/oliviertassinari/serviceworker-webpack-plugin). diff --git a/website/src/docs/google-drive.md b/website/src/docs/google-drive.md index 079a1ef4d..d04cd74cc 100644 --- a/website/src/docs/google-drive.md +++ b/website/src/docs/google-drive.md @@ -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 diff --git a/website/src/docs/informer.md b/website/src/docs/informer.md index 6d45d11cb..43040d9fa 100644 --- a/website/src/docs/informer.md +++ b/website/src/docs/informer.md @@ -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. diff --git a/website/src/docs/instagram.md b/website/src/docs/instagram.md index d4835e29e..0c67ea3c5 100644 --- a/website/src/docs/instagram.md +++ b/website/src/docs/instagram.md @@ -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 diff --git a/website/src/docs/progressbar.md b/website/src/docs/progressbar.md index 34dcdb826..2b8edb27f 100644 --- a/website/src/docs/progressbar.md +++ b/website/src/docs/progressbar.md @@ -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: diff --git a/website/src/docs/statusbar.md b/website/src/docs/statusbar.md index 0946f87fd..83fc1392d 100644 --- a/website/src/docs/statusbar.md +++ b/website/src/docs/statusbar.md @@ -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. diff --git a/website/src/docs/transloadit.md b/website/src/docs/transloadit.md index 0aa27f655..2d40c2916 100644 --- a/website/src/docs/transloadit.md +++ b/website/src/docs/transloadit.md @@ -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` diff --git a/website/src/docs/tus.md b/website/src/docs/tus.md index 62ccb09d9..2c5c32f76 100644 --- a/website/src/docs/tus.md +++ b/website/src/docs/tus.md @@ -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: diff --git a/website/src/docs/uppy.md b/website/src/docs/uppy.md index e98bb4194..08ff711f4 100644 --- a/website/src/docs/uppy.md +++ b/website/src/docs/uppy.md @@ -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 diff --git a/website/src/docs/url.md b/website/src/docs/url.md index f5d2bd20e..a09a8fc83 100644 --- a/website/src/docs/url.md +++ b/website/src/docs/url.md @@ -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 diff --git a/website/src/docs/webcam.md b/website/src/docs/webcam.md index bb34fb746..cef06067a 100644 --- a/website/src/docs/webcam.md +++ b/website/src/docs/webcam.md @@ -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: diff --git a/website/src/docs/xhrupload.md b/website/src/docs/xhrupload.md index 9fd8b71ce..6a14b8bc2 100644 --- a/website/src/docs/xhrupload.md +++ b/website/src/docs/xhrupload.md @@ -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: