Skip to content

Commit 626e1db

Browse files
committed
docs: fix typos
1 parent cbd1596 commit 626e1db

File tree

3 files changed

+87
-89
lines changed

3 files changed

+87
-89
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
- Fix "A `ReferenceError: _classCallCheck is not defined` error has occurred." error (thanks @hex-ci)
6767
- Fix issue with CSS custom property check (thanks @syedhusain-appspace)
6868
- Fix for slow loading videos not autoplaying (thanks @DanielHuntleySBG)
69-
- Fix for betwork requests are not cancelled after the player is destroyed (thanks @DanielHuntleySBG)
69+
- Fix for network requests are not cancelled after the player is destroyed (thanks @DanielHuntleySBG)
7070
- Added option to disable custom controls for YouTube and Vimeo
7171

7272
### v3.6.2
@@ -111,7 +111,7 @@
111111
### v3.5.8
112112

113113
- Added `flex-direction` property to fix some issues introduced in v3.5.7 when using custom CSS
114-
- Cleaned up the organisation of some of the SCSS files (should not effect CSS output)
114+
- Cleaned up the organization of some of the SCSS files (should not effect CSS output)
115115
- Added `referrerPolicy` option for Vimeo to prevent an issue present in the demo site
116116
- Remove all Vimeo controls for Pro & Premium accounts
117117
- Improve thumbnail size calculations when size is set per css (thanks @ydylla)
@@ -126,7 +126,7 @@
126126
- Accessibility tweak for the play button (thanks @lunika)
127127
- Fix for ads configuration (thanks @SoftCreatR)
128128
- Fix handling listener return value (thanks @taion)
129-
- Added localisation key for PIP (picture-in-picture) (thanks @lmislm)
129+
- Added localization key for PIP (picture-in-picture) (thanks @lmislm)
130130
- Preserve viewBox attribute in SVG sprite symbols (thanks @bseib)
131131
- Fix being unable to unmute autoplayed video on iOS (thanks @sumanbh)
132132
- Fixed Plyr container not resizing responsively (thanks @shravan2x)

CONTROLS.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,40 @@
22

33
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:
44

5-
- `Array` of options (this builds the default controls based on your choices)
6-
- `Element` with the controls
7-
- `String` containing the desired HTML
8-
- `false` (or empty string or array) to disable all controls
9-
- `Function` that will be executed and should return one of the above
5+
- `Array` of options (this builds the default controls based on your choices)
6+
- `Element` with the controls
7+
- `String` containing the desired HTML
8+
- `false` (or empty string or array) to disable all controls
9+
- `Function` that will be executed and should return one of the above
1010

1111
## Using default controls
1212

1313
If you want to use the standard controls as they are, you don't need to pass any options. If you want to turn on off controls, here's the full list:
1414

1515
```javascript
1616
controls: [
17-
'play-large', // The large play button in the center
18-
'restart', // Restart playback
19-
'rewind', // Rewind by the seek time (default 10 seconds)
20-
'play', // Play/pause playback
21-
'fast-forward', // Fast forward by the seek time (default 10 seconds)
22-
'progress', // The progress bar and scrubber for playback and buffering
23-
'current-time', // The current time of playback
24-
'duration', // The full duration of the media
25-
'mute', // Toggle mute
26-
'volume', // Volume control
27-
'captions', // Toggle captions
28-
'settings', // Settings menu
29-
'pip', // Picture-in-picture (currently Safari only)
30-
'airplay', // Airplay (currently Safari only)
31-
'download', // Show a download button with a link to either the current source or a custom URL you specify in your options
32-
'fullscreen', // Toggle fullscreen
17+
'play-large', // The large play button in the center
18+
'restart', // Restart playback
19+
'rewind', // Rewind by the seek time (default 10 seconds)
20+
'play', // Play/pause playback
21+
'fast-forward', // Fast forward by the seek time (default 10 seconds)
22+
'progress', // The progress bar and scrubber for playback and buffering
23+
'current-time', // The current time of playback
24+
'duration', // The full duration of the media
25+
'mute', // Toggle mute
26+
'volume', // Volume control
27+
'captions', // Toggle captions
28+
'settings', // Settings menu
29+
'pip', // Picture-in-picture (currently Safari only)
30+
'airplay', // Airplay (currently Safari only)
31+
'download', // Show a download button with a link to either the current source or a custom URL you specify in your options
32+
'fullscreen', // Toggle fullscreen
3333
];
3434
```
3535

3636
### Internationalization using default controls
3737

38-
You can provide an `i18n` object as one of your options when initialising the plugin which we be used when rendering the controls.
38+
You can provide an `i18n` object as one of your options when initializing the plugin which we be used when rendering the controls.
3939

4040
#### Example
4141

@@ -84,14 +84,14 @@ The classes and data attributes used in your template should match the `selector
8484

8585
You need to add several placeholders to your HTML template that are replaced when rendering:
8686

87-
- `{id}` - the dynamically generated ID for the player (for form controls)
88-
- `{seektime}` - the seek time specified in options for fast forward and rewind
89-
- `{title}` - the title of your media, if specified
87+
- `{id}` - the dynamically generated ID for the player (for form controls)
88+
- `{seektime}` - the seek time specified in options for fast forward and rewind
89+
- `{title}` - the title of your media, if specified
9090

9191
### Limitations
9292

93-
- Currently the settings menus are not supported with custom controls HTML
94-
- AirPlay and PiP buttons can be added but you will have to manage feature detection
93+
- Currently the settings menus are not supported with custom controls HTML
94+
- AirPlay and PiP buttons can be added but you will have to manage feature detection
9595

9696
### Example
9797

0 commit comments

Comments
 (0)