aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorSam Potts <me@sampotts.me>2018-01-05 10:37:38 +1100
committerSam Potts <me@sampotts.me>2018-01-05 10:37:38 +1100
commite14e2cfaff8acb9a11719d8f5e5684ca7ff48a02 (patch)
tree71eba78d319de41582cd3ebbdb9c7acd88c09667 /readme.md
parent04119b27e69472cce70c7f5b5359c6b45ad718f9 (diff)
parent92cb9e22e24d52e1843a5865651f7b2c5a00d47a (diff)
downloadplyr-e14e2cfaff8acb9a11719d8f5e5684ca7ff48a02.tar.lz
plyr-e14e2cfaff8acb9a11719d8f5e5684ca7ff48a02.tar.xz
plyr-e14e2cfaff8acb9a11719d8f5e5684ca7ff48a02.zip
Merge branch 'develop' of https://github.com/Selz/plyr into develop
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index 41cd9445..78ecff10 100644
--- a/readme.md
+++ b/readme.md
@@ -260,7 +260,7 @@ Note the single quotes encapsulating the JSON and double quotes on the object ke
| `displayDuration` | Boolean | `true` | Displays the duration of the media on the "metadataloaded" event (on startup) in the current time display. This will only work if the `preload` attribute is not set to `none` (or is not set at all) and you choose not to display the duration (see `controls` option). |
| `invertTime` | Boolean | `true` | Display the current time as a countdown rather than an incremental counter. |
| `toggleInvert` | Boolean | `true` | Allow users to click to toggle the above. |
-| `listeners` | Object | `null` | Allows binding of event listeners to the controls before the default handlers. See the `defaults.js` for available listeners. IF your handler prevents default on the event, the default handler will not fire. |
+| `listeners` | Object | `null` | Allows binding of event listeners to the controls before the default handlers. See the `defaults.js` for available listeners. If your handler prevents default on the event (`event.preventDefault()`), the default handler will not fire. |
| `captions` | Object | `{ active: false, language: window.navigator.language.split('-')[0] }` | `active`: Toggles if captions should be active by default. `language`: Sets the default language to load (if available). |
| `fullscreen` | Object | `{ enabled: true, fallback: true }` | `enabled`: Toggles whether fullscreen should be enabled. `fallback`: Allow fallback to a full-window solution. |
| `ratio` | String | `16:9` | The aspect ratio you want to use for embedded players. |