Browse Source

Update docs, add disablePageScrollWhenModalOpen and disableThumbnailGenerator to Dashboard

Artur Paikin 7 years ago
parent
commit
d7e3ebd54b
3 changed files with 11 additions and 7 deletions
  1. 9 5
      website/src/docs/dashboard.md
  2. 1 1
      website/src/docs/plugins.md
  3. 1 1
      website/src/docs/uppy.md

+ 9 - 5
website/src/docs/dashboard.md

@@ -83,10 +83,6 @@ Maximum width of the Dashboard in pixels. Used when `inline: true`.
 
 Maximum height of the Dashboard in pixels. Used when `inline: true`.
 
-### `semiTransparent: false`
-
-Make the dashboard semi-transparent.
-
 ### `showProgressDetails: false`
 
 Show progress bars for the uploads.
@@ -121,12 +117,16 @@ An array of UI field objects that will be shown when a user clicks “edit” bu
 })
 ```
 
-Note that this meta data will only be set to a file if it’s entered by user. If you want to set certain default meta field to each file regardless of user actions, set [`meta` in Uppy options](docs/uppy/#meta).
+Note that this meta data will only be set to a file if it’s entered by user. If you want to set certain default meta field to each file regardless of user actions, set [`meta` in Uppy options](/docs/uppy/#meta).
 
 ### `closeModalOnClickOutside: false`
 
 Set to true to automatically close the modal when the user clicks outside it.
 
+### `disablePageScrollWhenModalOpen: true`
+
+By default when Dashboard modal is open, it will disable page scrolling, so when you scroll a list of files in Uppy the website in the background stays still. Set to false to override this behaviour and leave page scrolling intact.
+
 ### `disableStatusBar: false`
 
 Dashboard ships with `StatusBar` plugin that shows upload progress and pause/resume/cancel buttons. If you want, you can disable the StatusBar to provide your custom solution.
@@ -135,6 +135,10 @@ Dashboard ships with `StatusBar` plugin that shows upload progress and pause/res
 
 Dashboard ships with `Informer` plugin that notifies when the browser is offline, or when it’s time to smile if `Webcam` is taking a picture. If you want, you can disable the Informer and/or provide your custom solution.
 
+### `disableThumbnailGenerator: false`
+
+Dashboard ships with `ThumbnailGenerator` plugin that adds small resized image thumbnails to images, for preview purposes only. If you want, you can disable the `ThumbnailGenerator` and/or provide your custom solution.
+
 ### `locale`
 
 See [general plugin options](/docs/plugins).

+ 1 - 1
website/src/docs/plugins.md

@@ -11,7 +11,7 @@ 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
   - [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
+  - [Provider Plugins](#provider-plugins) (remote sources that work through [Uppy Server](/docs/uppy-server/)): Instagram, GoogleDrive, Dropbox
   - [Webcam](/docs/webcam) — upload selfies or audio / video recordings
 - **Uploaders:**
   - [Tus](/docs/tus) — uploads using the [tus](https://tus.io) resumable upload protocol

+ 1 - 1
website/src/docs/uppy.md

@@ -68,7 +68,7 @@ meta: {
 }
 ```
 
-Can be altered with `uppy.setMeta({ username: 'Peter' })` method.
+Can be altered with [`uppy.setMeta({ username: 'Peter' })`](/docs/uppy/#uppy-setmeta-data) method.
 
 ### `onBeforeFileAdded: (currentFile, files) => Promise.resolve()`