Difference between revisions of MediaWiki:Gadget-legacyToolbar.js
Jump to navigation
Jump to search
(Created page with "/* _____________________________________________________________________________ * | | * |...") |
No edit summary |
||
Line 219: | Line 219: | ||
}() ); | }() ); | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/e/e2/Button_bold.png", | ||
speedTip: "Bold text", | speedTip: "Bold text", | ||
tagOpen: "'''", | tagOpen: "'''", | ||
Line 228: | Line 228: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/1/1d/Button_italic.png", | ||
speedTip: "Italic text", | speedTip: "Italic text", | ||
tagOpen: "''", | tagOpen: "''", | ||
Line 237: | Line 237: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/c/c0/Button_link.png", | ||
speedTip: "Internal link", | speedTip: "Internal link", | ||
tagOpen: "[[", | tagOpen: "[[", | ||
Line 246: | Line 246: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/e/ec/Button_extlink.png", | ||
speedTip: "External link", | speedTip: "External link", | ||
tagOpen: "[", | tagOpen: "[", | ||
Line 255: | Line 255: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/7/78/Button_head_A2.png", | ||
speedTip: "Level 2 header", | speedTip: "Level 2 header", | ||
tagOpen: "== ", | tagOpen: "== ", | ||
Line 264: | Line 264: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/d/de/Button_image.png", | ||
speedTip: "Image", | speedTip: "Image", | ||
tagOpen: "[[File:", | tagOpen: "[[File:", | ||
Line 273: | Line 273: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/1/19/Button_media.png", | ||
speedTip: "Media", | speedTip: "Media", | ||
tagOpen: "[[File:", | tagOpen: "[[File:", | ||
Line 282: | Line 282: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/8/82/Nowiki_icon.png", | ||
speedTip: "Nowiki tags", | speedTip: "Nowiki tags", | ||
tagOpen: "<nowiki"+">", | tagOpen: "<nowiki"+">", | ||
Line 291: | Line 291: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/6/6d/Button_sig.png", | ||
speedTip: "Signature and date", | speedTip: "Signature and date", | ||
tagOpen: "-- ~~"+"~~", | tagOpen: "-- ~~"+"~~", | ||
Line 300: | Line 300: | ||
mw.toolbar.addButton( { | mw.toolbar.addButton( { | ||
imageFile: " | imageFile: "upload.wikimedia.org/wikipedia/commons/0/0d/Button_hr.png", | ||
speedTip: "Horizontal line", | speedTip: "Horizontal line", | ||
tagOpen: "--"+"--", | tagOpen: "--"+"--", |
Revision as of 13:56, 13 June 2020
/* _____________________________________________________________________________ * | | * | === WARNING: GLOBAL GADGET FILE === | * | Changes to this page affect many users. | * | Please discuss changes on the talk page or on [[WT:Gadget]] before editing. | * |_____________________________________________________________________________| * * Adapted from MediaWiki Core, before it was removed from it on 2018-10-17. * Imported from frwiki at https://fr.wikipedia.org/wiki/MediaWiki:Gadget-mediawiki.toolbar.js, with translations and button additions. * * Interface for the classic edit toolbar. */ ( 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 compatibility if ( 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 array queue.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 queue queue.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 publicly mw.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.addButton insertButton.apply( toolbar, button ); } else { // Raw object from mw.toolbar.addButtons insertButton( button ); } } // Clear queue queue.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 queue isReady = true; mw.hook("mw.toolbar").fire(); // Apply to dynamically created textboxes as well as normal ones $( document ).on( 'focus', 'textarea, input:text', function () { $currentFocused = $( this ); } ); } ); }() ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/e/e2/Button_bold.png", speedTip: "Bold text", tagOpen: "'''", tagClose: "'''", sampleText: "bold text", imageId: "mw-editbutton-bold" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/1/1d/Button_italic.png", speedTip: "Italic text", tagOpen: "''", tagClose: "''", sampleText: "italic text", imageId: "mw-editbutton-italic" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/c/c0/Button_link.png", speedTip: "Internal link", tagOpen: "[[", tagClose: "]]", sampleText: "page title", imageId: "mw-editbutton-link" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/e/ec/Button_extlink.png", speedTip: "External link", tagOpen: "[", tagClose: "]", sampleText: "http://www.example.com link title", imageId: "mw-editbutton-extlink" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/7/78/Button_head_A2.png", speedTip: "Level 2 header", tagOpen: "== ", tagClose: " ==", sampleText: "header name", imageId: "mw-editbutton-headline" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/d/de/Button_image.png", speedTip: "Image", tagOpen: "[[File:", tagClose: "|thumb|Image description.]]", sampleText: "Example.jpg", imageId: "mw-editbutton-image" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/1/19/Button_media.png", speedTip: "Media", tagOpen: "[[File:", tagClose: "|thumb|Media description.]]", sampleText: "Example.ogg", imageId: "mw-editbutton-media" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/8/82/Nowiki_icon.png", speedTip: "Nowiki tags", tagOpen: "<nowiki"+">", tagClose: "</"+"nowiki>", sampleText: "", imageId: "mw-editbutton-nowiki" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/6/6d/Button_sig.png", speedTip: "Signature and date", tagOpen: "-- ~~"+"~~", tagClose: "", sampleText: "", imageId: "mw-editbutton-signature" } ); mw.toolbar.addButton( { imageFile: "upload.wikimedia.org/wikipedia/commons/0/0d/Button_hr.png", speedTip: "Horizontal line", tagOpen: "--"+"--", tagClose: "", sampleText: "", imageId: "mw-editbutton-hr" } );