sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve JSDoc for media/views/spinner.js.

Browse Source 
Amends r42675 - includes the built media files.


git-svn-id: https://develop.svn.wordpress.org/trunk@42709 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Anton Timmermans 2018-02-13 15:44:14 +00:00
parent 56cef1dc9d
commit 6a81ffff31
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/wp-includes/js/media-views.js
View File

@ -9369,6 +9369,10 @@ module.exports = EditImage;
/** /**
* wp.media.view.Spinner * wp.media.view.Spinner
* *
* Represents a spinner in the Media Library.
*
* @since 3.9.0
*
* @memberOf wp.media.view * @memberOf wp.media.view
* *
* @class * @class
@ -9382,6 +9386,13 @@ var Spinner = wp.media.View.extend(/** @lends wp.media.view.Spinner.prototype */
spinnerTimeout: false, spinnerTimeout: false,
delay: 400, delay: 400,
/**
* Shows the spinner. Delays the visibility by the configured amount.
*
* @since 3.9.0
*
* @return {wp.media.view.Spinner} The spinner.
*/
show: function() { show: function() {
if ( ! this.spinnerTimeout ) { if ( ! this.spinnerTimeout ) {
this.spinnerTimeout = _.delay(function( $el ) { this.spinnerTimeout = _.delay(function( $el ) {
@ -9392,6 +9403,13 @@ var Spinner = wp.media.View.extend(/** @lends wp.media.view.Spinner.prototype */
return this; return this;
}, },
/**
* Hides the spinner.
*
* @since 3.9.0
*
* @return {wp.media.view.Spinner} The spinner.
*/
hide: function() { hide: function() {
this.$el.removeClass( 'is-active' ); this.$el.removeClass( 'is-active' );
this.spinnerTimeout = clearTimeout( this.spinnerTimeout ); this.spinnerTimeout = clearTimeout( this.spinnerTimeout );