MediaWiki:Gadget-mediawiki.toolbar.js

/** * Interface for the classic edit toolbar. * * Adapted from MediaWiki Core, before it was removed from it on 2018-10-17 */( function () {var toolbar, isReady, $toolbar, queue, slice, $currentFocused;/** * Internal helper that does the actual insertion of the button into the toolbar. * * For backwards-compatibility, passing `imageFile`, `speedTip`, `tagOpen`, `tagClose`, * `sampleText` and `imageId` as separate arguments (in this order) is also supported. * * @private * * @param {Object} button Object with the following properties. *  You are required to provide *either* the `onClick` parameter, or the three parameters *  `tagOpen`, `tagClose` and `sampleText`, but not both (they're mutually exclusive). * @param {string} [button.imageFile] Image to use for the button. * @param {string} button.speedTip Tooltip displayed when user mouses over the button. * @param {Function} [button.onClick] Function to be executed when the button is clicked. * @param {string} [button.tagOpen] * @param {string} [button.tagClose] * @param {string} [button.sampleText] Alternative to `onClick`. `tagOpen`, `tagClose` and *  `sampleText` together provide the markup that should be inserted into page text at *  current cursor position. * @param {string} [button.imageId] `id` attribute of the button HTML element. Can be *  used to define the image with CSS if it's not provided as `imageFile`. * @param {string} [speedTip] * @param {string} [tagOpen] * @param {string} [tagClose] * @param {string} [sampleText] * @param {string} [imageId] */function insertButton( button, speedTip, tagOpen, tagClose, sampleText, imageId ) {var $button;// Backwards compatibilityif ( typeof button !== 'object' ) {button = {imageFile: button,speedTip: speedTip,tagOpen: tagOpen,tagClose: tagClose,sampleText: sampleText,imageId: imageId};}if ( button.imageFile ) {$button = $( '<img>' ).attr( {src: button.imageFile,alt: button.speedTip,title: button.speedTip,id: button.imageId || undefined,'class': 'mw-toolbar-editbutton'} );} else {$button = $( '<div>' ).attr( {title: button.speedTip,id: button.imageId || undefined,'class': 'mw-toolbar-editbutton'} );}$button.click( function ( e ) {if ( button.onClick !== undefined ) {button.onClick( e );} else {toolbar.insertTags( button.tagOpen, button.tagClose, button.sampleText );}return false;} );$toolbar.append( $button );}isReady = false;$toolbar = false;/** * @private * @property {Array} * Contains button objects (and for backwards compatibility, it can * also contains an arguments array for insertButton). */queue = [];slice = queue.slice;toolbar = {/** * Add buttons to the toolbar. * * Takes care of race conditions and time-based dependencies by placing buttons in a queue if * this method is called before the toolbar is created. * * For backwards-compatibility, passing `imageFile`, `speedTip`, `tagOpen`, `tagClose`, * `sampleText` and `imageId` as separate arguments (in this order) is also supported. * * @inheritdoc #insertButton */addButton: function () {if ( isReady ) {insertButton.apply( toolbar, arguments );} else {// Convert arguments list to arrayqueue.push( slice.call( arguments ) );}},/** * Add multiple buttons to the toolbar (see also #addButton). * * Example usage: * *     addButtons( [ { .. }, { .. }, { .. } ] ); *     addButtons( { .. }, { .. } ); * * @param {...Object|Array} [buttons] An array of button objects or the first *  button object in a list of variadic arguments. */addButtons: function ( buttons ) {if ( !Array.isArray( buttons ) ) {buttons = slice.call( arguments );}if ( isReady ) {buttons.forEach( function ( button ) {insertButton( button );} );} else {// Push each button into the queuequeue.push.apply( queue, buttons );}},/** * Apply tagOpen/tagClose to selection in currently focused textarea. * * Uses `sampleText` if selection is empty. * * @param {string} tagOpen * @param {string} tagClose * @param {string} sampleText */insertTags: function ( tagOpen, tagClose, sampleText ) {if ( $currentFocused && $currentFocused.length ) {$currentFocused.textSelection('encapsulateSelection', {pre: tagOpen,peri: sampleText,post: tagClose});}}};// For backwards compatibility. Used to be called from EditPage.php, maybe other places as well.toolbar.init = $.noop;// Expose API publiclymw.toolbar = toolbar;$( function () {var $textBox, i, button;// Used to determine where to insert tags$currentFocused = $( '#wpTextbox1' );// Populate the selector cache for $toolbar$toolbar = $( '#toolbar' );if ( $toolbar.length === 0 ) {$textBox = $( '#wpTextbox1' );if ( $textBox.length === 0 ) {return;}$toolbar = $( '<div>' ).attr( { id: 'toolbar' } );$toolbar.insertBefore( $textBox );}for ( i = 0; i < queue.length; i++ ) {button = queue[ i ];if ( Array.isArray( button ) ) {// Forwarded arguments array from mw.toolbar.addButtoninsertButton.apply( toolbar, button );} else {// Raw object from mw.toolbar.addButtonsinsertButton( button );}}// Clear queuequeue.length = 0;// This causes further calls to addButton to go to insertion directly// instead of to the queue.// It is important that this is after the one and only loop through// the queueisReady = true;// Apply to dynamically created textboxes as well as normal ones$( document ).on( 'focus', 'textarea, input:text', function () {$currentFocused = $( this );} );} );}() );