Ver Fonte

docs: Add ProgressBar docs page.

Renée Kooi há 7 anos atrás
pai
commit
0033e542ce
2 ficheiros alterados com 21 adições e 1 exclusões
  1. 1 1
      website/src/docs/plugins.md
  2. 20 0
      website/src/docs/progressbar.md

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

@@ -17,7 +17,7 @@ Plugins are what makes Uppy useful: they help select, manipulate and upload file
   - [XHRUpload](/docs/xhrupload) — classic multipart form uploads or binary uploads using XMLHTTPRequest
   - [XHRUpload](/docs/xhrupload) — classic multipart form uploads or binary uploads using XMLHTTPRequest
   - [AwsS3](/docs/aws-s3) — uploader for AWS S3
   - [AwsS3](/docs/aws-s3) — uploader for AWS S3
 - **Progress:**
 - **Progress:**
-  - ProgressBar — add a small YouTube-style progress bar at the top of the page
+  - [ProgressBar](/docs/progressbar) — add a small YouTube-style progress bar at the top of the page
   - [StatusBar](/docs/statusbar) — advanced upload progress status bar
   - [StatusBar](/docs/statusbar) — advanced upload progress status bar
   - Informer — show notifications
   - Informer — show notifications
 - **Helpers:**
 - **Helpers:**

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

@@ -0,0 +1,20 @@
+---
+type: docs
+order: 23
+title: "ProgressBar"
+permalink: docs/progressbar/
+---
+
+ProgressBar is a minimalist plugin that shows the current upload progress in a thin bar element, similar to the ones used by YouTube and GitHub when navigating between pages.
+
+[Try it live](/examples/dragdrop/) - The DragDrop example uses ProgressBars to show progress.
+
+## Options
+
+### `target: null`
+
+DOM element, CSS selector, or plugin to mount the progress bar into.
+
+### `fixed: false`
+
+When true, show the progress bar at the top of the page with `position: fixed`. When false, show the progress bar inline wherever it is mounted.