Browse Source

update status bar and dashboard docs with new “hide various buttons” options

Artur Paikin 6 years ago
parent
commit
6547c06a1e
2 changed files with 10 additions and 4 deletions
  1. 3 1
      website/src/docs/dashboard.md
  2. 7 3
      website/src/docs/statusbar.md

+ 3 - 1
website/src/docs/dashboard.md

@@ -55,6 +55,7 @@ The Dashboard can be extensively customized by configuring the options below to
 
 ```js
 uppy.use(Dashboard, {
+  id: 'Dashboard',
   target: 'body',
   metaFields: [],
   trigger: '#uppy-select-files',
@@ -67,7 +68,8 @@ uppy.use(Dashboard, {
   showProgressDetails: false,
   hideUploadButton: false,
   hideRetryButton: false,
-  hidePauseResumeCancelButtons: false,
+  hidePauseResumeButton: false,
+  hideCancelButton: false,
   hideProgressAfterFinish: false,
   note: null,
   closeModalOnClickOutside: false,

+ 7 - 3
website/src/docs/statusbar.md

@@ -50,10 +50,14 @@ The `@uppy/status-bar` plugin has the following configurable options:
 
 ```js
 uppy.use(StatusBar, {
+  id: 'StatusBar',
   target: 'body',
-  hideUploadButton: false,
+  hideAfterFinish: true,
   showProgressDetails: false,
-  hideAfterFinish: true
+  hideUploadButton: false,
+  hideRetryButton: false,
+  hidePauseResumeButton: false,
+  hideCancelButton: false
   locale: {}
 })
 ```
@@ -62,7 +66,7 @@ uppy.use(StatusBar, {
 
 A unique identifier for this Status Bar. It defaults to `'StatusBar'`. Use this if you need to add multiple StatusBar instances.
 
-### `target: null`
+### `target: body`
 
 DOM element, CSS selector, or plugin to mount the Status Bar into.