Просмотр исходного кода

docs: Document CDN bundle property name for each plugin.

Renée Kooi 6 лет назад
Родитель
Сommit
dccc819b1f

+ 6 - 0
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
 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
 ## Options
 
 
 ### limit: 0
 ### limit: 0

+ 6 - 0
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
 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
 ## Options
 
 
 ### `id: 'AwsS3'`
 ### `id: 'AwsS3'`

+ 6 - 0
website/src/docs/dashboard.md

@@ -34,6 +34,12 @@ Install from NPM:
 npm install @uppy/dashboard
 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
 ## 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.
 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.

+ 6 - 0
website/src/docs/dragdrop.md

@@ -28,6 +28,12 @@ Install from NPM:
 npm install @uppy/drag-drop
 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
 ## 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.
 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.

+ 6 - 0
website/src/docs/dropbox.md

@@ -27,6 +27,12 @@ This plugin is published as the `@uppy/dropbox` package.
 npm install @uppy/dropbox
 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
 ## Options
 
 
 ```js
 ```js

+ 6 - 0
website/src/docs/fileinput.md

@@ -29,6 +29,12 @@ Install from NPM:
 npm install @uppy/file-input
 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
 ## 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.
 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.

+ 6 - 0
website/src/docs/form.md

@@ -25,6 +25,12 @@ Install from NPM:
 npm install @uppy/form
 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
 ## Options
 
 
 The Form plugin has the following configurable options:
 The Form plugin has the following configurable options:

+ 6 - 0
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
 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
 ## 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).
 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).

+ 6 - 0
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
 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
 ## Options
 
 
 ```js
 ```js

+ 6 - 0
website/src/docs/informer.md

@@ -29,6 +29,12 @@ Install from NPM:
 npm install @uppy/informer
 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
 ## 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.
 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.

+ 6 - 0
website/src/docs/instagram.md

@@ -29,6 +29,12 @@ This plugin is published as the `@uppy/instagram` package.
 npm install @uppy/instagram
 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
 ## Options
 
 
 ```js
 ```js

+ 6 - 0
website/src/docs/progressbar.md

@@ -28,6 +28,12 @@ Install from NPM:
 npm install @uppy/progress-bar
 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
 ## Options
 
 
 The Progressbar plugin has the following configurable options:
 The Progressbar plugin has the following configurable options:

+ 6 - 0
website/src/docs/statusbar.md

@@ -29,6 +29,12 @@ Install from NPM:
 npm install @uppy/status-bar
 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
 ## 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.
 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.

+ 6 - 0
website/src/docs/transloadit.md

@@ -34,6 +34,12 @@ This plugin is published as the `@uppy/transloadit` package.
 npm install @uppy/transloadit
 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
 ## Properties
 
 
 ### `Transloadit.UPPY_SERVER`
 ### `Transloadit.UPPY_SERVER`

+ 6 - 0
website/src/docs/tus.md

@@ -28,6 +28,12 @@ Install from NPM:
 npm install @uppy/tus
 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
 ## Options
 
 
 The Tus plugin supports all of [tus-js-client][]’s options. In addition tot that, it has the following configurable options:
 The Tus plugin supports all of [tus-js-client][]’s options. In addition tot that, it has the following configurable options:

+ 6 - 0
website/src/docs/uppy.md

@@ -19,6 +19,12 @@ const uppy = Uppy()
 npm install @uppy/core
 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
 ## Options
 
 
 ```js
 ```js

+ 6 - 0
website/src/docs/url.md

@@ -27,6 +27,12 @@ This plugin is published as the `@uppy/url` package.
 npm install @uppy/url
 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
 ## Options
 
 
 ```js
 ```js

+ 6 - 0
website/src/docs/webcam.md

@@ -29,6 +29,12 @@ Install from NPM:
 npm install @uppy/webcam
 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
 ## Options
 
 
 The Webcam plugin has the following configurable options:
 The Webcam plugin has the following configurable options:

+ 6 - 0
website/src/docs/xhrupload.md

@@ -28,6 +28,12 @@ Install from NPM:
 npm install @uppy/xhr-upload
 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
 ## Options
 
 
 The XHRUpload plugin has the following configurable options:
 The XHRUpload plugin has the following configurable options: