Skip to content

Commit 8ec6051

Browse files
authored
Add docs for likebuttonpressed and watchlaterbuttonpressed events (#1130)
1 parent 271a96d commit 8ec6051

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,8 @@ it will also import the Player constructor directly:
263263
- [remoteplaybackdisconnect](#remoteplaybackdisconnect)
264264
- [interactivehotspotclicked](#interactivehotspotclicked)
265265
- [interactiveoverlaypanelclicked](#interactiveoverlaypanelclicked)
266+
- [likebuttonpressed](#likebuttonpressed)
267+
- [watchlaterbuttonpressed](#watchlaterbuttonpressed)
266268
- [static isVimeoUrl(url: string): boolean](#static-isvimeourlurl-string-boolean)
267269
- [Dev Options](#dev-options)
268270
- [prefer_mms](#prefer_mms)
@@ -1989,6 +1991,26 @@ Triggered when the overlay panel (buttons or images) within the interactive over
19891991
}
19901992
```
19911993

1994+
### likebuttonpressed
1995+
1996+
Triggered when a user likes or unlikes a video.
1997+
1998+
```js
1999+
{
2000+
liked: true
2001+
}
2002+
```
2003+
2004+
### watchlaterbuttonpressed
2005+
2006+
Triggered when a user adds or removes the current video from their Watch Later list.
2007+
2008+
```js
2009+
{
2010+
watchLater: true
2011+
}
2012+
```
2013+
19922014
### static isVimeoUrl(url: string): boolean
19932015

19942016
Check to see if the URL is a Vimeo URL.

types/events.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@ export interface InteractiveOverlayPanelClickEvent {
117117
panelId: string;
118118
}
119119

120+
export interface LikeButtonPressed {
121+
liked: boolean;
122+
}
123+
124+
export interface WatchLaterButtonPressed {
125+
watchLater: boolean;
126+
}
127+
120128
/**
121129
* Utility type that maps an event's data type to a generic version if supported
122130
*/
@@ -158,4 +166,6 @@ export interface PlayerEventMap {
158166
remoteplaybackdisconnect: void;
159167
interactivehotspotclicked: InteractiveHotspotClickEvent;
160168
interactiveoverlaypanelclicked: InteractiveOverlayPanelClickEvent;
169+
likebuttonpressed: LikeButtonPressed;
170+
watchlaterbuttonpressed: WatchLaterButtonPressed;
161171
}

0 commit comments

Comments
 (0)