Changeset 63403

Timestamp:

08/30/2026 11:39:05 PM (22 hours ago)

Author:

peterwilsoncc

Message:

Docs: Document functions within embed-template.js.

See #65860.

File:

• trunk/src/js/_enqueues/lib/embed-template.js (modified) (7 diffs)

trunk/src/js/_enqueues/lib/embed-template.js

@@ -1 +1 @@
 /**
  * @output wp-includes/js/wp-embed-template.js
+ */
+
+/**
+ * IIFE setup function.
+ *
+ * @param {Window} window Global window object.
+ * @param {Document} document Global document object.
  */
 (function ( window, document ) {
@@ -26 +33 @@
         }
 
+        /**
+         * Runs on DomContentLoaded and load event.
+         *
+         * Exits early on the load event if the earlier event has
+         * successfully fired.
+         */
         function onLoad() {
                 if ( loaded ) {
@@ -48 +61 @@
                 }
 
+                /**
+                 * Open share dialog within embed iframe.
+                 */
                 function openSharingDialog() {
                         share_dialog.className = share_dialog.className.replace( 'hidden', '' );
@@ -54 +70 @@
                 }
 
+                /**
+                 * Close share dialog within embed iframe.
+                 */
                 function closeSharingDialog() {
                         share_dialog.className += ' hidden';
@@ -71 +90 @@
                 }
 
+                /**
+                 * Click event handler for share button.
+                 *
+                 * @param {MouseEvent} event Event handler.
+                 */
                 function shareClickHandler( event ) {
                         var currentTab = document.querySelector( '.wp-embed-share-tab-button [aria-selected="true"]' );
@@ -80 +104 @@
                 }
 
+                /**
+                 * Keyboard event handler for share button.
+                 *
+                 * @param {KeyboardEvent} event Event handler.
+                 * @return {boolean|void} Returns false if default action is to be prevented.
+                 */
                 function shareKeyHandler( event ) {
                         var target = event.target,
@@ -128 +158 @@
                 }, false );
 
+                /**
+                 * Constrain tabbing to share dialog when open.
+                 *
+                 * @param {KeyboardEvent} event Event object.
+                 */
                 function constrainTabbing( event ) {
                         // Need to re-get the selected tab each time.