diff options
Diffstat (limited to 'CONTROLS.md')
| -rw-r--r-- | CONTROLS.md | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/CONTROLS.md b/CONTROLS.md index b7b08c58..73959937 100644 --- a/CONTROLS.md +++ b/CONTROLS.md @@ -2,11 +2,11 @@ This is the markup that is rendered for the Plyr controls. You can use the default controls or provide a customized version of markup based on your needs. You can pass the following to the `controls` option: -- `Array` of options (this builds the default controls based on your choices) -- `Element` with the controls -- `String` containing the desired HTML -- `false` (or empty string or array) to disable all controls -- `Function` that will be executed and should return one of the above +- `Array` of options (this builds the default controls based on your choices) +- `Element` with the controls +- `String` containing the desired HTML +- `false` (or empty string or array) to disable all controls +- `Function` that will be executed and should return one of the above ## Using default controls @@ -14,28 +14,28 @@ If you want to use the standard controls as they are, you don't need to pass any ```javascript controls: [ - 'play-large', // The large play button in the center - 'restart', // Restart playback - 'rewind', // Rewind by the seek time (default 10 seconds) - 'play', // Play/pause playback - 'fast-forward', // Fast forward by the seek time (default 10 seconds) - 'progress', // The progress bar and scrubber for playback and buffering - 'current-time', // The current time of playback - 'duration', // The full duration of the media - 'mute', // Toggle mute - 'volume', // Volume control - 'captions', // Toggle captions - 'settings', // Settings menu - 'pip', // Picture-in-picture (currently Safari only) - 'airplay', // Airplay (currently Safari only) - 'download', // Show a download button with a link to either the current source or a custom URL you specify in your options - 'fullscreen', // Toggle fullscreen + 'play-large', // The large play button in the center + 'restart', // Restart playback + 'rewind', // Rewind by the seek time (default 10 seconds) + 'play', // Play/pause playback + 'fast-forward', // Fast forward by the seek time (default 10 seconds) + 'progress', // The progress bar and scrubber for playback and buffering + 'current-time', // The current time of playback + 'duration', // The full duration of the media + 'mute', // Toggle mute + 'volume', // Volume control + 'captions', // Toggle captions + 'settings', // Settings menu + 'pip', // Picture-in-picture (currently Safari only) + 'airplay', // Airplay (currently Safari only) + 'download', // Show a download button with a link to either the current source or a custom URL you specify in your options + 'fullscreen', // Toggle fullscreen ]; ``` ### Internationalization using default controls -You can provide an `i18n` object as one of your options when initialising the plugin which we be used when rendering the controls. +You can provide an `i18n` object as one of your options when initializing the plugin which we be used when rendering the controls. #### Example @@ -84,14 +84,14 @@ The classes and data attributes used in your template should match the `selector You need to add several placeholders to your HTML template that are replaced when rendering: -- `{id}` - the dynamically generated ID for the player (for form controls) -- `{seektime}` - the seek time specified in options for fast forward and rewind -- `{title}` - the title of your media, if specified +- `{id}` - the dynamically generated ID for the player (for form controls) +- `{seektime}` - the seek time specified in options for fast forward and rewind +- `{title}` - the title of your media, if specified ### Limitations -- Currently the settings menus are not supported with custom controls HTML -- AirPlay and PiP buttons can be added but you will have to manage feature detection +- Currently the settings menus are not supported with custom controls HTML +- AirPlay and PiP buttons can be added but you will have to manage feature detection ### Example |