diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2013-01-18 16:46:04 +0100 |
commit | 63601400e476c6cf43d985f3e7b9864681695ed4 (patch) | |
tree | f7846203a952e38aaf66989d0a4702779f549962 /resources/jquery/jquery.spinner.js | |
parent | 8ff01378c9e0207f9169b81966a51def645b6a51 (diff) |
Update to MediaWiki 1.20.2
this update includes:
* adjusted Arch Linux skin
* updated FluxBBAuthPlugin
* patch for https://bugzilla.wikimedia.org/show_bug.cgi?id=44024
Diffstat (limited to 'resources/jquery/jquery.spinner.js')
-rw-r--r-- | resources/jquery/jquery.spinner.js | 119 |
1 files changed, 85 insertions, 34 deletions
diff --git a/resources/jquery/jquery.spinner.js b/resources/jquery/jquery.spinner.js index 87e45382..4a6ec3b4 100644 --- a/resources/jquery/jquery.spinner.js +++ b/resources/jquery/jquery.spinner.js @@ -3,42 +3,93 @@ * * Simple jQuery plugin to create, inject and remove spinners. */ -( function( $ ) { +( function ( $ ) { -$.extend( { - /** - * Creates a spinner element. - * - * @param id {String} id of the spinner - * @return {jQuery} spinner - */ - createSpinner: function( id ) { - return $( '<div>' ).attr( { - id: 'mw-spinner-' + id, - 'class': 'mw-spinner', - title: '...' - } ); - }, + // Default options for new spinners, + // stored outside the function to share between calls. + var defaults = { + id: undefined, + size: 'small', + type: 'inline' + }; + + $.extend({ + /** + * Creates a spinner element. + * + * The argument is an object with options used to construct the spinner. These can be: + * + * It is a good practice to keep a reference to the created spinner to be able to remove it later. + * Alternatively one can use the id option and removeSpinner() (but make sure to choose an id + * that's unlikely to cause conflicts, e.g. with extensions, gadgets or user scripts). + * + * CSS classes used: + * .mw-spinner for every spinner + * .mw-spinner-small / .mw-spinner-large for size + * .mw-spinner-block / .mw-spinner-inline for display types + * + * @example + * // Create a large spinner reserving all available horizontal space. + * var $spinner = $.createSpinner({ size: 'large', type: 'block' }); + * // Insert above page content. + * $( '#mw-content-text' ).prepend( $spinner ); + * @example + * // Place a small inline spinner next to the "Save" button + * var $spinner = $.createSpinner({ size: 'small', type: 'inline' }); + * // Alternatively, just `$.createSpinner();` as these are the default options. + * $( '#wpSave' ).after( $spinner ); + * @example + * // The following two are equivalent: + * $.createSpinner( 'magic' ); + * $.createSpinner({ id: 'magic' }); + * + * @param {Object|String} opts [optional] ID string or options: + * - id: If given, spinner will be given an id of "mw-spinner-<id>" + * - size: 'small' (default) or 'large' for a 20-pixel or 32-pixel spinner + * - type: 'inline' (default) or 'block'. Inline creates an inline-block with width and + * height equal to spinner size. Block is a block-level element with width 100%, height + * equal to spinner size. + * @return {jQuery} + */ + createSpinner: function ( opts ) { + if ( opts !== undefined && $.type( opts ) !== 'object' ) { + opts = { + id: opts + }; + } + + opts = $.extend( {}, defaults, opts ); + + var $spinner = $( '<div>', { 'class': 'mw-spinner', 'title': '...' } ); + if ( opts.id !== undefined ) { + $spinner.attr( 'id', 'mw-spinner-' + opts.id ); + } + + $spinner.addClass( opts.size === 'large' ? 'mw-spinner-large' : 'mw-spinner-small' ); + $spinner.addClass( opts.type === 'block' ? 'mw-spinner-block' : 'mw-spinner-inline' ); + + return $spinner; + }, + + /** + * Removes a spinner element. + * + * @param {String} id [optional] Id of the spinner, as passed to createSpinner. + * @return {jQuery} The (now detached) spinner. + */ + removeSpinner: function ( id ) { + return $( '#mw-spinner-' + id ).remove(); + } + }); /** - * Removes a spinner element. + * Injects a spinner after the elements in the jQuery collection + * (as siblings, not children). Collection contents remain unchanged. * - * @param id {String} - * @return {jQuery} spinner + * @param {Object} opts See createSpinner() for description. + * @return {jQuery} */ - removeSpinner: function( id ) { - return $( '#mw-spinner-' + id ).remove(); - } -} ); - -/** - * Injects a spinner after the elements in the jQuery collection. - * - * @param id String id of the spinner - * @return {jQuery} - */ -$.fn.injectSpinner = function( id ) { - return this.after( $.createSpinner( id ) ); -}; - -} )( jQuery ); + $.fn.injectSpinner = function ( opts ) { + return this.after( $.createSpinner( opts ) ); + }; +}( jQuery ) ); |