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

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 				/**
 				 * Handles onclick events for the Visual/Text tabs.
 				 *
 				 * @since 4.3.0
 				 *
-				 * @returns {void}
+				 * @return {void}
 				 */
 				$$( document ).on( 'click', function( event ) {
 					var id, mode,
 						target = $$( event.target );
 		 * Returns the height of the editor toolbar(s) in px.
 		 *
 		 * @since 3.9.0
 		 *
 		 * @param {Object} editor The TinyMCE editor.
-		 * @returns {number} If the height is between 10 and 200 return the height,
+		 * @return {number} If the height is between 10 and 200 return the height,
 		 * else return 30.
 		 */
 		function getToolbarHeight( editor ) {
 			var node = $$( '.mce-toolbar-grp', editor.getContainer() )[0],
 				height = node && node.clientHeight;
 		 *
 		 * @memberof switchEditors
 		 *
 		 * @param {string} id The id of the editor you want to change the editor mode for. Default: `content`.
 		 * @param {string} mode The mode you want to switch to. Default: `toggle`.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function switchEditor( id, mode ) {
 			id = id || 'content';
 			mode = mode || 'toggle';
 					keepSelection = window.tinyMCEPreInit.mceInit[ id ] &&
 									window.tinyMCEPreInit.mceInit[ id ].wp_keep_scroll_position;
 				}
 				if ( keepSelection ) {
-					// Save the selection
+					// Save the selection.
 					addHTMLBookmarkInTextAreaContent( $textarea );
 				}
 				if ( editor ) {
 					editor.show();
 							editor.theme.resizeTo( null, editorHeight );
 						}
 					}
 					if ( editor.getParam( 'wp_keep_scroll_position' ) ) {
-						// Restore the selection
+						// Restore the selection.
 						focusHTMLBookmarkInVisualEditor( editor );
 					}
 				} else {
 					tinymce.init( window.tinyMCEPreInit.mceInit[ id ] );
 				}
 				if ( editor && editor.isHidden() ) {
 					return false;
 				}
 				if ( editor ) {
-					// Don't resize the textarea in iOS. The iframe is forced to 100% height there, we shouldn't match it.
+					// Don't resize the textarea in iOS.
+					// The iframe is forced to 100% height there, we shouldn't match it.
 					if ( ! tinymce.Env.iOS ) {
 						iframe = editor.iframeElement;
 						editorHeight = iframe ? parseInt( iframe.style.height, 10 ) : 0;
 						if ( editorHeight ) {
 					if ( selectionRange ) {
 						selectTextInTextArea( editor, selectionRange );
 					}
 				} else {
-					// There is probably a JS error on the page. The TinyMCE editor instance doesn't exist. Show the textarea.
+					// There is probably a JS error on the page.
+					// The TinyMCE editor instance doesn't exist. Show the textarea.
 					$textarea.css({ 'display': '', 'visibility': '' });
 				}
 				wrap.removeClass( 'tmce-active' ).addClass( 'html-active' );
 				$textarea.attr( 'aria-hidden', false );
 		 * e.g. `[caption]<img.../>..`.
 		 *
 		 * @param {string} content The test content where the cursor is.
 		 * @param {number} cursorPosition The cursor position inside the content.
 		 *
-		 * @returns {(null|Object)} Null if cursor is not in a tag, Object if the cursor is inside a tag.
+		 * @return {(null|Object)} Null if cursor is not in a tag, Object if the cursor is inside a tag.
 		 */
 		function getContainingTagInfo( content, cursorPosition ) {
 			var lastLtPos = content.lastIndexOf( '<', cursorPosition - 1 ),
 				lastGtPos = content.lastIndexOf( '>', cursorPosition );
 			if ( lastLtPos > lastGtPos || content.substr( cursorPosition, 1 ) === '>' ) {
-				// find what the tag is
+				// Find what the tag is.
 				var tagContent = content.substr( lastLtPos ),
 					tagMatch = tagContent.match( /<\s*(\/)?(\w+|\!-{2}.*-{2})/ );
 				if ( ! tagMatch ) {
 					return null;
 				var tagType = tagMatch[2],
 					closingGt = tagContent.indexOf( '>' );
 				return {
 					ltPos: lastLtPos,
-					gtPos: lastLtPos + closingGt + 1, // offset by one to get the position _after_ the character,
+					gtPos: lastLtPos + closingGt + 1, // Offset by one to get the position _after_ the character.
 					tagType: tagType,
 					isClosingTag: !! tagMatch[1]
 				};
 			}
 			return null;
 		 *
 		 * @param {string} content The text content to check against.
 		 * @param {number} cursorPosition    The cursor position to check.
 		 *
 		 * @return {(undefined|Object)} Undefined if the cursor is not wrapped in a shortcode tag.
-		 *                                Information about the wrapping shortcode tag if it's wrapped in one.
+		 *                              Information about the wrapping shortcode tag if it's wrapped in one.
 		 */
 		function getShortcodeWrapperInfo( content, cursorPosition ) {
 			var contentShortcodes = getShortCodePositionsInText( content );
 			for ( var i = 0; i < contentShortcodes.length; i++ ) {
 				'keygen', 'link', 'meta', 'param', 'source', 'track', 'wbr'
 			];
 			var cursorStart = cursorPositions.cursorStart,
 				cursorEnd = cursorPositions.cursorEnd,
-				// check if the cursor is in a tag and if so, adjust it
+				// Check if the cursor is in a tag and if so, adjust it.
 				isCursorStartInTag = getContainingTagInfo( content, cursorStart );
 			if ( isCursorStartInTag ) {
 				/**
 				 * Only move to the start of the HTML tag (to select the whole element) if the tag
 		 *
 		 * Adds selection markers in the content of the editor `textarea`.
 		 * The method directly manipulates the `textarea` content, to allow TinyMCE plugins
 		 * to run after the markers are added.
 		 *
-		 * @param {object} $textarea TinyMCE's textarea wrapped as a DomQuery object
+		 * @param {Object} $textarea TinyMCE's textarea wrapped as a DomQuery object
 		 */
 		function addHTMLBookmarkInTextAreaContent( $textarea ) {
 			if ( ! $textarea || ! $textarea.length ) {
 				// If no valid $textarea object is provided, there's nothing we can do.
 				return;
 					bookMarkEnd[0].outerHTML
 				].join( '' );
 			}
 			textArea.value = [
-				textArea.value.slice( 0, htmlModeCursorStartPosition ), // text until the cursor/selection position
+				textArea.value.slice( 0, htmlModeCursorStartPosition ), // Text until the cursor/selection position.
-				cursorMarkerSkeleton.clone()							// cursor/selection start marker
+				cursorMarkerSkeleton.clone()							// Cursor/selection start marker.
 					.addClass( 'mce_SELRES_start' )[0].outerHTML,
-				selectedText, 											// selected text with end cursor/position marker
+				selectedText, 											// Selected text with end cursor/position marker.
-				textArea.value.slice( htmlModeCursorEndPosition )		// text from last cursor/selection position to end
+				textArea.value.slice( htmlModeCursorEndPosition )		// Text from last cursor/selection position to end.
 			].join( '' );
 		}
 		/**
 		 * Focuses the selection markers in Visual mode.
 		 * Removes selection marker and the parent node if it is an empty paragraph.
 		 *
 		 * By default TinyMCE wraps loose inline tags in a `<p>`.
 		 * When removing selection markers an empty `<p>` may be left behind, remove it.
 		 *
-		 * @param {object} $marker The marker to be removed from the editor DOM, wrapped in an instnce of `editor.$`
+		 * @param {Object} $marker The marker to be removed from the editor DOM, wrapped in an instnce of `editor.$`
 		 */
 		function removeSelectionMarker( $marker ) {
 			var $markerParent = $marker.parent();
 			$marker.remove();
 		 * Uses the standard DOM selection API to achieve that goal.
 		 *
 		 * Check the notes in the comments in the code below for more information on some gotchas
 		 * and why this solution was chosen.
 		 *
-		 * @param {Object} editor The editor where we must find the selection
+		 * @param {Object} editor The editor where we must find the selection.
-		 * @returns {(null|Object)} The selection range position in the editor
+		 * @return {(null|Object)} The selection range position in the editor.
 		 */
 		function findBookmarkedPosition( editor ) {
 			// Get the TinyMCE `window` reference, since we need to access the raw selection.
 			var TinyMCEWindow = editor.getWin(),
 				selection = TinyMCEWindow.getSelection();
 				if ( endMatch[0].indexOf( 'data-mce-object-selection' ) !== -1 ) {
 					endMatchIndex -= endMatch[1].length;
 				}
-				// We need to adjust the end position to discard the length of the range start marker
+				// We need to adjust the end position to discard the length of the range start marker.
 				endIndex = endMatchIndex - startMatchLength;
 			}
 			return {
 				start: startIndex,
 		 *
 		 * @param {Object} editor TinyMCE's editor instance.
 		 * @param {Object} selection Selection data.
 		 */
 		function selectTextInTextArea( editor, selection ) {
-			// only valid in the text area mode and if we have selection
+			// Only valid in the text area mode and if we have selection.
 			if ( ! selection ) {
 				return;
 			}
 			var textArea = editor.getElement(),
 				start = selection.start,
 				end = selection.end || selection.start;
 			if ( textArea.focus ) {
-				// Wait for the Visual editor to be hidden, then focus and scroll to the position
+				// Wait for the Visual editor to be hidden, then focus and scroll to the position.
 				setTimeout( function() {
 					textArea.setSelectionRange( start, end );
 					if ( textArea.blur ) {
-						// defocus before focusing
+						// Defocus before focusing.
 						textArea.blur();
 					}
 					textArea.focus();
 				}, 100 );
 			}
 		 * @since 2.5.0
 		 *
 		 * @memberof switchEditors
 		 *
 		 * @param {string} text The text input.
-		 * @returns {string} The formatted text.
+		 * @return {string} The formatted text.
 		 */
 		function autop( text ) {
 			var preserve_linebreaks = false,
 				preserve_br = false,
 				blocklist = 'table|thead|tfoot|caption|col|colgroup|tbody|tr|td|th|div|dl|dd|dt|ul|ol|li|pre' +
 		 *
 		 * @since 2.9.0
 		 *
 		 * @memberof switchEditors
 		 *
-		 * @param {String} html The content from the visual editor.
+		 * @param {string} html The content from the visual editor.
-		 * @returns {String} the filtered content.
+		 * @return {string} the filtered content.
 		 */
 		function pre_wpautop( html ) {
 			var obj = { o: exports, data: html, unfiltered: html };
 			if ( $ ) {
 		 *
 		 * @since 2.9.0
 		 *
 		 * @memberof switchEditors
 		 *
-		 * @param {String} text The content from the text editor.
+		 * @param {string} text The content from the text editor.
-		 * @returns {String} filtered content.
+		 * @return {string} filtered content.
 		 */
 		function wpautop( text ) {
 			var obj = { o: exports, data: text, unfiltered: text };
 			if ( $ ) {
 	 *
 	 * @since 4.8.0
 	 *
 	 * @param {string} id The HTML id of the textarea that is used for the editor.
 	 *                    Has to be jQuery compliant. No brackets, special chars, etc.
-	 * @param {object} settings Example:
+	 * @param {Object} settings Example:
 	 * settings = {
 	 *    // See https://www.tinymce.com/docs/configure/integration-and-setup/.
 	 *    // Alternatively set to `true` to use the defaults.
 	 *    tinymce: {
 	 *        setup: function( editor ) {
 			return;
 		}
 		defaults = wp.editor.getDefaultSettings();
-		// Initialize TinyMCE by default
+		// Initialize TinyMCE by default.
 		if ( ! settings ) {
 			settings = {
 				tinymce: true
 			};
 		}

enmi-conf.org