--- a/wp/wp-admin/js/image-edit.js Tue Oct 22 16:11:46 2019 +0200
+++ b/wp/wp-admin/js/image-edit.js Tue Dec 15 13:49:49 2020 +0100
@@ -5,9 +5,10 @@
* @output wp-admin/js/image-edit.js
*/
- /* global imageEditL10n, ajaxurl, confirm */
+ /* global ajaxurl, confirm */
(function($) {
+ var __ = wp.i18n.__;
/**
* Contains all the methods to initialise and control the image editor.
@@ -48,8 +49,9 @@
/**
* Converts a value to an integer.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {number} f The float value that should be converted.
*
@@ -66,17 +68,18 @@
/**
* Adds the disabled attribute and class to a single form element or a field set.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {jQuery} el The element that should be modified.
- * @param {bool|number} s The state for the element. If set to true
+ * @param {boolean|number} s The state for the element. If set to true
* the element is disabled,
* otherwise the element is enabled.
* The function is sometimes called with a 0 or 1
* instead of true or false.
*
- * @returns {void}
+ * @return {void}
*/
setDisabled : function( el, s ) {
/*
@@ -95,12 +98,13 @@
/**
* Initializes the image editor.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
*
- * @returns {void}
+ * @return {void}
*/
init : function(postid) {
var t = this, old = $('#image-editor-' + t.postid),
@@ -121,50 +125,60 @@
$('input[type="text"]', '#imgedit-panel-' + postid).keypress(function(e) {
var k = e.keyCode;
- // Key codes 37 thru 40 are the arrow keys.
+ // Key codes 37 through 40 are the arrow keys.
if ( 36 < k && k < 41 ) {
$(this).blur();
}
- // The key code 13 is the enter key.
+ // The key code 13 is the Enter key.
if ( 13 === k ) {
e.preventDefault();
e.stopPropagation();
return false;
}
});
+
+ $( document ).on( 'image-editor-ui-ready', this.focusManager );
},
/**
* Toggles the wait/load icon in the editor.
*
+ * @since 2.9.0
+ * @since 5.5.0 Added the triggerUIReady parameter.
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
- * @param {number} toggle Is 0 or 1, fades the icon in then 1 and out when 0.
+ * @param {number} postid The post ID.
+ * @param {number} toggle Is 0 or 1, fades the icon in when 1 and out when 0.
+ * @param {boolean} triggerUIReady Whether to trigger a custom event when the UI is ready. Default false.
*
- * @returns {void}
+ * @return {void}
*/
- toggleEditor : function(postid, toggle) {
+ toggleEditor: function( postid, toggle, triggerUIReady ) {
var wait = $('#imgedit-wait-' + postid);
if ( toggle ) {
wait.fadeIn( 'fast' );
} else {
- wait.fadeOut('fast');
+ wait.fadeOut( 'fast', function() {
+ if ( triggerUIReady ) {
+ $( document ).trigger( 'image-editor-ui-ready' );
+ }
+ } );
}
},
/**
* Shows or hides the image edit help box.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {HTMLElement} el The element to create the help window in.
*
- * @returns {boolean} Always returns false.
+ * @return {boolean} Always returns false.
*/
toggleHelp : function(el) {
var $el = $( el );
@@ -181,13 +195,14 @@
* The image edit target contains the image sizes where the (possible) changes
* have to be applied to.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
*
- * @returns {string} The value from the imagedit-save-target input field when available,
- * or 'full' when not available.
+ * @return {string} The value from the imagedit-save-target input field when available,
+ * or 'full' when not available.
*/
getTarget : function(postid) {
return $('input[name="imgedit-target-' + postid + '"]:checked', '#imgedit-save-target-' + postid).val() || 'full';
@@ -198,15 +213,16 @@
*
* If the original image size is exceeded a red exclamation mark is shown.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The current post id.
+ * @param {number} postid The current post ID.
* @param {number} x Is 0 when it applies the y-axis
* and 1 when applicable for the x-axis.
* @param {jQuery} el Element.
*
- * @returns {void}
+ * @return {void}
*/
scaleChanged : function( postid, x, el ) {
var w = $('#imgedit-scale-width-' + postid), h = $('#imgedit-scale-height-' + postid),
@@ -234,12 +250,13 @@
/**
* Gets the selected aspect ratio.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
*
- * @returns {string} The aspect ratio.
+ * @return {string} The aspect ratio.
*/
getSelRatio : function(postid) {
var x = this.hold.w, y = this.hold.h,
@@ -261,13 +278,14 @@
* Removes the last action from the image edit history.
* The history consist of (edit) actions performed on the image.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {number} setSize 0 or 1, when 1 the image resets to its original size.
*
- * @returns {string} JSON string containing the history or an empty string if no history exists.
+ * @return {string} JSON string containing the history or an empty string if no history exists.
*/
filterHistory : function(postid, setSize) {
// Apply undo state to history.
@@ -295,13 +313,13 @@
// Restore original 'o'.
o = history[history.length - 1];
- // c = 'crop', r = 'rotate', f = 'flip'
+ // c = 'crop', r = 'rotate', f = 'flip'.
o = o.c || o.r || o.f || false;
if ( o ) {
- // fw = Full image width
+ // fw = Full image width.
this.hold.w = o.fw;
- // fh = Full image height
+ // fh = Full image height.
this.hold.h = o.fh;
}
}
@@ -326,14 +344,15 @@
*
* When the image source is reloaded the image will be reloaded.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce to verify the request.
* @param {function} callback Function to execute when the image is loaded.
*
- * @returns {void}
+ * @return {void}
*/
refreshEditor : function(postid, nonce, callback) {
var t = this, data, img;
@@ -371,7 +390,7 @@
parent.empty().append(img);
- // w, h are the new full size dims
+ // w, h are the new full size dimensions.
max1 = Math.max( t.hold.w, t.hold.h );
max2 = Math.max( $(img).width(), $(img).height() );
t.hold.sizer = max1 > max2 ? max2 / max1 : 1;
@@ -390,27 +409,34 @@
t.toggleEditor(postid, 0);
})
- .on('error', function() {
- $('#imgedit-crop-' + postid).empty().append('<div class="error"><p>' + imageEditL10n.error + '</p></div>');
- t.toggleEditor(postid, 0);
- })
+ .on( 'error', function() {
+ var errorMessage = __( 'Could not load the preview image. Please reload the page and try again.' );
+
+ $( '#imgedit-crop-' + postid )
+ .empty()
+ .append( '<div class="notice notice-error" tabindex="-1" role="alert"><p>' + errorMessage + '</p></div>' );
+
+ t.toggleEditor( postid, 0, true );
+ wp.a11y.speak( errorMessage, 'assertive' );
+ } )
.attr('src', ajaxurl + '?' + $.param(data));
},
/**
* Performs an image edit action.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
- * @param {string} nonce The nonce to verify the request.
- * @param {string} action The action to perform on the image.
- * The possible actions are: "scale" and "restore".
+ * @param {number} postid The post ID.
+ * @param {string} nonce The nonce to verify the request.
+ * @param {string} action The action to perform on the image.
+ * The possible actions are: "scale" and "restore".
*
- * @returns {boolean|void} Executes a post request that refreshes the page
- * when the action is performed.
- * Returns false if a invalid action is given,
- * or when the action cannot be performed.
+ * @return {boolean|void} Executes a post request that refreshes the page
+ * when the action is performed.
+ * Returns false if a invalid action is given,
+ * or when the action cannot be performed.
*/
action : function(postid, nonce, action) {
var t = this, data, w, h, fw, fh;
@@ -453,28 +479,39 @@
}
t.toggleEditor(postid, 1);
- $.post(ajaxurl, data, function(r) {
- $('#image-editor-' + postid).empty().append(r);
- t.toggleEditor(postid, 0);
- // refresh the attachment model so that changes propagate
+ $.post( ajaxurl, data, function( response ) {
+ $( '#image-editor-' + postid ).empty().append( response.data.html );
+ t.toggleEditor( postid, 0, true );
+ // Refresh the attachment model so that changes propagate.
if ( t._view ) {
t._view.refresh();
}
- });
+ } ).done( function( response ) {
+ // Whether the executed action was `scale` or `restore`, the response does have a message.
+ if ( response && response.data.message.msg ) {
+ wp.a11y.speak( response.data.message.msg );
+ return;
+ }
+
+ if ( response && response.data.message.error ) {
+ wp.a11y.speak( response.data.message.error );
+ }
+ } );
},
/**
* Stores the changes that are made to the image.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id to get the image from the database.
+ * @param {number} postid The post ID to get the image from the database.
* @param {string} nonce The nonce to verify the request.
*
- * @returns {boolean|void} If the actions are successfully saved a response message is shown.
- * Returns false if there is no image editing history,
- * thus there are not edit-actions performed on the image.
+ * @return {boolean|void} If the actions are successfully saved a response message is shown.
+ * Returns false if there is no image editing history,
+ * thus there are not edit-actions performed on the image.
*/
save : function(postid, nonce) {
var data,
@@ -497,27 +534,30 @@
'do': 'save'
};
// Post the image edit data to the backend.
- $.post(ajaxurl, data, function(r) {
- // Read the response.
- var ret = JSON.parse(r);
+ $.post( ajaxurl, data, function( response ) {
+ // If a response is returned, close the editor and show an error.
+ if ( response.data.error ) {
+ $( '#imgedit-response-' + postid )
+ .html( '<div class="notice notice-error" tabindex="-1" role="alert"><p>' + response.data.error + '</p></div>' );
- // If a response is returned, close the editor and show an error.
- if ( ret.error ) {
- $('#imgedit-response-' + postid).html('<div class="error"><p>' + ret.error + '</p></div>');
imageEdit.close(postid);
+ wp.a11y.speak( response.data.error );
return;
}
- if ( ret.fw && ret.fh ) {
- $('#media-dims-' + postid).html( ret.fw + ' × ' + ret.fh );
+ if ( response.data.fw && response.data.fh ) {
+ $( '#media-dims-' + postid ).html( response.data.fw + ' × ' + response.data.fh );
}
- if ( ret.thumbnail ) {
- $('.thumbnail', '#thumbnail-head-' + postid).attr('src', ''+ret.thumbnail);
+ if ( response.data.thumbnail ) {
+ $( '.thumbnail', '#thumbnail-head-' + postid ).attr( 'src', '' + response.data.thumbnail );
}
- if ( ret.msg ) {
- $('#imgedit-response-' + postid).html('<div class="updated"><p>' + ret.msg + '</p></div>');
+ if ( response.data.msg ) {
+ $( '#imgedit-response-' + postid )
+ .html( '<div class="notice notice-success" tabindex="-1" role="alert"><p>' + response.data.msg + '</p></div>' );
+
+ wp.a11y.speak( response.data.msg );
}
if ( self._view ) {
@@ -531,21 +571,25 @@
/**
* Creates the image edit window.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id for the image.
+ * @param {number} postid The post ID for the image.
* @param {string} nonce The nonce to verify the request.
- * @param {object} view The image editor view to be used for the editing.
+ * @param {Object} view The image editor view to be used for the editing.
*
- * @returns {void|promise} Either returns void if the button was already activated
- * or returns an instance of the image editor, wrapped in a promise.
+ * @return {void|promise} Either returns void if the button was already activated
+ * or returns an instance of the image editor, wrapped in a promise.
*/
open : function( postid, nonce, view ) {
this._view = view;
- var dfd, data, elem = $('#image-editor-' + postid), head = $('#media-head-' + postid),
- btn = $('#imgedit-open-btn-' + postid), spin = btn.siblings('.spinner');
+ var dfd, data,
+ elem = $( '#image-editor-' + postid ),
+ head = $( '#media-head-' + postid ),
+ btn = $( '#imgedit-open-btn-' + postid ),
+ spin = btn.siblings( '.spinner' );
/*
* Instead of disabling the button, which causes a focus loss and makes screen
@@ -564,23 +608,37 @@
'do': 'open'
};
- dfd = $.ajax({
+ dfd = $.ajax( {
url: ajaxurl,
type: 'post',
data: data,
beforeSend: function() {
btn.addClass( 'button-activated' );
}
- }).done(function( html ) {
- elem.html( html );
- head.fadeOut('fast', function(){
- elem.fadeIn('fast');
+ } ).done( function( response ) {
+ var errorMessage;
+
+ if ( '-1' === response ) {
+ errorMessage = __( 'Could not load the preview image.' );
+ elem.html( '<div class="notice notice-error" tabindex="-1" role="alert"><p>' + errorMessage + '</p></div>' );
+ }
+
+ if ( response.data && response.data.html ) {
+ elem.html( response.data.html );
+ }
+
+ head.fadeOut( 'fast', function() {
+ elem.fadeIn( 'fast', function() {
+ if ( errorMessage ) {
+ $( document ).trigger( 'image-editor-ui-ready' );
+ }
+ } );
btn.removeClass( 'button-activated' );
spin.removeClass( 'is-active' );
- });
+ } );
// Initialise the Image Editor now that everything is ready.
imageEdit.init( postid );
- });
+ } );
return dfd;
},
@@ -588,12 +646,13 @@
/**
* Initializes the cropping tool and sets a default cropping selection.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
*
- * @returns {void}
+ * @return {void}
*/
imgLoaded : function(postid) {
var img = $('#image-preview-' + postid), parent = $('#imgedit-crop-' + postid);
@@ -606,30 +665,60 @@
this.initCrop(postid, img, parent);
this.setCropSelection( postid, { 'x1': 0, 'y1': 0, 'x2': 0, 'y2': 0, 'width': img.innerWidth(), 'height': img.innerHeight() } );
- this.toggleEditor(postid, 0);
- // Editor is ready, move focus to the first focusable element.
- $( '.imgedit-wrap .imgedit-help-toggle' ).eq( 0 ).focus();
+ this.toggleEditor( postid, 0, true );
+ },
+
+ /**
+ * Manages keyboard focus in the Image Editor user interface.
+ *
+ * @since 5.5.0
+ *
+ * @return {void}
+ */
+ focusManager: function() {
+ /*
+ * Editor is ready. Move focus to one of the admin alert notices displayed
+ * after a user action or to the first focusable element. Since the DOM
+ * update is pretty large, the timeout helps browsers update their
+ * accessibility tree to better support assistive technologies.
+ */
+ setTimeout( function() {
+ var elementToSetFocusTo = $( '.notice[role="alert"]' );
+
+ if ( ! elementToSetFocusTo.length ) {
+ elementToSetFocusTo = $( '.imgedit-wrap' ).find( ':tabbable:first' );
+ }
+
+ elementToSetFocusTo.focus();
+ }, 100 );
},
/**
* Initializes the cropping tool.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {HTMLElement} image The preview image.
* @param {HTMLElement} parent The preview image container.
*
- * @returns {void}
+ * @return {void}
*/
initCrop : function(postid, image, parent) {
var t = this,
selW = $('#imgedit-sel-width-' + postid),
selH = $('#imgedit-sel-height-' + postid),
+ $image = $( image ),
$img;
- t.iasapi = $(image).imgAreaSelect({
+ // Already initialized?
+ if ( $image.data( 'imgAreaSelect' ) ) {
+ return;
+ }
+
+ t.iasapi = $image.imgAreaSelect({
parent: parent,
instance: true,
handles: true,
@@ -645,15 +734,15 @@
* @param {jQuery} img The preview image.
*/
onInit: function( img ) {
- // Ensure that the imgAreaSelect wrapper elements are position:absolute.
- // (even if we're in a position:fixed modal)
+ // Ensure that the imgAreaSelect wrapper elements are position:absolute
+ // (even if we're in a position:fixed modal).
$img = $( img );
$img.next().css( 'position', 'absolute' )
.nextAll( '.imgareaselect-outer' ).css( 'position', 'absolute' );
/**
* Binds mouse down event to the cropping container.
*
- * @returns {void}
+ * @return {void}
*/
parent.children().on( 'mousedown, touchstart', function(e){
var ratio = false, sel, defRatio;
@@ -675,7 +764,7 @@
*
* @ignore
*
- * @returns {void}
+ * @return {void}
*/
onSelectStart: function() {
imageEdit.setDisabled($('#imgedit-crop-sel-' + postid), 1);
@@ -685,10 +774,10 @@
*
* @ignore
*
- * @param {object} img jQuery object representing the image.
- * @param {object} c The selection.
+ * @param {Object} img jQuery object representing the image.
+ * @param {Object} c The selection.
*
- * @returns {object}
+ * @return {Object}
*/
onSelectEnd: function(img, c) {
imageEdit.setCropSelection(postid, c);
@@ -699,10 +788,10 @@
*
* @ignore
*
- * @param {object} img jQuery object representing the image.
- * @param {object} c The selection.
+ * @param {Object} img jQuery object representing the image.
+ * @param {Object} c The selection.
*
- * @returns {void}
+ * @return {void}
*/
onSelectChange: function(img, c) {
var sizer = imageEdit.hold.sizer;
@@ -715,13 +804,14 @@
/**
* Stores the current crop selection.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
- * @param {object} c The selection.
+ * @param {number} postid The post ID.
+ * @param {Object} c The selection.
*
- * @returns {boolean}
+ * @return {boolean}
*/
setCropSelection : function(postid, c) {
var sel;
@@ -746,13 +836,14 @@
/**
* Closes the image editor.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
- * @param {bool} warn Warning message.
+ * @param {number} postid The post ID.
+ * @param {boolean} warn Warning message.
*
- * @returns {void|bool} Returns false if there is a warning.
+ * @return {void|boolean} Returns false if there is a warning.
*/
close : function(postid, warn) {
warn = warn || false;
@@ -764,13 +855,14 @@
this.iasapi = {};
this.hold = {};
- // If we've loaded the editor in the context of a Media Modal, then switch to the previous view,
- // whatever that might have been.
+ // If we've loaded the editor in the context of a Media Modal,
+ // then switch to the previous view, whatever that might have been.
if ( this._view ){
this._view.back();
}
- // In case we are not accessing the image editor in the context of a View, close the editor the old-skool way
+ // In case we are not accessing the image editor in the context of a View,
+ // close the editor the old-school way.
else {
$('#image-editor-' + postid).fadeOut('fast', function() {
$( '#media-head-' + postid ).fadeIn( 'fast', function() {
@@ -787,12 +879,13 @@
/**
* Checks if the image edit history is saved.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
*
- * @returns {boolean} Returns true if the history is not saved.
+ * @return {boolean} Returns true if the history is not saved.
*/
notsaved : function(postid) {
var h = $('#imgedit-history-' + postid).val(),
@@ -811,14 +904,15 @@
/**
* Adds an image edit action to the history.
*
- * @memberof imageEdit
- * @since 2.9.0
+ * @since 2.9.0
*
- * @param {object} op The original position.
- * @param {number} postid The post id.
+ * @memberof imageEdit
+ *
+ * @param {Object} op The original position.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
*
- * @returns {void}
+ * @return {void}
*/
addStep : function(op, postid, nonce) {
var t = this, elem = $('#imgedit-history-' + postid),
@@ -830,7 +924,7 @@
history.pop();
pop--;
}
- undone.val(0); // reset
+ undone.val(0); // Reset.
history.push(op);
elem.val( JSON.stringify(history) );
@@ -844,15 +938,16 @@
/**
* Rotates the image.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {string} angle The angle the image is rotated with.
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
- * @param {object} t The target element.
+ * @param {Object} t The target element.
*
- * @returns {boolean}
+ * @return {boolean}
*/
rotate : function(angle, postid, nonce, t) {
if ( $(t).hasClass('disabled') ) {
@@ -865,15 +960,16 @@
/**
* Flips the image.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {number} axis The axle the image is flipped on.
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
- * @param {object} t The target element.
+ * @param {Object} t The target element.
*
- * @returns {boolean}
+ * @return {boolean}
*/
flip : function (axis, postid, nonce, t) {
if ( $(t).hasClass('disabled') ) {
@@ -886,14 +982,15 @@
/**
* Crops the image.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
- * @param {object} t The target object.
+ * @param {Object} t The target object.
*
- * @returns {void|boolean} Returns false if the crop button is disabled.
+ * @return {void|boolean} Returns false if the crop button is disabled.
*/
crop : function (postid, nonce, t) {
var sel = $('#imgedit-selection-' + postid).val(),
@@ -915,13 +1012,14 @@
/**
* Undoes an image edit action.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
*
- * @returns {void|false} Returns false if the undo button is disabled.
+ * @return {void|false} Returns false if the undo button is disabled.
*/
undo : function (postid, nonce) {
var t = this, button = $('#image-undo-' + postid), elem = $('#imgedit-undone-' + postid),
@@ -948,13 +1046,14 @@
/**
* Reverts a undo action.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {string} nonce The nonce.
*
- * @returns {void}
+ * @return {void}
*/
redo : function(postid, nonce) {
var t = this, button = $('#image-redo-' + postid), elem = $('#imgedit-undone-' + postid),
@@ -978,15 +1077,16 @@
/**
* Sets the selection for the height and width in pixels.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {jQuery} el The element containing the values.
*
- * @returns {void|boolean} Returns false when the x or y value is lower than 1,
- * void when the value is not numeric or when the operation
- * is successful.
+ * @return {void|boolean} Returns false when the x or y value is lower than 1,
+ * void when the value is not numeric or when the operation
+ * is successful.
*/
setNumSelection : function( postid, el ) {
var sel, elX = $('#imgedit-sel-width-' + postid), elY = $('#imgedit-sel-height-' + postid),
@@ -1035,12 +1135,13 @@
/**
* Rounds a number to a whole.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
* @param {number} num The number.
*
- * @returns {number} The number rounded to a whole number.
+ * @return {number} The number rounded to a whole number.
*/
round : function(num) {
var s;
@@ -1064,14 +1165,15 @@
/**
* Sets a locked aspect ratio for the selection.
*
+ * @since 2.9.0
+ *
* @memberof imageEdit
- * @since 2.9.0
*
- * @param {number} postid The post id.
+ * @param {number} postid The post ID.
* @param {number} n The ratio to set.
* @param {jQuery} el The element containing the values.
*
- * @returns {void}
+ * @return {void}
*/
setRatioSelection : function(postid, n, el) {
var sel, r, x = this.intval( $('#imgedit-crop-width-' + postid).val() ),
@@ -1079,6 +1181,10 @@
h = $('#image-preview-' + postid).height();
if ( false === this.validateNumeric( el ) ) {
+ this.iasapi.setOptions({
+ aspectRatio: null
+ });
+
return;
}
@@ -1108,13 +1214,14 @@
/**
* Validates if a value in a jQuery.HTMLElement is numeric.
*
+ * @since 4.6.0
+ *
* @memberof imageEdit
- * @since 4.6
*
* @param {jQuery} el The html element.
*
- * @returns {void|boolean} Returns false if the value is not numeric,
- * void when it is.
+ * @return {void|boolean} Returns false if the value is not numeric,
+ * void when it is.
*/
validateNumeric: function( el ) {
if ( ! this.intval( $( el ).val() ) ) {