Procházet zdrojové kódy

Properly document modal: true on the Robodog docs page.

tim-kos před 6 roky
rodič
revize
f34deb1ede
1 změnil soubory, kde provedl 9 přidání a 2 odebrání
  1. 9 2
      website/src/docs/robodog-form.md

+ 9 - 2
website/src/docs/robodog-form.md

@@ -105,6 +105,7 @@ $(selector).transloadit({
 ```html
 <!-- The new Robodog way! -->
 <script src="//transloadit.edgly.net/releases/uppy/v0.30.5/robodog.min.js"></script>
+
 <script>
 window.Robodog.form(selector, {
   ...options
@@ -112,6 +113,13 @@ window.Robodog.form(selector, {
 </script>
 ```
 
+Make sure to also include the Uppy css file in your `<head>` tag in case you want to use the `modal: true` option:
+```html
+<head>
+  <link href="https://transloadit.edgly.net/releases/uppy/v0.30.5/uppy.min.css" rel="stylesheet">
+</head>
+```
+
 The equivalent options are listed below.
 
 ### Options
@@ -124,7 +132,7 @@ The equivalent options are listed below.
 | `requireUploadMetadata: true` | `waitForMetadata: true` |
 | `params` | `params` |
 | `signature` | `signature` |
-| `modal` | Currently unavailable |
+| `modal` | `modal` |
 | `autoSubmit` | `submitOnSuccess` |
 | `triggerUploadOnFileSelection` | `autoProceed: true` |
 | `processZeroFiles` | `alwaysRunAssembly` |
@@ -137,7 +145,6 @@ The equivalent options are listed below.
 
 As for the options that are unavailable:
 
-- `modal` will be added in the future.
 - `exclude` is intended to exclude certain `<input type="file">` inputs from Transloadit processing. It will likely not be added, but we'll perhaps have a `include` CSS selector option instead.
 - `debug` will not be added.