enmi-conf.org: comparison wp/wp-admin/js/inline-edit-tax.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-admin/js/inline-edit-tax.js

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 /* global inlineEditL10n, ajaxurl */
+/**
+* This file is used on the term overview page to power quick-editing terms.
+*/
+window.wp = window.wp || {};
+/**
+* Consists of functions relevant to the inline taxonomy editor.
+*
+* @namespace inlineEditTax
+*
+* @property {string} type The type of inline edit we are currently on.
+* @property {string} what The type property with a hash prefixed and a dash
+*                         suffixed.
+*/
 var inlineEditTax;
-(function($) {
+( function( $, wp ) {
 inlineEditTax = {
+	/**
+	 * @summary Initializes the inline taxonomy editor.
+	 *
+	 * Adds event handlers to be able to quick edit.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @this inlineEditTax
+	 * @memberof inlineEditTax
+	 * @returns {void}
+	 */
 	init : function() {
 		var t = this, row = $('#inline-edit');
 		t.type = $('#the-list').attr('data-wp-lists').substr(5);
 		t.what = '#'+t.type+'-';
 		$('#the-list').on('click', 'a.editinline', function(){
 			inlineEditTax.edit(this);
 			return false;
 		});
-		// prepare the edit row
+		/*
+		 * @summary Cancels inline editing when pressing escape inside the inline editor.
+		 *
+		 * @param {Object} e The keyup event that has been triggered.
+		 */
 		row.keyup( function( e ) {
+			// 27 = [escape]
 			if ( e.which === 27 ) {
 				return inlineEditTax.revert();
 			}
 		});
-		$( 'a.cancel', row ).click( function() {
+		/**
+		 * @summary Cancels inline editing when clicking the cancel button.
+		 */
+		$( '.cancel', row ).click( function() {
 			return inlineEditTax.revert();
 		});
-		$( 'a.save', row ).click( function() {
+		/**
+		 * @summary Saves the inline edits when clicking the save button.
+		 */
+		$( '.save', row ).click( function() {
 			return inlineEditTax.save(this);
 		});
+		/**
+		 * @summary Saves the inline edits when pressing enter inside the inline editor.
+		 */
 		$( 'input, select', row ).keydown( function( e ) {
+			// 13 = [enter]
 			if ( e.which === 13 ) {
 				return inlineEditTax.save( this );
 			}
 		});
+		/**
+		 * @summary Saves the inline edits on submitting the inline edit form.
+		 */
 		$( '#posts-filter input[type="submit"]' ).mousedown( function() {
 			t.revert();
 		});
 	},
+	/**
+	 * Toggles the quick edit based on if it is currently shown or hidden.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @this inlineEditTax
+	 * @memberof inlineEditTax
+	 *
+	 * @param {HTMLElement} el An element within the table row or the table row
+	 *                         itself that we want to quick edit.
+	 * @returns {void}
+	 */
 	toggle : function(el) {
 		var t = this;
 		$(t.what+t.getId(el)).css('display') === 'none' ? t.revert() : t.edit(el);
 	},
+	/**
+	 * Shows the quick editor
+	 *
+	 * @since 2.7.0
+	 *
+	 * @this inlineEditTax
+	 * @memberof inlineEditTax
+	 *
+	 * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
+	 *                                element within the table row or the
+	 * table row itself.
+	 * @returns {boolean} Always returns false.
+	 */
 	edit : function(id) {
 		var editRow, rowData, val,
 			t = this;
 		t.revert();
+		// Makes sure we can pass an HTMLElement as the ID.
 		if ( typeof(id) === 'object' ) {
 			id = t.getId(id);
 		}
 		editRow = $('#inline-edit').clone(true), rowData = $('#inline_'+id);
-		$('td', editRow).attr('colspan', $('.widefat:first thead th:visible').length);
+		$( 'td', editRow ).attr( 'colspan', $( 'th:visible, td:visible', '.wp-list-table.widefat:first thead' ).length );
 		$(t.what+id).hide().after(editRow).after('<tr class="hidden"></tr>');
 		val = $('.name', rowData);
 		val.find( 'img' ).replaceWith( function() { return this.alt; } );
 		$('.ptitle', editRow).eq(0).focus();
 		return false;
 	},
+	/**
+	 * @summary Saves the quick edit data.
+	 *
+	 * Saves the quick edit data to the server and replaces the table row with the
+	 * HTML retrieved from the server.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @this inlineEditTax
+	 * @memberof inlineEditTax
+	 *
+	 * @param {string|HTMLElement} id The ID of the term we want to quick edit or an
+	 *                                element within the table row or the
+	 * table row itself.
+	 * @returns {boolean} Always returns false.
+	 */
 	save : function(id) {
 		var params, fields, tax = $('input[name="taxonomy"]').val() || '';
+		// Makes sure we can pass an HTMLElement as the ID.
 		if( typeof(id) === 'object' ) {
 			id = this.getId(id);
 		}
 		$( 'table.widefat .spinner' ).addClass( 'is-active' );
 		};
 		fields = $('#edit-'+id).find(':input').serialize();
 		params = fields + '&' + $.param(params);
-		// make ajax request
+		// Do the ajax request to save the data to the server.
 		$.post( ajaxurl, params,
+			/**
+			 * @summary Handles the response from the server.
+			 *
+			 * Handles the response from the server, replaces the table row with the response
+			 * from the server.
+			 *
+			 * @param {string} r The string with which to replace the table row.
+			 */
 			function(r) {
-				var row, new_id, option_value;
+				var row, new_id, option_value,
+					$errorNotice = $( '#edit-' + id + ' .inline-edit-save .notice-error' ),
+					$error = $errorNotice.find( '.error' );
 				$( 'table.widefat .spinner' ).removeClass( 'is-active' );
 				if (r) {
 					if ( -1 !== r.indexOf( '<tr' ) ) {
 						$(inlineEditTax.what+id).siblings('tr.hidden').addBack().remove();
 						}
 						// Update the value in the Parent dropdown.
 						$( '#parent' ).find( 'option[value=' + option_value + ']' ).text( row.find( '.row-title' ).text() );
-						row.hide().fadeIn();
+						row.hide().fadeIn( 400, function() {
+							// Move focus back to the Quick Edit link.
+							row.find( '.editinline' ).focus();
+							wp.a11y.speak( inlineEditL10n.saved );
+						});
 					} else {
-						$('#edit-'+id+' .inline-edit-save .error').html(r).show();
+						$errorNotice.removeClass( 'hidden' );
+						$error.html( r );
+						/*
+						 * Some error strings may contain HTML entities (e.g. `&#8220`), let's use
+						 * the HTML element's text.
+						 */
+						wp.a11y.speak( $error.text() );
 					}
 				} else {
-					$('#edit-'+id+' .inline-edit-save .error').html(inlineEditL10n.error).show();
+					$errorNotice.removeClass( 'hidden' );
+					$error.html( inlineEditL10n.error );
+					wp.a11y.speak( inlineEditL10n.error );
 				}
 			}
 		);
+		// Prevent submitting the form when pressing Enter on a focused field.
 		return false;
 	},
+	/**
+	 * Closes the quick edit form.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @this inlineEditTax
+	 * @memberof inlineEditTax
+	 * @returns {void}
+	 */
 	revert : function() {
 		var id = $('table.widefat tr.inline-editor').attr('id');
 		if ( id ) {
 			$( 'table.widefat .spinner' ).removeClass( 'is-active' );
 			$('#'+id).siblings('tr.hidden').addBack().remove();
 			id = id.substr( id.lastIndexOf('-') + 1 );
-			$(this.what+id).show();
+			// Show the taxonomy row and move focus back to the Quick Edit link.
+			$( this.what + id ).show().find( '.editinline' ).focus();
 		}
+	},
-		return false;
-	},
+	/**
+	 * Retrieves the ID of the term of the element inside the table row.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @memberof inlineEditTax
+	 *
+	 * @param {HTMLElement} o An element within the table row or the table row itself.
+	 * @returns {string} The ID of the term based on the element.
+	 */
 	getId : function(o) {
 		var id = o.tagName === 'TR' ? o.id : $(o).parents('tr').attr('id'), parts = id.split('-');
 		return parts[parts.length - 1];
 	}
 };
 $(document).ready(function(){inlineEditTax.init();});
-})(jQuery);
+})( jQuery, window.wp );

enmi-conf.org