enmi-conf.org: comparison wp/wp-admin/js/color-picker.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/color-picker.js

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-admin/js/color-picker.js
+*/
 /* global wpColorPickerL10n */
 ( function( $, undef ) {
 	var ColorPicker,
 		_before = '<button type="button" class="button wp-color-result" aria-expanded="false"><span class="wp-color-result-text"></span></button>',
 		_button = '<input type="button" class="button button-small" />',
 		_wrappingLabel = '<label></label>',
 		_wrappingLabelText = '<span class="screen-reader-text"></span>';
 	/**
-	 * @summary Creates a jQuery UI color picker.
+	 * Creates a jQuery UI color picker that is used in the theme customizer.
 	 *
-	 * Creates a jQuery UI color picker that is used in the theme customizer.
+	 * @class $.widget.wp.wpColorPicker
 	 *
 	 * @since 3.5.0
 	 */
-	ColorPicker = {
+	ColorPicker = /** @lends $.widget.wp.wpColorPicker.prototype */{
 		options: {
 			defaultColor: false,
 			change: false,
 			clear: false,
 			hide: true,
 			mode: 'hsv',
 			type: 'full',
 			slider: 'horizontal'
 		},
 		/**
-		 * @summary Creates a color picker that only allows you to adjust the hue.
+		 * Creates a color picker that only allows you to adjust the hue.
 		 *
 		 * @since 3.5.0
 		 *
 		 * @access private
 		 *
 				mode: 'hsl',
 				type: 'hue',
 				hide: false,
 				color: color,
 				/**
-				 * @summary Handles the onChange event if one has been defined in the options.
+				 * Handles the onChange event if one has been defined in the options.
+				 *
+				 * @ignore
 				 *
 				 * @param {Event} event    The event that's being called.
 				 * @param {HTMLElement} ui The HTMLElement containing the color picker.
 				 *
 				 * @returns {void}
 				width: self.options.width,
 				slider: self.options.slider
 			} );
 		},
 		/**
-		 * @summary Creates the color picker.
-		 *
 		 * Creates the color picker, sets default values, css classes and wraps it all in HTML.
 		 *
 		 * @since 3.5.0
 		 *
 		 * @access private
 				hide: self.options.hide,
 				width: self.options.width,
 				mode: self.options.mode,
 				palettes: self.options.palettes,
 				/**
-				 * @summary Handles the onChange event if one has been defined in the options.
-				 *
 				 * Handles the onChange event if one has been defined in the options and additionally
 				 * sets the background color for the toggler element.
 				 *
 				 * @since 3.5.0
+				 *
+				 * @ignore
 				 *
 				 * @param {Event} event    The event that's being called.
 				 * @param {HTMLElement} ui The HTMLElement containing the color picker.
 				 *
 				 * @returns {void}
 			if ( ! self.options.hide ) {
 				self.toggler.click();
 			}
 		},
 		/**
-		 * @summary Binds event listeners to the color picker.
+		 * Binds event listeners to the color picker.
 		 *
 		 * @since 3.5.0
 		 *
 		 * @access private
 		 *
 		 */
 		_addListeners: function() {
 			var self = this;
 			/**
-			 * @summary Prevent any clicks inside this widget from leaking to the top and closing it.
+			 * Prevent any clicks inside this widget from leaking to the top and closing it.
 			 *
 			 * @since 3.5.0
 			 *
 			 * @param {Event} event The event that's being called.
 			 *
 			self.wrap.on( 'click.wpcolorpicker', function( event ) {
 				event.stopPropagation();
 			});
 			/**
-			 * @summary Open or close the color picker depending on the class.
+			 * Open or close the color picker depending on the class.
 			 *
 			 * @since 3.5
 			 */
 			self.toggler.click( function(){
 				if ( self.toggler.hasClass( 'wp-picker-open' ) ) {
 					self.open();
 				}
 			});
 			/**
-			 * @summary Checks if value is empty when changing the color in the color picker.
-			 *
 			 * Checks if value is empty when changing the color in the color picker.
 			 * If so, the background color is cleared.
 			 *
 			 * @since 3.5.0
 			 *
 					}
 				}
 			});
 			/**
-			 * @summary Enables the user to clear or revert the color in the color picker.
-			 *
 			 * Enables the user to either clear the color in the color picker or revert back to the default color.
 			 *
 			 * @since 3.5.0
 			 *
 			 * @param {Event} event The event that's being called.
 					self.element.val( self.options.defaultColor ).change();
 				}
 			});
 		},
 		/**
-		 * @summary Opens the color picker dialog.
+		 * Opens the color picker dialog.
 		 *
 		 * @since 3.5.0
 		 *
 		 * @returns {void}
 		 */
 				.addClass( 'wp-picker-open' )
 				.attr( 'aria-expanded', 'true' );
 			$( 'body' ).trigger( 'click.wpcolorpicker' ).on( 'click.wpcolorpicker', this.close );
 		},
 		/**
-		 * @summary Closes the color picker dialog.
+		 * Closes the color picker dialog.
 		 *
 		 * @since 3.5.0
 		 *
 		 * @returns {void}
 		 */
 				.removeClass( 'wp-picker-open' )
 				.attr( 'aria-expanded', 'false' );
 			$( 'body' ).off( 'click.wpcolorpicker', this.close );
 		},
 		/**
-		 * @summary Returns iris object or sets new color.
-		 *
 		 * Returns the iris object if no new color is provided. If a new color is provided, it sets the new color.
 		 *
 		 * @param newColor {string|*} The new color to use. Can be undefined.
 		 *
 		 * @since 3.5.0
 				return this.element.iris( 'option', 'color' );
 			}
 			this.element.iris( 'option', 'color', newColor );
 		},
 		/**
-		 * @summary Returns iris object or sets new default color.
-		 *
 		 * Returns the iris object if no new default color is provided.
 		 * If a new default color is provided, it sets the new default color.
 		 *
 		 * @param newDefaultColor {string|*} The new default color to use. Can be undefined.
 		 *

enmi-conf.org