enmi-conf.org: comparison wp/wp-includes/js/wp-lists.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-includes/js/wp-lists.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 		 * @param {object}      this
 		 * @param {HTMLElement} list            The list DOM element.
 		 * @param {object}      settings        Settings for the current list.
 		 * @param {string}      action          The type of action to perform: 'add', 'delete', or 'dim'.
 		 * @param {string}      backgroundColor Background color of the list's DOM element.
-		 * @returns {boolean} Whether to proceed with the action or not.
+		 * @return {boolean} Whether to proceed with the action or not.
 		 */
 		confirm: null,
 		/**
 		 * Callback that's run before an item gets added to the list.
 		 *
 		 * Allows to cancel the request.
 		 *
 		 * @callback wpList~addBefore
 		 * @param {object} settings Settings for the Ajax request.
-		 * @returns {object|boolean} Settings for the Ajax request or false to abort.
+		 * @return {object|boolean} Settings for the Ajax request or false to abort.
 		 */
 		addBefore: null,
 		/**
 		 * Callback that's run after an item got added to the list.
 		 * Allows to cancel the request.
 		 *
 		 * @callback wpList~delBefore
 		 * @param {object}      settings Settings for the Ajax request.
 		 * @param {HTMLElement} list     The list DOM element.
-		 * @returns {object|boolean} Settings for the Ajax request or false to abort.
+		 * @return {object|boolean} Settings for the Ajax request or false to abort.
 		 */
 		delBefore: null,
 		/**
 		 * Callback that's run after an item got deleted from the list.
 		 *
 		 * Allows to cancel the request.
 		 *
 		 * @callback wpList~dimBefore
 		 * @param {object} settings Settings for the Ajax request.
-		 * @returns {object|boolean} Settings for the Ajax request or false to abort.
+		 * @return {object|boolean} Settings for the Ajax request or false to abort.
 		 */
 		dimBefore: null,
 		/**
 		 * Callback that's run after an item got dim'd.
 	 * 4. `_wpnonce` value in element's href attribute.
 	 * 5. `_wpnonce` input field that is a descendant of element.
 	 * 6. 0 if none can be found.
 	 *
 	 * @param {jQuery} element  Element that triggered the request.
-	 * @param {object} settings Settings for the Ajax request.
+	 * @param {Object} settings Settings for the Ajax request.
-	 * @returns {string|number} Nonce
+	 * @return {string|number} Nonce
 	 */
 	nonce: function( element, settings ) {
 		var url      = wpAjax.unserialize( element.attr( 'href' ) ),
 			$element = $( '#' + settings.element );
 	 * data[1] - the-comment-list
 	 * data[2] - comment-{comment_ID}
 	 * data[3] - 66cc66
 	 * data[4] - unspam=1
 	 *
-	 * @param  {HTMLElement} element The DOM element.
+	 * @param {HTMLElement} element The DOM element.
-	 * @param  {string}      type    The type of data to look for: 'list', 'add', 'delete', or 'dim'.
+	 * @param {string}      type    The type of data to look for: 'list', 'add', 'delete', or 'dim'.
-	 * @returns {Array} Extracted list item data.
+	 * @return {Array} Extracted list item data.
 	 */
 	parseData: function( element, type ) {
 		var data = [], wpListsData;
 		try {
 	/**
 	 * Calls a confirm callback to verify the action that is about to be performed.
 	 *
 	 * @param {HTMLElement} list     The DOM element.
-	 * @param {object}      settings Settings for this list.
+	 * @param {Object}      settings Settings for this list.
 	 * @param {string}      action   The type of action to perform: 'add', 'delete', or 'dim'.
-	 * @returns {object|boolean} Settings if confirmed, false if not.
+	 * @return {Object|boolean} Settings if confirmed, false if not.
 	 */
 	pre: function( list, settings, action ) {
 		var $element, backgroundColor, confirmed;
 		settings = $.extend( {}, this.wpList.settings, {
 		return settings;
 	},
 	/**
-	 * Adds an item to the list via AJAX.
+	 * Adds an item to the list via Ajax.
 	 *
 	 * @param {HTMLElement} element  The DOM element.
-	 * @param {object}      settings Settings for this list.
+	 * @param {Object}      settings Settings for this list.
-	 * @returns {boolean} Whether the item was added.
+	 * @return {boolean} Whether the item was added.
 	 */
 	ajaxAdd: function( element, settings ) {
 		var list     = this,
 			$element = $( element ),
 			data     = wpList.parseData( $element, 'add' ),
 		return false;
 	},
 	/**
-	 * Delete an item in the list via AJAX.
+	 * Delete an item in the list via Ajax.
 	 *
 	 * @param {HTMLElement} element  A DOM element containing item data.
-	 * @param {object}      settings Settings for this list.
+	 * @param {Object}      settings Settings for this list.
-	 * @returns {boolean} Whether the item was deleted.
+	 * @return {boolean} Whether the item was deleted.
 	 */
 	ajaxDel: function( element, settings ) {
 		var list     = this,
 			$element = $( element ),
 			data     = wpList.parseData( $element, 'delete' ),
 		return false;
 	},
 	/**
-	 * Dim an item in the list via AJAX.
+	 * Dim an item in the list via Ajax.
 	 *
 	 * @param {HTMLElement} element  A DOM element containing item data.
-	 * @param {object}      settings Settings for this list.
+	 * @param {Object}      settings Settings for this list.
-	 * @returns {boolean} Whether the item was dim'ed.
+	 * @return {boolean} Whether the item was dim'ed.
 	 */
 	ajaxDim: function( element, settings ) {
 		var list     = this,
 			$element = $( element ),
 			data     = wpList.parseData( $element, 'dim' ),
 	/**
 	 * Returns the background color of the passed element.
 	 *
 	 * @param {jQuery|string} element Element to check.
-	 * @returns {string} Background color value in HEX. Default: '#ffffff'.
+	 * @return {string} Background color value in HEX. Default: '#ffffff'.
 	 */
 	getColor: function( element ) {
 		return $( element ).css( 'backgroundColor' ) || '#ffffff';
 	},
 	/**
 	 * Adds something.
 	 *
 	 * @param {HTMLElement} element  A DOM element containing item data.
-	 * @param {object}      settings Settings for this list.
+	 * @param {Object}      settings Settings for this list.
-	 * @returns {boolean} Whether the item was added.
+	 * @return {boolean} Whether the item was added.
 	 */
 	add: function( element, settings ) {
 		var $list    = $( this ),
 			$element = $( element ),
 			old      = false,
 *                                                Default: null.
 * @param {wpList~delAfter}  settings.delAfter    Callback that's run after an item got deleted from the list.
 *                                                Default: null.
 * @param {wpList~dimBefore} settings.dimBefore   Callback that's run before an item gets dim'd. Default: null.
 * @param {wpList~dimAfter}  settings.dimAfter    Callback that's run after an item got dim'd. Default: null.
-* @returns {$.fn} wpList API function.
+* @return {$.fn} wpList API function.
 */
 $.fn.wpList = function( settings ) {
 	this.each( function( index, list ) {
 		list.wpList = {
 			settings: $.extend( {}, wpList.settings, { what: wpList.parseData( list, 'list' )[1] || '' }, settings )

enmi-conf.org