Merge "Language: s/error_log/wfWarn/"

[lhc/web/wiklou.git] / resources / src / mediawiki.action / mediawiki.action.edit.js

diff --git a/resources/src/mediawiki.action/mediawiki.action.edit.js b/resources/src/mediawiki.action/mediawiki.action.edit.js
index a575844..e850276 100644 (file)
--- a/resources/src/mediawiki.action/mediawiki.action.edit.js
+++ b/resources/src/mediawiki.action/mediawiki.action.edit.js
@@ -34,8 +34,13 @@
                        title: b.speedTip,
                        id: b.imageId || undefined,
                        'class': 'mw-toolbar-editbutton'
-               } ).click( function () {
-                       toolbar.insertTags( b.tagOpen, b.tagClose, b.sampleText );
+               } ).click( function ( e ) {
+                       if ( b.onClick !== undefined ) {
+                               b.onClick( e );
+                       } else {
+                               toolbar.insertTags( b.tagOpen, b.tagClose, b.sampleText );
+                       }
+
                        return false;
                } );
 
@@ -44,6 +49,7 @@
 
        isReady = false;
        $toolbar = false;
+
        /**
         * @private
         * @property {Array}
@@ -62,16 +68,21 @@
                 * by placing buttons in a queue if this method is called before
                 * the toolbar is created.
                 *
-                * For compatiblity, passing the properties listed below as separate arguments
-                * (in the listed order) is also supported.
+                * For backwards-compatibility, passing `imageFile`, `speedTip`, `tagOpen`, `tagClose`,
+                * `sampleText` and `imageId` as separate arguments (in this order) is also supported.
                 *
-                * @param {Object} button Object with the following properties:
-                * @param {string} button.imageFile
-                * @param {string} button.speedTip
-                * @param {string} button.tagOpen
-                * @param {string} button.tagClose
-                * @param {string} button.sampleText
-                * @param {string} [button.imageId]
+                * @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.
                 */
                addButton: function () {
                        if ( isReady ) {
@@ -82,7 +93,10 @@
                        }
                },
                /**
+                * Add multiple buttons to the toolbar (see also #addButton).
+                *
                 * Example usage:
+                *
                 *     addButtons( [ { .. }, { .. }, { .. } ] );
                 *     addButtons( { .. }, { .. } );
                 *
@@ -179,13 +193,13 @@
                        }
                        $editForm.submit( function () {
                                scrollTop.value = editBox.scrollTop;
-                       });
+                       } );
                }
 
                // Apply to dynamically created textboxes as well as normal ones
                $( document ).on( 'focus', 'textarea, input:text', function () {
                        $currentFocused = $( this );
                } );
-       });
+       } );
 
 }( mediaWiki, jQuery ) );