Merge "mediawiki.util: Add JS-handler usage example for addPortletLink()"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Fri, 22 Jan 2016 22:10:10 +0000 (22:10 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Fri, 22 Jan 2016 22:10:10 +0000 (22:10 +0000)
resources/src/mediawiki/mediawiki.util.js

index f9810f9..cc983e4 100644 (file)
                 * (e.g. `'#foobar'`) for that item.
                 *
                 *     mw.util.addPortletLink(
-                *         'p-tb', 'http://mediawiki.org/',
-                *         'MediaWiki.org', 't-mworg', 'Go to MediaWiki.org ', 'm', '#t-print'
+                *         'p-tb', 'https://www.mediawiki.org/',
+                *         'mediawiki.org', 't-mworg', 'Go to mediawiki.org', 'm', '#t-print'
                 *     );
                 *
+                *     var node = mw.util.addPortletLink(
+                *         'p-tb',
+                *         new mw.Title( 'Special:Example' ).getUrl(),
+                *         'Example'
+                *     );
+                *     $( node ).on( 'click', function ( e ) {
+                *         console.log( 'Example' );
+                *         e.preventDefault();
+                *     } );
+                *
                 * @param {string} portlet ID of the target portlet ( 'p-cactions' or 'p-personal' etc.)
                 * @param {string} href Link URL
                 * @param {string} text Link text