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

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 21	48c4eec2b7e6

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	/**
 	 * Handles the resizing of the editor.
 	 *
 	 * @since 4.0.0
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	$( function() {
 		var $wrap = $( '#postdivrich' ),
 			$contentWrap = $( '#wp-content-wrap' ),
 			$tools = $( '#wp-content-editor-tools' ),
 		 *
 		 * Doesn't shrink the editor size below the 300px auto resize minimum height.
 		 *
 		 * @since 4.6.1
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		var shrinkTextarea = window._.throttle( function() {
 			var x = window.scrollX || document.documentElement.scrollLeft;
 			var y = window.scrollY || document.documentElement.scrollTop;
 			var height = parseInt( textEditor.style.height, 10 );
 		 * the old text length, it shrinks the text area. Otherwise it resizes the editor to
 		 * the scroll height.
 		 *
 		 * @since 4.6.1
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function textEditorResize() {
 			var length = textEditor.value.length;
 			if ( mceEditor && ! mceEditor.isHidden() ) {
 		 * and stores these in the heights object. Defaults to 0.
 		 * Gets the width of the window and stores this in the heights object.
 		 *
 		 * @since 4.0.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function getHeights() {
 			var windowWidth = $window.width();
 			heights = {
 		 * @since 4.0.0
 		 *
 		 * @param {event} event The TinyMCE editor init event.
 		 * @param {object} editor The editor to bind the vents on.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		$document.on( 'tinymce-editor-init.editor-expand', function( event, editor ) {
 			// VK contains the type of key pressed. VK = virtual keyboard.
 			var VK = window.tinymce.util.VK,
 				/**
 				 * Hides any float panel with a hover state. Additionally hides tooltips.
 				 *
-				 * @returns {void}
+				 * @return {void}
 				 */
 				hideFloatPanels = _.debounce( function() {
 					! $( '.mce-floatpanel:hover' ).length && window.tinymce.ui.FloatPanel.hideAll();
 					$( '.mce-tooltip' ).hide();
 				}, 1000, true );
 			$menuBar = $contentWrap.find( '.mce-menubar' );
 			/**
 			 * Gets the offset of the editor.
 			 *
-			 * @returns {Number|Boolean} Returns the offset of the editor
+			 * @return {number|boolean} Returns the offset of the editor
 			 * or false if there is no offset height.
 			 */
 			function mceGetCursorOffset() {
 				var node = editor.selection.getNode(),
 					range, view, offset;
 			 *
 			 * @since 4.0.0
 			 *
 			 * @param {event} event The event to get the key code from.
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function mceKeyup( event ) {
 				var key = event.keyCode;
-				// Bail on special keys. Key code 47 is a /
+				// Bail on special keys. Key code 47 is a '/'.
 				if ( key <= 47 && ! ( key === VK.SPACEBAR || key === VK.ENTER || key === VK.DELETE || key === VK.BACKSPACE || key === VK.UP || key === VK.LEFT || key === VK.DOWN || key === VK.UP ) ) {
 					return;
-				// OS keys, function keys, num lock, scroll lock. Key code 91-93 are OS keys. Key code 112-123 are F1 to F12. Key code 144 is num lock. Key code 145 is scroll lock.
+				// OS keys, function keys, num lock, scroll lock. Key code 91-93 are OS keys.
+				// Key code 112-123 are F1 to F12. Key code 144 is num lock. Key code 145 is scroll lock.
 				} else if ( ( key >= 91 && key <= 93 ) || ( key >= 112 && key <= 123 ) || key === 144 || key === 145 ) {
 					return;
 				}
 				mceScroll( key );
 			 *
 			 * @since 4.1.0
 			 *
 			 * @param {string} key The key code of the pressed key.
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function mceScroll( key ) {
 				var offset = mceGetCursorOffset(),
 					buffer = 50,
 					cursorTop, cursorBottom, editorTop, editorBottom;
 			 *
 			 * @since 4.1.0
 			 *
 			 * @param {event} event The FullscreenStateChanged event.
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function mceFullscreenToggled( event ) {
 				// event.state is true if the editor is fullscreen.
 				if ( ! event.state ) {
 					adjust();
 			 * Binds the hideFloatPanels function on the window scroll.mce-float-panels event.
 			 * Executes the wpAutoResize on the active editor.
 			 *
 			 * @since 4.0.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function mceShow() {
 				$window.on( 'scroll.mce-float-panels', hideFloatPanels );
 				setTimeout( function() {
 			 * Removes all functions from the window scroll.mce-float-panels event.
 			 * Resizes the text editor and scrolls to a position based on the pageXOffset and adminBarHeight.
 			 *
 			 * @since 4.0.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function mceHide() {
 				$window.off( 'scroll.mce-float-panels' );
 				setTimeout( function() {
 			/**
 			 * Toggles advanced states.
 			 *
 			 * @since 4.1.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			function toggleAdvanced() {
 				advanced = ! advanced;
 			}
 			/**
 			 * Binds events of the editor and window.
 			 *
 			 * @since 4.0.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			mceBind = function() {
 				editor.on( 'keyup', mceKeyup );
 				editor.on( 'show', mceShow );
 				editor.on( 'hide', mceHide );
 			/**
 			 * Unbinds the events of the editor and window.
 			 *
 			 * @since 4.0.0
 			 *
-			 * @returns {void}
+			 * @return {void}
 			 */
 			mceUnbind = function() {
 				editor.off( 'keyup', mceKeyup );
 				editor.off( 'show', mceShow );
 				editor.off( 'hide', mceHide );
 		 *
 		 * @since 4.0.0
 		 *
 		 * @param {event} event The event that calls this function.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function adjust( event ) {
 			// Makes sure we're not in fullscreen mode.
 			if ( fullscreen && fullscreen.settings.visible ) {
 			/*
 			 * If in visual mode, checks if the editorHeight is greater than the autoresizeMinHeight + topHeight.
 			 * If not in visual mode, checks if the editorHeight is greater than the autoresizeMinHeight + 20.
 			 */
-			canPin = visual ? autoresizeMinHeight + topHeight : autoresizeMinHeight + 20; // 20px from textarea padding
+			canPin = visual ? autoresizeMinHeight + topHeight : autoresizeMinHeight + 20; // 20px from textarea padding.
 			canPin = editorHeight > ( canPin + 5 );
 			if ( ! canPin ) {
 				if ( resize ) {
 					$tools.css( {
 		/**
 		 * Resizes the editor and adjusts the toolbars.
 		 *
 		 * @since 4.0.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fullscreenHide() {
 			textEditorResize();
 			adjust();
 		}
 		 *
 		 * @since 4.0.0
 		 *
 		 * @param {function} callback The function to run in the timeout.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function initialResize( callback ) {
 			for ( var i = 1; i < 6; i++ ) {
 				setTimeout( callback, 500 * i );
 			}
 		/**
 		 * Runs adjust after 100ms.
 		 *
 		 * @since 4.0.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function afterScroll() {
 			clearTimeout( scrollTimer );
 			scrollTimer = setTimeout( adjust, 100 );
 		}
 		/**
 		 * Binds editor expand events on elements.
 		 *
 		 * @since 4.0.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function on() {
 			/*
 			 * Scroll to the top when triggering this from JS.
 			 * Ensure the toolbars are pinned properly.
 		/**
 		 * Unbinds editor expand events.
 		 *
 		 * @since 4.0.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function off() {
 			var height = parseInt( window.getUserSetting( 'ed_size', 300 ), 10 );
 			if ( height < 50 ) {
 			mceUnbind();
 			// Adjust when entering or exiting fullscreen mode.
 			fullscreen && fullscreen.pubsub.unsubscribe( 'hidden', fullscreenHide );
-			// Reset all css
+			// Reset all CSS.
 			$.each( [ $visualTop, $textTop, $tools, $menuBar, $bottom, $statusBar, $contentWrap, $visualEditor, $textEditor, $sideSortables ], function( i, element ) {
 				element && element.attr( 'style', '' );
 			});
 			fixedTop = fixedBottom = fixedSideTop = fixedSideBottom = false;
 	/**
 	 * Handles the distraction free writing of TinyMCE.
 	 *
 	 * @since 4.1.0
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	$( function() {
 		var $body = $( document.body ),
 			$wrap = $( '#wpcontent' ),
 			$editor = $( '#post-body-content' ),
 		/**
 		 * Recalculates the bottom and right position of the editor in the DOM.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function recalcEditorRect() {
 			editorRect = $editor.offset();
 			editorRect.right = editorRect.left + $editor.outerWidth();
 			editorRect.bottom = editorRect.top + $editor.outerHeight();
 		/**
 		 * Activates the distraction free writing mode.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function activate() {
 			if ( ! _isActive ) {
 				_isActive = true;
 		/**
 		 * Deactivates the distraction free writing mode.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function deactivate() {
 			if ( _isActive ) {
 				off();
 		/**
 		 * Returns _isActive.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {boolean} Returns true is _isActive is true.
+		 * @return {boolean} Returns true is _isActive is true.
 		 */
 		function isActive() {
 			return _isActive;
 		}
 		/**
 		 * Binds events on the editor for distraction free writing.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function on() {
 			if ( ! _isOn && _isActive ) {
 				_isOn = true;
 		/**
 		 * Unbinds events on the editor for distraction free writing.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function off() {
 			if ( _isOn ) {
 				_isOn = false;
 		/**
 		 * Binds or unbinds the editor expand events.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function toggle() {
 			if ( _isOn ) {
 				off();
 			} else {
 		/**
 		 * Returns the value of _isOn.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {boolean} Returns true if _isOn is true.
+		 * @return {boolean} Returns true if _isOn is true.
 		 */
 		function isOn() {
 			return _isOn;
 		}
 		 *
 		 * @since 4.1.0
 		 *
 		 * @param event The event that triggers this function.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeOut( event ) {
 			var isMac,
 				key = event && event.keyCode;
 				return;
 			}
 			// Return if any of the following keys or combinations of keys is pressed.
 			if ( event && ( event.metaKey || ( event.ctrlKey && ! event.altKey ) || ( event.altKey && event.shiftKey ) || ( key && (
-				// Special keys ( tab, ctrl, alt, esc, arrow keys... )
+				// Special keys ( tab, ctrl, alt, esc, arrow keys... ).
 				( key <= 47 && key !== 8 && key !== 13 && key !== 32 && key !== 46 ) ||
-				// Windows keys
+				// Windows keys.
 				( key >= 91 && key <= 93 ) ||
-				// F keys
+				// F keys.
 				( key >= 112 && key <= 135 ) ||
-				// Num Lock, Scroll Lock, OEM
+				// Num Lock, Scroll Lock, OEM.
 				( key >= 144 && key <= 150 ) ||
-				// OEM or non-printable
+				// OEM or non-printable.
 				key >= 224
 			) ) ) ) {
 				return;
 			}
 		 *
 		 * @since 4.1.0
 		 *
 		 * @param event The event that triggers this function.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeIn( event ) {
 			if ( faded ) {
 				faded = false;
 		/**
 		 * Fades in if the focused element based on it position.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function maybeFadeIn() {
 			setTimeout( function() {
 				var position = document.activeElement.compareDocumentPosition( $editor.get( 0 ) );
 		/**
 		 * Fades out the admin bar based on focus on the admin bar.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeOutAdminBar() {
 			if ( ! fadedAdminBar && faded ) {
 				fadedAdminBar = true;
 		/**
 		 * Fades in the admin bar.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeInAdminBar() {
 			if ( fadedAdminBar ) {
 				fadedAdminBar = false;
 		/**
 		 * Fades out the edit slug box.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeOutSlug() {
 			if ( ! fadedSlug && faded && ! $slug.find( ':focus').length ) {
 				fadedSlug = true;
 		/**
 		 * Fades in the edit slug box.
 		 *
 		 * @since 4.1.0
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function fadeInSlug() {
 			if ( fadedSlug ) {
 				fadedSlug = false;
 		 *
 		 * @since 4.1.0
 		 *
 		 * @param {event} event The event to trigger the toggle.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		function toggleViaKeyboard( event ) {
 			if ( event.altKey && event.shiftKey && 87 === event.keyCode ) {
 				toggle();
 			}
 		 * @since 4.1.0
 		 *
 		 * @param {event} event The TinyMCE editor setup event.
 		 * @param {object} editor The editor to add the button to.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		$document.on( 'tinymce-editor-setup.focus', function( event, editor ) {
 			editor.addButton( 'dfw', {
 				active: _isOn,
 				classes: 'wp-dfw btn widget',
 		 * @since 4.1.0
 		 *
 		 * @param {event} event The TinyMCE editor init event.
 		 * @param {object} editor The editor to bind events on.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		$document.on( 'tinymce-editor-init.focus', function( event, editor ) {
 			var mceBind, mceUnbind;
 			function focus() {
 		 * @since 4.1.0
 		 *
 		 * @param {event} event The quicktags init event.
 		 * @param {object} editor The editor to bind events on.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		$document.on( 'quicktags-init', function( event, editor ) {
 			var $button;
 			// Bind the distraction free writing events if the distraction free writing button is available.

enmi-conf.org