Skip to content

Commit

Permalink
Merge pull request #91 from remotestorage/doc/backdrop
Browse files Browse the repository at this point in the history
Add documentation for new modal backdrop option
  • Loading branch information
galfert authored Feb 5, 2019
2 parents c7f3e4b + c6595f9 commit d2c66d2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ The widget has some configuration options to customize the behavior:

| Option | Description | Type | Default |
|---|---|---|---|
| `leaveOpen` | Keep the widget open when user clicks outside of it | Boolean | false |
| `autoCloseAfter` | Timeout after which the widget closes automatically (in milliseconds). The widget only closes when a storage is connected. | Number | 1500 |
| `skipInitial` | Don't show the initial connect hint, but show sign-in screen directly instead | Boolean | false |
| `logging` | Enable logging for debugging purposes | Boolean | false |
| `leaveOpen` | Keep the widget open when user clicks outside of it | Boolean | `false` |
| `autoCloseAfter` | Timeout after which the widget closes automatically (in milliseconds). The widget only closes when a storage is connected. | Number | `1500` |
| `skipInitial` | Don't show the initial connect hint, but show sign-in screen directly instead | Boolean | `false` |
| `logging` | Enable logging for debugging purposes | Boolean | `false` |
| `modalBackdrop` | Show a dark, transparent backdrop when opening the widget for connecting an account. `true` shows backdrop everywhere, `false` turns it off everywhere. Default is to only show it on small screens. | Boolean, String | `"onlySmallScreens"` |

Example:

Expand Down

0 comments on commit d2c66d2

Please sign in to comment.