Changeset 41051

Timestamp:

07/14/2017 05:16:43 PM (7 years ago)

Author:

westonruter

Message:

Widgets: Add accessibility mode support for TinyMCE-enhanced Text and Media widgets (Video, Audio, Images).

Merges [40941] to 4.8 branch.
Amends [40640], [40631].
Props westonruter, afercia.
See #35243, #32417.
Fixes #40986 for 4.8.1.

Location:

branches/4.8

Files:

• . (modified) (1 prop)
• src/wp-admin/js/widgets/media-widgets.js (modified) (9 diffs)
• src/wp-admin/js/widgets/text-widgets.js (modified) (9 diffs)
• tests/qunit/wp-admin/js/widgets/test-media-image-widget.js (modified) (2 diffs)
• tests/qunit/wp-admin/js/widgets/test-media-video-widget.js (modified) (2 diffs)

branches/4.8/src/wp-admin/js/widgets/media-widgets.js

@@ -430 +430 @@
          * @param {Object}         options - Options.
          * @param {Backbone.Model} options.model - Model.
-         * @param {jQuery}         options.el - Control container element.
+         * @param {jQuery}         options.el - Control field container element.
+         * @param {jQuery}         options.syncContainer - Container element where fields are synced for the server.
          * @returns {void}
          */
@@ -438 +439 @@
             Backbone.View.prototype.initialize.call( control, options );
 
-            if ( ! control.el ) {
-                throw new Error( 'Missing options.el' );
-            }
             if ( ! ( control.model instanceof component.MediaWidgetModel ) ) {
                 throw new Error( 'Missing options.model' );
             }
+            if ( ! options.el ) {
+                throw new Error( 'Missing options.el' );
+            }
+            if ( ! options.syncContainer ) {
+                throw new Error( 'Missing options.syncContainer' );
+            }
+
+            control.syncContainer = options.syncContainer;
+
+            control.$el.addClass( 'media-widget-control' );
 
             // Allow methods to be passed in with control context preserved.
@@ -548 +556 @@
         syncModelToInputs: function syncModelToInputs() {
             var control = this;
-            control.$el.next( '.widget-content' ).find( '.media-widget-instance-property' ).each( function() {
+            control.syncContainer.find( '.media-widget-instance-property' ).each( function() {
                 var input = $( this ), value;
                 value = control.model.get( input.data( 'property' ) );
@@ -1004 +1012 @@
      */
     component.handleWidgetAdded = function handleWidgetAdded( event, widgetContainer ) {
-        var widgetContent, controlContainer, widgetForm, idBase, ControlConstructor, ModelConstructor, modelAttributes, widgetControl, widgetModel, widgetId, widgetInside, animatedCheckDelay = 50, renderWhenAnimationDone;
+        var fieldContainer, syncContainer, widgetForm, idBase, ControlConstructor, ModelConstructor, modelAttributes, widgetControl, widgetModel, widgetId, widgetInside, animatedCheckDelay = 50, renderWhenAnimationDone;
         widgetForm = widgetContainer.find( '> .widget-inside > .form, > .widget-inside > form' ); // Note: '.form' appears in the customizer, whereas 'form' on the widgets admin screen.
-        widgetContent = widgetForm.find( '> .widget-content' );
         idBase = widgetForm.find( '> .id_base' ).val();
         widgetId = widgetForm.find( '> .widget-id' ).val();
@@ -1033 +1040 @@
          * container.
          */
-        controlContainer = $( '<div class="media-widget-control"></div>' );
-        widgetContent.before( controlContainer );
+        fieldContainer = $( '<div></div>' );
+        syncContainer = widgetContainer.find( '.widget-content:first' );
+        syncContainer.before( fieldContainer );
 
         /*
@@ -1042 +1050 @@
          */
         modelAttributes = {};
-        widgetContent.find( '.media-widget-instance-property' ).each( function() {
+        syncContainer.find( '.media-widget-instance-property' ).each( function() {
             var input = $( this );
             modelAttributes[ input.data( 'property' ) ] = input.val();
@@ -1051 +1059 @@
 
         widgetControl = new ControlConstructor({
-            el: controlContainer,
+            el: fieldContainer,
+            syncContainer: syncContainer,
             model: widgetModel
         });
@@ -1077 +1086 @@
         component.modelCollection.add( [ widgetModel ] );
         component.widgetControls[ widgetModel.get( 'widget_id' ) ] = widgetControl;
+    };
+
+    /**
+     * Setup widget in accessibility mode.
+     *
+     * @returns {void}
+     */
+    component.setupAccessibleMode = function setupAccessibleMode() {
+        var widgetForm, widgetId, idBase, widgetControl, ControlConstructor, ModelConstructor, modelAttributes, fieldContainer, syncContainer;
+        widgetForm = $( '.editwidget > form' );
+        if ( 0 === widgetForm.length ) {
+            return;
+        }
+
+        idBase = widgetForm.find( '> .widget-control-actions > .id_base' ).val();
+
+        ControlConstructor = component.controlConstructors[ idBase ];
+        if ( ! ControlConstructor ) {
+            return;
+        }
+
+        widgetId = widgetForm.find( '> .widget-control-actions > .widget-id' ).val();
+
+        ModelConstructor = component.modelConstructors[ idBase ] || component.MediaWidgetModel;
+        fieldContainer = $( '<div></div>' );
+        syncContainer = widgetForm.find( '> .widget-inside' );
+        syncContainer.before( fieldContainer );
+
+        modelAttributes = {};
+        syncContainer.find( '.media-widget-instance-property' ).each( function() {
+            var input = $( this );
+            modelAttributes[ input.data( 'property' ) ] = input.val();
+        });
+        modelAttributes.widget_id = widgetId;
+
+        widgetControl = new ControlConstructor({
+            el: fieldContainer,
+            syncContainer: syncContainer,
+            model: new ModelConstructor( modelAttributes )
+        });
+
+        component.modelCollection.add( [ widgetControl.model ] );
+        component.widgetControls[ widgetControl.model.get( 'widget_id' ) ] = widgetControl;
+
+        widgetControl.render();
     };
 
@@ -1147 +1201 @@
                 component.handleWidgetAdded( new jQuery.Event( 'widget-added' ), widgetContainer );
             });
+
+            // Accessibility mode.
+            $( window ).on( 'load', function() {
+                component.setupAccessibleMode();
+            });
         });
     };

branches/4.8/src/wp-admin/js/widgets/text-widgets.js

@@ -25 +25 @@
          * Initialize.
          *
-         * @param {Object}         options - Options.
-         * @param {Backbone.Model} options.model - Model.
-         * @param {jQuery}         options.el - Control container element.
+         * @param {Object} options - Options.
+         * @param {jQuery} options.el - Control field container element.
+         * @param {jQuery} options.syncContainer - Container element where fields are synced for the server.
          * @returns {void}
          */
@@ -36 +36 @@
                 throw new Error( 'Missing options.el' );
             }
+            if ( ! options.syncContainer ) {
+                throw new Error( 'Missing options.syncContainer' );
+            }
 
             Backbone.View.prototype.initialize.call( control, options );
-
-            /*
-             * Create a container element for the widget control fields.
-             * This is inserted into the DOM immediately before the the .widget-content
-             * element because the contents of this element are essentially "managed"
-             * by PHP, where each widget update cause the entire element to be emptied
-             * and replaced with the rendered output of WP_Widget::form() which is
-             * sent back in Ajax request made to save/update the widget instance.
-             * To prevent a "flash of replaced DOM elements and re-initialized JS
-             * components", the JS template is rendered outside of the normal form
-             * container.
-             */
-            control.fieldContainer = $( '<div class="text-widget-fields"></div>' );
-            control.fieldContainer.html( wp.template( 'widget-text-control-fields' ) );
-            control.widgetContentContainer = control.$el.find( '.widget-content:first' );
-            control.widgetContentContainer.before( control.fieldContainer );
+            control.syncContainer = options.syncContainer;
+
+            control.$el.addClass( 'text-widget-fields' );
+            control.$el.html( wp.template( 'widget-text-control-fields' ) );
 
             control.fields = {
-                title: control.fieldContainer.find( '.title' ),
-                text: control.fieldContainer.find( '.text' )
+                title: control.$el.find( '.title' ),
+                text: control.$el.find( '.text' )
             };
 
@@ -63 +54 @@
             _.each( control.fields, function( fieldInput, fieldName ) {
                 fieldInput.on( 'input change', function updateSyncField() {
-                    var syncInput = control.widgetContentContainer.find( 'input[type=hidden].' + fieldName );
+                    var syncInput = control.syncContainer.find( 'input[type=hidden].' + fieldName );
                     if ( syncInput.val() !== $( this ).val() ) {
                         syncInput.val( $( this ).val() );
@@ -71 +62 @@
 
                 // Note that syncInput cannot be re-used because it will be destroyed with each widget-updated event.
-                fieldInput.val( control.widgetContentContainer.find( 'input[type=hidden].' + fieldName ).val() );
+                fieldInput.val( control.syncContainer.find( 'input[type=hidden].' + fieldName ).val() );
             });
         },
@@ -88 +79 @@
 
             if ( ! control.fields.title.is( document.activeElement ) ) {
-                syncInput = control.widgetContentContainer.find( 'input[type=hidden].title' );
+                syncInput = control.syncContainer.find( 'input[type=hidden].title' );
                 control.fields.title.val( syncInput.val() );
             }
 
-            syncInput = control.widgetContentContainer.find( 'input[type=hidden].text' );
+            syncInput = control.syncContainer.find( 'input[type=hidden].text' );
             if ( control.fields.text.is( ':visible' ) ) {
                 if ( ! control.fields.text.is( document.activeElement ) ) {
@@ -220 +211 @@
      */
     component.handleWidgetAdded = function handleWidgetAdded( event, widgetContainer ) {
-        var widgetForm, idBase, widgetControl, widgetId, animatedCheckDelay = 50, widgetInside, renderWhenAnimationDone;
+        var widgetForm, idBase, widgetControl, widgetId, animatedCheckDelay = 50, widgetInside, renderWhenAnimationDone, fieldContainer, syncContainer;
         widgetForm = widgetContainer.find( '> .widget-inside > .form, > .widget-inside > form' ); // Note: '.form' appears in the customizer, whereas 'form' on the widgets admin screen.
 
@@ -229 +220 @@
 
         // Prevent initializing already-added widgets.
-        widgetId = widgetForm.find( '> .widget-id' ).val();
+        widgetId = widgetForm.find( '.widget-id' ).val();
         if ( component.widgetControls[ widgetId ] ) {
             return;
         }
 
+        /*
+         * Create a container element for the widget control fields.
+         * This is inserted into the DOM immediately before the the .widget-content
+         * element because the contents of this element are essentially "managed"
+         * by PHP, where each widget update cause the entire element to be emptied
+         * and replaced with the rendered output of WP_Widget::form() which is
+         * sent back in Ajax request made to save/update the widget instance.
+         * To prevent a "flash of replaced DOM elements and re-initialized JS
+         * components", the JS template is rendered outside of the normal form
+         * container.
+         */
+        fieldContainer = $( '<div></div>' );
+        syncContainer = widgetContainer.find( '.widget-content:first' );
+        syncContainer.before( fieldContainer );
+
         widgetControl = new component.TextWidgetControl({
-            el: widgetContainer
+            el: fieldContainer,
+            syncContainer: syncContainer
         });
 
@@ -255 +262 @@
         };
         renderWhenAnimationDone();
+    };
+
+    /**
+     * Setup widget in accessibility mode.
+     *
+     * @returns {void}
+     */
+    component.setupAccessibleMode = function setupAccessibleMode() {
+        var widgetForm, idBase, widgetControl, fieldContainer, syncContainer;
+        widgetForm = $( '.editwidget > form' );
+        if ( 0 === widgetForm.length ) {
+            return;
+        }
+
+        idBase = widgetForm.find( '> .widget-control-actions > .id_base' ).val();
+        if ( 'text' !== idBase ) {
+            return;
+        }
+
+        fieldContainer = $( '<div></div>' );
+        syncContainer = widgetForm.find( '> .widget-inside' );
+        syncContainer.before( fieldContainer );
+
+        widgetControl = new component.TextWidgetControl({
+            el: fieldContainer,
+            syncContainer: syncContainer
+        });
+
+        widgetControl.initializeEditor();
     };
 
@@ -320 +356 @@
                 component.handleWidgetAdded( new jQuery.Event( 'widget-added' ), widgetContainer );
             });
+
+            // Accessibility mode.
+            $( window ).on( 'load', function() {
+                component.setupAccessibleMode();
+            });
         });
     };

branches/4.8/tests/qunit/wp-admin/js/widgets/test-media-image-widget.js

@@ -18 +18 @@
         imageWidgetModelInstance = new wp.mediaWidgets.modelConstructors.media_image();
         imageWidgetControlInstance = new ImageWidgetControl({
+            el: jQuery( '<div></div>' ),
+            syncContainer: jQuery( '<div></div>' ),
             model: imageWidgetModelInstance
         });
@@ -85 +87 @@
         imageWidgetModelInstance = new wp.mediaWidgets.modelConstructors.media_image();
         imageWidgetControlInstance = new wp.mediaWidgets.controlConstructors.media_image({
+            el: jQuery( '<div></div>' ),
+            syncContainer: jQuery( '<div></div>' ),
             model: imageWidgetModelInstance
         });

branches/4.8/tests/qunit/wp-admin/js/widgets/test-media-video-widget.js

@@ -18 +18 @@
         videoWidgetModelInstance = new wp.mediaWidgets.modelConstructors.media_video();
         videoWidgetControlInstance = new VideoWidgetControl({
+            el: jQuery( '<div></div>' ),
+            syncContainer: jQuery( '<div></div>' ),
             model: videoWidgetModelInstance
         });
@@ -47 +49 @@
         videoWidgetModelInstance = new wp.mediaWidgets.modelConstructors.media_video();
         videoWidgetControlInstance = new wp.mediaWidgets.controlConstructors.media_video({
+            el: jQuery( '<div></div>' ),
+            syncContainer: jQuery( '<div></div>' ),
             model: videoWidgetModelInstance
         });