diff --git a/spec.bs b/spec.bs index bdc504c..92321e1 100644 --- a/spec.bs +++ b/spec.bs @@ -114,7 +114,7 @@ interface DocumentPictureInPicture : EventTarget { dictionary DocumentPictureInPictureOptions { [EnforceRange] unsigned long long width = 0; [EnforceRange] unsigned long long height = 0; - boolean allowReturnToTab = true; + boolean allowReturnToOpener = true; }; [Exposed=Window, SecureContext] @@ -219,18 +219,18 @@ problems. window such that the distance between the top and bottom edges of the viewport are |options|["{{DocumentPictureInPictureOptions/height}}"] pixels. -14. If |options|["{{DocumentPictureInPictureOptions/allowReturnToTab}}"] exists +14. If |options|["{{DocumentPictureInPictureOptions/allowReturnToOpener}}"] exists and is false, the user agent should not display UI affordances on the picture-in-picture window that allow the user to return to the opener window.

For both video and document picture-in-picture, user agents often display a -button for the user to return to the original tab and close the -picture-in-picture window. While this actino makes sense in most cases +button for the user to return to the original page and close the +picture-in-picture window. While this action makes sense in most cases (especially for a video picture-in-picture window that returns the video to the main document), it does not always make sense for document picture-in-picture -windows. {{DocumentPictureInPictureOptions/allowReturnToTab}} is a hint to the +windows. {{DocumentPictureInPictureOptions/allowReturnToOpener}} is a hint to the user agent from the website as to whether that action makes sense for their particular document picture-in-picture experience.

@@ -657,16 +657,16 @@ content in question inside the PiP window: } -## Hide return-to-tab button ## {#example-hide-return-to-tab} +## Hide return-to-opener button ## {#example-hide-return-to-opener} While user agents often display a button on their video and document -picture-in-picture windows to return to the original tab and close the window, +picture-in-picture windows to return to the opener and close the window, this button doesn't always make sense for some websites' document picture-in-picture experience. Use the -{{DocumentPictureInPictureOptions/allowReturnToTab}} option to hide the button. +{{DocumentPictureInPictureOptions/allowReturnToOpener}} option to hide the button.
-documentPictureInPicture.requestWindow({ allowReturnToTab: false });
+documentPictureInPicture.requestWindow({ allowReturnToOpener: false });
 
# Acknowledgments # {#acknowledgments}