ResourceLoader/Core modules
ResourceLoader |
---|
Reference |
Tutorials |
This page lists modules that ship with MediaWiki core by default. It reflects the current development version of MediaWiki and may vary from the latest stable release. For older modules, see the Migration guide.
The modules jquery
and mediawiki
together form the base environment ("startup") and are always present. They must not be declared as dependencies.
mediawiki[edit source]
This is the MediaWiki base module. It initialises the mw
global object.
mw.config[edit source]
For a list of stable config keys to read from mw.config
, see Manual:Interface/JavaScript.
// Check existence
if ( mw.config.exists( 'wgGlobalGroups' ) ) {
// CentralNotice has registered this variable...
}
// Or just a plain access for comparison
// (no need to check exists first, it falls back to null)
if ( mw.config.get( 'wgPageName' ) === 'ResourceLoader' ) {
// Do stuff...
}
/* Access multiple ones for use throughout a larger code base
Returns an array containing the variables requested. */
var conf = mw.config.get([
'wgServer',
'wgPageName',
'wgCanonicalSpecialPageName',
'wgUserLanguage'
]);
if ( conf.wgCanonicalSpecialPageName === 'Blankpage' ) {
// Do stuff...
}
mw.hook[edit source]
MediaWiki version: | ≥ 1.22 r56762 |
A framework for registering and firing events in JavaScript (as opposed to doing everything on document ready). For example, the snippet below provides a message once the categories on a page load:
mw.hook( 'wikipage.categories' ).add( function ( $content ) {
if ( mw.config.get( 'wgCategories' ).length === 0 ) {
alert( 'Please add categories to this page' );
}
} );
In user scripts and gadgets you can fire hooks/events prefixed by "userjs.". E.g.:
function MyScriptInit() {
var simpleVariable = 'done';
var objectPassed = { me: this };
mw.hook( 'userjs.myScript.postInit' ).fire( simpleVariable, objectPassed );
}
//...
Then you subscribe to this event like so:
// here we receive both variables (but we skip them too)
mw.hook( 'userjs.myScript.postInit' ).add( function ( simple, objectPassed ) {
//...
} );
hook execution order[edit source]
Note that hooks are run in a sequence (and in place where they are fired).
function MyGadget() {
var objectPassed = {
abc: 'default'
};
this.objectPassed = objectPassed;
console.log('before hooks', objectPassed)
mw.hook('userjs.MyGadget.postInit').fire(objectPassed);
console.log('after hooks', objectPassed)
}
mw.hook('userjs.MyGadget.postInit').add(function(objectPassed) {
objectPassed.abc = 'changed in hook';
console.log('inside a hook', objectPassed)
});
(function() {
console.log('before init');
var gadget = new MyGadget();
console.log('after init', gadget.objectPassed)
})()
Above will result in following order:
- before init
- before hooks, Object { abc: "default" }
- inside a hook, Object { abc: "changed in hook" }
- after hooks, Object { abc: "changed in hook" }
- after init, Object { abc: "changed in hook" }
mw.html[edit source]
Helper functions for escaping and creating strings of HTML.
mw.loader[edit source]
mw.loader.load[edit source]
Load one or more modules, a script or a stylesheet. To load an external script or stylesheet, the URL must start with either "http://
", "https://
" or "//
" (protocol-relative), or "/
" (local path). Provide a MIME-type as second parameter (either "text/javascript
" or "text/css
"). If no MIME-type is provided, the default "text/javascript
" is assumed. mw.loader
creates an asynchronous request, if you need to run code that depends on a module, use mw.loader.using instead (which provides a callback). If you need a callback from an external script, use mw.loader.getScript (or jQuery.getScript
).
Loader instructions represent the intent that a module by that name should be loaded. It will not load the same module a second time if it has already been loaded previously. This does not apply to scripts and stylesheets – they will be loaded each time, even if loaded previously. If a script defines window.Foo
, you can use ( window.Foo !== undefined )
to check if that script has already been loaded.
// Module by name
mw.loader.load( 'oojs' );
// Multiple modules
mw.loader.load( [ 'oojs', 'mediawiki.Title' ] );
// Local gadget module. These must be defined in [[MediaWiki:Gadgets-definition]].
mw.loader.load( 'ext.gadget.Navigation_popups' );
// JavaScript page
mw.loader.load( 'https://www.mediawiki.org/w/index.php?title=MediaWiki:Gadget-UTCLiveClock.js&action=raw&ctype=text/javascript' );
mw.loader.load( 'https://commons.wikimedia.org/w/index.php?title=MediaWiki:Gadget-HotCat.js&action=raw&ctype=text/javascript' );
// CSS stylesheet
mw.loader.load( 'https://en.wikipedia.org/w/index.php?title=User:Example/custom-foo.css&action=raw&ctype=text/css', 'text/css' );
// CSS stylesheet from wiki page using getUrl method
mw.loader.load( mw.util.getUrl( 'MediaWiki:Foo.css', { action:'raw' } ) + '&ctype=text/css' , 'text/css' );
// External stylesheet
mw.loader.load( 'https://wiki.example/mystyles.css', 'text/css' );
mw.loader.using[edit source]
Load one or more modules, and execute a function once those modules are loaded. See JS Documentation
mw.loader.getScript[edit source]
MediaWiki version: | ≥ 1.33 Gerrit change 487566 |
Load a script by URL. Returns a jQuery promise object which can be used to specify callbacks.
Example:
mw.loader.getScript( 'https://example.org/x-1.0.0.js' )
.then(
function () {
// Script succeeded. You can use X now.
},
function ( e ) {
// Script failed. X is not available
mw.log.error( e.message ); // => "Failed to load script"
}
);
To get a single callback from multiple promises, use jQuery.when
or Promise.all
$.when(
mw.loader.getScript( 'https://example.org/x-1.0.0.js' ),
mw.loader.getScript( 'https://example.org/y-2.0.0.js' )
)
.then(
function () {
// Both script succeeded. You can use X and Y now.
},
function ( e ) {
// A script failed, and is not available
mw.log.error( e.message ); // => "Failed to load script"
}
);
mw.inspect[edit source]
MediaWiki version: | ≥ 1.32 |
Shortcut for mw.inspect.runReports. Shows in the console a list of all ResourceLoader modules that are loaded on this page, sorted by the total size of each module's JavaScript, CSS, etc.
mw.log[edit source]
Collection of methods to help log messages to the console.
mw.message[edit source]
If the mediawiki.jqueryMsg
module is loaded, the behaviour of this module changes significantly. See above link.
mw.now[edit source]
MediaWiki version: | ≥ 1.23 Gerrit change 99547 |
Get the current time, measured in milliseconds since January 1, 1970 (UTC).
On browsers that implement the Navigation Timing API, this function will produce floating-point values with microsecond precision that are guaranteed to be monotonic. On all other browsers, it will fall back to using Date
.
var totalTime, time = mw.now();
// some expensive code
totalTime = mw.now() - time;
mw.track[edit source]
MediaWiki version: | ≥ 1.23 Gerrit change 99547 |
Track an analytic event.
This method provides a generic means for MediaWiki JavaScript code to capture state information for analysis. Each logged event specifies a string topic name that describes the kind of event that it is. Topic names consist of dot-separated path components, arranged from most general to most specific. Each path component should have a clear and well-defined purpose. Data handlers are registered via `mw.trackSubscribe`, and receive the full set of events that match their subscription, including those that fired before the handler was bound.
The WikimediaEvents extension demonstrates how to add a subscriber for the "timing" and "counter" topics (example).
var totalTime, time = mw.now();
// some expensive code
totalTime = mw.now() - time;
mw.track( 'timing.MediaWiki.foo.bar', totalTime );
mw.notify[edit source]
MediaWiki version: | ≥ 1.20 Gerrit change 19199 |
Creates bubble notifications. Basic examples:
mw.notify( 'This is a notification.' ); // Send a plaintext notification
mw.notify( mw.message( 'some-message' ) ); // Use an i18n message to send a notification
mw.notify( $( '<span>This is an <u>HTML</u> notification.</span>' ) ); // Send an HTML notification with a jQuery instance (a DOM node also works)
mw.notify( 'Test', { title: 'Title!' } ); // Give the notification a title
mw.notify( 'Test', { autoHide: false } ); // Don't automatically hide the notification
mw.notify( 'Test', { tag: 'foobar' } ); // Send a notification tagged with a tag
mw.notify( 'Test 2', { tag: 'foobar' } ); // This one will replace the previous 'foobar' notification.
For available options, see Bubble notifications § API.
mediawiki.user[edit source]
Module that represents information about the current user.
user.options[edit source]
mw.user.options[edit source]
Contains the preferences of the user, or the defaults when logged out.
// Get a preference option and use it directly
alert( 'According to your preferences, your gender is ' + mw.user.options.get( 'gender' ) );
// Get several preferences and compare them
var opts = mw.user.options.get( [ 'diffonly', 'showhiddencats' ] );
if ( opts.diffonly === 0 && opts.showhiddencats === false ) {
// User's preferences match
} else {
// User's preferences don't match
}
This module is loaded asynchronously and may depend on a separate HTTP request for the user.defaults
module. Always declare the relevant dependencies for your module, or use mw.loader.using()
.
mw.user.tokens[edit source]
MediaWiki version: | ≥ 1.19 r88553 |
This contains an mw.Map object, pre-populated with tokens for use by #mediawiki.api.
mediawiki.api[edit source]
MediaWiki version: | ≥ 1.18.1 r105646 |
This module provides the mw.Api
constructor. The main methods of the mw.Api
object are get()
, post()
, and ajax()
. The mediawiki.api
module (and its plugins) return a Promise
– similar to jQuery.ajax
(and its derivatives such as jQuery.get
, jQuery.post
and jQuery.getJSON
).
Before MediaWiki 1.32 (Gerrit change 434179), the methods were part of separate modules named under mediawiki.api.*
. These have been merged into the main module mediawiki.api
, so you only have to depend on that module. The submodules have been deprecated with warnings. These submodules have been removed in MediaWiki 1.33.
Examples of methods that are available:
mw.Api#edit
- Edit an existing page.mw.Api#saveOptions
- Changes one or more user preferences.mw.Api#watch
- Add a given title (or titles) to the user's watchlist.
// Example
var api = new mw.Api();
api.watch( 'Page to watch' );
mediawiki.cookie[edit source]
MediaWiki version: | ≥ 1.24 Gerrit change 120806 |
Cookie module that uses the same settings as the MediaWiki server-side configuration (except for wgCookieSecure
).
Usage example:
mw.cookie.set( 'myCookie', 'some-value' );
var value = mw.cookie.get( 'myCookie' );
This module prepends the cookie names with $wgCookiePrefix
(e.g. "enwikimyCookie=some-value").
Avoid accessing the same cookie in different ways, for example via mw.cookie
and via $.cookie
, because you may encounter issues if doing so.
See the API documentation for available options.
mediawiki.errorLogger[edit source]
MediaWiki version: | ≥ 1.36 Gerrit change 655435 |
Stub for logging Javascript errors; always loaded. Provides a method for logging caught exceptions:
try {
// ...
} catch ( e ) {
mw.errorLogging.logError( e, 'my-component' );
}
Sends two kinds of #mw.track events:
error_caught
: this is where errors logged vialogError
goglobal_error
: uncaught exceptions reported by the browser
By default nothing is done with these events; an mw.trackSubscribe
handler can forward them to the appropriate logging API. See e.g. clientError.js in WikimediaEvents, or Sentry.
mediawiki.feedback[edit source]
MediaWiki version: | ≥ 1.19 |
User interface for collecting feedback, particularly on new features.
mediawiki.jqueryMsg[edit source]
This module upgrades the mw.message
parser to support basic wikitext localisation and formatting features. For example, mediawiki.jqueryMsg
is required for plural and gender support, the int: magic word and links.
mediawiki.storage[edit source]
Wrapper for HTML5 Web Storage (localStorage, and sessionStorage).
If you are migrating from $.jStorage
, note that mw.storage.get()
and mw.storage.set()
only store string values. Use JSON.stringify()
and JSON.parse()
or parseInt
/parseFloat
accordingly when setting and getting non-string values. You may also use mw.storage.getObject()
and mw.storage.setObject()
(Gerrit change 506145) so that MediaWiki transparently interleaves a JSON serialization.
mediawiki.ui[edit source]
MediaWiki version: | ≥ 1.22 |
(deprecated in 1.29) Please use OOUI instead. See the OOUI module names.
UI module developed as part of the Agora project. It defines mw-ui-*
CSS styles. It is used in the Login and Create account forms and several extensions. It provides one appearance for Vector and another for the rest of the skins.
mediawiki.widgets[edit source]
Module providing MediaWiki-specific OOUI widgets like user input widget or namespace input widget.
mediawiki.util[edit source]
addCSS[edit source]
Adds a <style>
element to the HEAD and returns the CSSStyleSheet object.
The CSSStyleSheet object can be used to disable the CSS rules at any later time and re-enable them as well. This can be done through the 'disabled' attribute. When setting this to true, the rules no longer apply. When setting to false, the rules apply again.
See also W3 on CSSStyleSheet for more info.
// Add a simple stylesheet rule
mw.util.addCSS( '.plainlinks { color: green; }' );
// Add a rule and set a variable to the sheet
var myCssRules = mw.util.addCSS( '.plainlinks { color: green; }' );
$( '#myButton' ).click( function () {
// When button is clicked, toggle the stylesheet from true to non-true (false), or from false to non-false (true)
myCssRules.disabled = !myCssRules.disabled;
} );
addPortletLink[edit source]
This function is ported from the legacy wikibits keeping it fully backwards compatible, with a few adjustments that support all core skins and with added support for a CSS-selector as nextnode
. Note that it doesn't support MobileFrontend with the Minerva skin for logged-out users.
Only the first three arguments are required. In case you need to execute a custom function when the user clicks on a portlet, use the jQuery(...).on('click', .. ) on returned Element object to attach a callback that runs the code that should be executed.
See the mw.util documentation
for details.
// First wait for mediawiki.util to load, and the page to be ready.
$.when( mw.loader.using( 'mediawiki.util' ), $.ready ).then( function () {
// General usage pattern:
// mw.util.addPortletLink( portletId, href, text /* Optional: , id, tooltip, accesskey, nextnode */ );
// Example: Add a link to mediawiki.org to the Tools area, above the "Special pages" link.
var newElement = mw.util.addPortletLink(
'p-tb',
'https://www.mediawiki.org/',
'Link to mediawiki.org',
't-mworg',
'Go to www.mediawiki.org',
'm',
'#t-specialpages'
);
// The old way of passing a DOM-node also works
mw.util.addPortletLink(
'p-tb',
'https://www.mediawiki.org/',
'Link to mediawiki.org',
't-mworg',
'Go to www.mediawiki.org',
'm',
document.getElementById( 't-specialpages' )
);
} );
Note about icons: The id will be used to construct an icon class in certain skins (for example mw-ui-icon-vector-gadget-cx-language in Vector). Callers are expected to add their own CSS in addition to calling addPortletLink if needed.
hidePortletLink[edit source]
This function allows you to hide a portlet (menu) consistently across skins.
// First wait for mediawiki.util to load, and the page to be ready.
$.when( mw.loader.using( 'mediawiki.util' ), $.ready ).then( function () {
/// hide toolbox
mw.util.hidePortlet( 'p-tb' );
} );
addSubtitle[edit source]
// First wait for mediawiki.util to load, and the page to be ready.
$.when( mw.loader.using( 'mediawiki.util' ), $.ready ).then( function () {
mw.util.addSubtitle( 'Hello' );
var sub = document.createElement('div');
sub.textContent = ' world';
mw.util.addSubtitle( sub );
} );
clearSubtitle[edit source]
Usually called alongside addSubtitle when you want to refresh the subtitle contents. Given you can only add to the subtitle, you must clear its existing contents if you want to redraw.
// First wait for mediawiki.util to load, and the page to be ready.
$.when( mw.loader.using( 'mediawiki.util' ), $.ready ).then( function () {
mw.util.clearSubtitle();
} );
$content[edit source]
A jQuery object for a page's overall content area regardless of the skin used. This is, for example, #content
in the Vector-skin (before 1.20 it was #bodyContent
).
This does not refer to the area where the page content goes. If you wish to work with that area of the page instead of the overall content area you should use $( '#mw-content-text' )
instead.
This property is populated on document ready. To use it, wait for $.ready
and be sure to have a module dependency on mediawiki.util
which will ensure your document ready handler fires after initialization.
Because of the lazy-initialised nature of this property, you are discouraged from using it.
/* Add some HTML to the page content */
mw.util.$content.append( '<h2>Lorem ipsum</h2><p>This section was just added to the bottom of the wiki page.</p>' );
/* Count number of tables in the page's content with a class of "wikitable" */
var $wikitablesInPage = mw.util.$content.find( 'table.wikitable' );
if ( $wikitablesInPage.length ) {
alert( 'There are ' + $wikitablesInPage.length + ' wikitables on this page.' );
} else {
alert( 'There are no wikitables on this page.' );
}
Here is a more advanced example involving loading in extra content with an AJAX request. Run this example on a page other than the main page.
/* Loads in main page (or any page for that matter) over AJAX (may be useful for Special:BlankPage) */
// Put a loading message on top of the page
mw.util.$content.prepend( '<p><em>Loading...</em></p><hr/>' );
// To get the article contents, use #mw-content-text instead.
$( '#mw-content-text' ).load( mw.util.getUrl( '' ) + ' #mw-content-text', function () {
mw.notify( 'Load complete!' );
} );
getParamValue[edit source]
This function returns the value of the specified URL parameter. By default it uses the current window's address. Optionally you can pass it a custom location.
It returns null
if the parameter is not present.
Returns an empty string(""
) if it was an empty parameter (such as /page.php?some=parameter&emptyparameter=&id=12
// Location: https://www.mediawiki.org/w/index.php?title=ResourceLoader/Default_modules&action=edit§ion=28
// Suppose we're editing a page section, this will return the number of the edit section
mw.util.getParamValue( 'section' ); /* returns '28'; */
// Extract a value from a custom url
// For example on a diff page where there is: "← Older edit" and you need the oldid of the previous edit
var oldid = mw.util.getParamValue( 'oldid', '//www.mediawiki.org/w/index.php?title=ResourceLoader/Default_modules&diff=prev&oldid=365296' );
if ( oldid !== null ) {
alert( 'The previous text version of this page has id: ' + oldid );
} else {
alert( 'No "oldid" parameter found in the given address.' );
}
isIPv4Address[edit source]
MediaWiki version: | ≥ 1.18 r83202 |
This function returns bool for passed string is valid IPv4 Address or not.
// true
mw.util.isIPv4Address( '192.0.2.0' );
// false (range is invalid IPv4 Address)
mw.util.isIPv4Address( '192.0.2.0/24' );
// false
mw.util.isIPv4Address( 'string' );
isIPv6Address[edit source]
MediaWiki version: | ≥ 1.18 r83202 |
This function returns bool for passed string is valid IPv6 Address or not.
// true
mw.util.isIPv6Address( '2001:db8:a:0:0:0:0:0' );
// true
mw.util.isIPv6Address( '2001:db8:a::' );
// false (range is invalid IPv6 Address)
mw.util.isIPv6Address( '2001:db8:a::/32' );
// false
mw.util.isIPv6Address( 'string' );
rawurlencode[edit source]
This function returns an encoded string in its raw form for use in urls.
var exFooUrl = 'http://example.org/foo/' + mw.util.rawurlencode( mw.config.get( 'wgPageName' ) );
For building query strings, you may want to use jQuery.param instead:
var query = {
page: 'MyPage',
value: mw.config.get( 'skin' ),
action: 'foo'
};
var fooQuery = 'http://example.com/stuff.php?' + $.param( query );
wikiScript[edit source]
MediaWiki version: | ≥ 1.18 r88513 |
This function returns the location of a script on the current wiki. Much like wfScript
in GlobalFunctions.php.
Parameters: str
- Name of the script (e.g. 'api'), defaults to 'index'.
jQuery.getJSON( mw.util.wikiScript( 'api' ), {
format: 'json',
action: 'query',
titles: 'Main Page',
prop: 'revisions'
} ).done( function ( data ) {
// data.query
} );
mediawiki.RegExp[edit source]
MediaWiki versions: | 1.26 – 1.35 |
(deprecated in 1.34)
mediawiki.Title[edit source]
This sets the mw.Title
constructor, which has several methods in its prototype. Basic example:
var t = new mw.Title( 'Image: foo_bar baz.jpg' );
t.getMain(); // "Foo_bar_baz.jpg"
t.getNamespaceId(); // 6
t.getNamespacePrefix(); // "File:"
mediawiki.Uri[edit source]
moment[edit source]
- Upstream documentation: https://momentjs.com/
Moment.js can parse, manipulate, and format date-time timestamps. Localisation is automatically loaded and configured for the current user interface language.
var moment = require( 'moment' );
moment( '2011-04-01 09:00' ).format( 'LLLL' );
// "Friday, 1 April 2011 9:00 AM"
moment.version
//> "2.25.2"
oojs[edit source]
MediaWiki version: | ≥ 1.23 |
OOjs is a libary that provides a consistent way of implementing object-oriented design in JS.
oojs-ui[edit source]
MediaWiki version: | ≥ 1.23 |
OOUI is a user interface toolkit based on OOjs. Note that oojs-ui
is just a legacy name for the module. See all the known OOUI module names.
jquery[edit source]
More information about jQuery's presence in MediaWiki, see jQuery. For more about jQuery in general and all its core functions, refer to https://api.jquery.com/
ResourceLoader provides jQuery as part of its base environment (the loader client uses jQuery internally), therefore this module is always loaded and should not (and in fact can not) be loaded through ResourceLoader (as dependency or otherwise).
jquery.chosen[edit source]
“Chosen is a jQuery plugin that makes long, unwieldy select boxes much more user-friendly.” — harvesthq.github.io
In fact, it turns a select into a combo box with autocomplete functionality by default but also supports grouping, and "tagging" (i.e. multiple values).
$( 'select' ).chosen( { /* options */ } );
jquery.client[edit source]
A plugin that extracts information about the client's browser, layout engine, and operating system.
jQuery.client.profile[edit source]
Here a few examples:
if ( $.client.profile().layout == 'gecko' && $.client.profile().platform == 'linux' ) {
// This will only run on Gecko browsers (ie. Mozilla Firefox) on Linux.
}
if ( $.client.profile().name == 'msie' ) {
// Only for good ol' Internet Explorer
}
// Shortcut
var prof = $.client.profile();
if ( prof.name == 'firefox' && prof.versionBase == '2' && prof.platform == 'win' ) {
// Target Mozilla Firefox 2.x on Windows
}
Check jquery.client.js for possible values of browser names, layout engines and platforms.
jquery.color[edit source]
MediaWiki version: | ≥ 1.17 |
jquery.cookie[edit source]
To use jQuery cookie methods, load the mediawiki.cookie
module. It is recommended that you use mw.cookie
interface as it automatically applies appropiate settings based onMediaWiki site configuration (such as domain, path, and retention).
This plugin allows you to set, get and delete cookies.
// Set cookie (simple, current page/path)
$.cookie( 'myName', 'Flower' );
// Set cookie (extra options)
$.cookie( 'myName', 'Flower', {
expires: 7, // expires in 7 days
path: '/' // domain-wide, entire wiki
} );
// Get cookie
var name = $.cookie( 'myName' );
// Delete cookie
// Deprecated since 1.2 please use $.removeCookie( 'foo' ) instead
$.cookie( 'myName', null );
$.removeCookie( 'foo' )
When deleting a cookie, you must use the same path and domain used when the cookie was set.
Note that when MediaWiki server-side code sets a cookie it usually prefixes it with the database name; this prefix is available to JavaScript code as the mw.config
variable wgCookiePrefix
.
Note that users will likely get separate cookies for /wiki/
and /w/
paths in page URLs if you do not specify the extra option { path: '/' }
when setting a cookie.
jquery.i18n[edit source]
MediaWiki version: | ≥ 1.26 Gerrit change 223201 |
jquery.makeCollapsible[edit source]
MediaWiki version: | ≥ 1.18 r78914 |
- See also Manual:Collapsible elements.
Makes elements collapsible. It supports lots of variations such as:
- Simple
- Add "
mw-collapsible
" to an element (a<div>
for example) with some content and save the page. The inner content of this element will be treated as collapsible content. Prepended to the element, before the collapsible content, is a toggle-link with a localized label (collapsible-expand, collapsible-collapse) - Initial state
- Adding "
mw-collapsed
" as additional class will cause the element to be initially collapsed when the page is loaded. - Custom label
- HTML5 only Using the
data-collapsetext
anddata-expandtext
attributes one can define a custom text for the toggle labels added by the script. When added in wikitext these could be populated by a localized message like:<div class="mw-collapsible" data-expandtext="{{int:show}}" data-collapsetext="{{int:hide}}">
- Remote toggle
- If you don't want the script to put the default toggle link (whether or not with a custom label) in your element, you can make one of your own. This could reside anywhere inside or outside the collapsible element. Its relationship to the collapsible element is detected by using an ID attribute with the prefix
mw-customcollapsible
and a corresponding class attribute with prefixmw-customtoggle
for the collapsible element and the togglelink respectively.
Input:
{| class="wikitable"
! Foo
! Bar
|-
| Lorem
| Ipsum
|-
| More info
|<!--
-->
{| class="wikitable mw-collapsible mw-collapsed" style="width: 100%;"
! Head
! Top
|-
| Cell
| content
|-
| This table is collapsible
| Because it has the "mw-collapsible" class
|-
| It was initially hidden, because it
| had the "mw-collapsed" class
|}<!--
-->
|-
|}
<div class="toccolours mw-collapsible" style="width: 400px;">
This is text is collapsible. {{Lorem}}
</div>
Output:
Foo | Bar | ||||||||
---|---|---|---|---|---|---|---|---|---|
Lorem | Ipsum | ||||||||
More info |
|
Example: Hide the collapsible element by default, the toggle element resides outside of it
Input:
<div class="mw-customtoggle-myDivision" style="background:#e0e8ff">Click here to toggle the element</div>
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-myDivision">
<div class="toccolours mw-collapsible-content">Lorem ipsum dolor sit amet...</div>
</div>
<div class="mw-customtoggle-myDivision" style="background:#e8ffe0">Clicking will toggle it also!</div>
Output:
For other live examples, see Test Wikipedia - Collapsing Testpage.
jquery.suggestions[edit source]
jquery.spinner[edit source]
jquery.tabIndex[edit source]
(deprecated in 1.34)
jquery.tablesorter[edit source]
MediaWiki version: | ≥ 1.18 r86088 |
jquery.textSelection[edit source]
mw.util.jsMessage( 'The selected text is "' + mw.html.escape( $( '#wpTextbox1' ).textSelection( 'getSelection' ) ) + '".' );
jquery.tipsy[edit source]
(deprecated in 1.28)
The library will be available for the forseeable future, but overlaps with functionality within OOUI and provides a suboptimal experience to mobile users. Where jQuery.tipsy is being used, we encourage developers to inspect OOUI and feedback on how the library might be improved to support the usecase that jquery.tipsy provides.
Example page; jQuery project page
Option | Type | Possible values | Default | Description |
---|---|---|---|---|
gravity | string / call-back function | 'nw' | 'n' | 'ne' | 'w' | 'e' | 'sw' | 's' | 'se' / $.fn.tipsy.autoNS | $.fn.tipsy.autoWE | pointer or anonymous | 'n' | sets the positioning of the tooltip relative to the element |
fade | bool | true | false | true | use fading effect (fadeIn / fadeOut) |
title | string (an attribute) / call-back function | style, class, id, ..., function () { return 'some string'; } | title (or if not specified fallback-value; see below) | Which string to display as a "tool-tip"? |
fallback | string | 'valid string' | used if an element has no tooltip | |
html | bool | true | false | false | interpret the tooltip text as HTML |
delayIn | number in ms | 0, 1, 2, ... | 0 | How long to wait after onmouseover to show the tip? |
delayOut | number in ms | 0, 1, 2, ... | 0 | How long to wait after onmouseout to close the tip? |
trigger | string | 'focus' | 'manual' | 'hover' | hover | When to show the tooltip (useful for forms) |
live | bool | true | false | false | dynamical add to selectors- see JQuery's live interpretation |
offset | number in px | 0 | offset from tooltip to element | |
opacity | number (float) | 1.0 | opacity of the tooltip |
mw.loader.using( 'jquery.tipsy', function () {
$someObject.prepend(
$( '<span>', {
title: 'Some tipsy test title'
} )
.append( 'Hover here' )
.tipsy( {
option: 'value',
option2: 'value2'
} )
);
} );
jquery.ui[edit source]
(deprecated in 1.29) Please use OOUI instead.
For more information on and demos for jQuery UI, refer to http://jqueryui.com/
site[edit source]
This module loads site scripts from the pages:
MediaWiki:Common.js
,- and
MediaWiki:Vector.js
(depending on the current skin).
If $wgUseSiteJs
is disabled by configuration, then the module is empty.
user[edit source]
This module loads:
User:<name>/common.js
,User:<name>/vector.js
(depending on current skin),MediaWiki:Group-user.js
,MediaWiki:Group-<groupname>.js
(for each group the current user is a member of, e.g. "sysop", "bureaucrat" etc.)
If $wgAllowUserJs
is disabled by configuration, then the "User" sub pages are not included.
If $wgUseSiteJs
is disabled by configuration, then the "MediaWiki:Group-" pages are not included.
ResourceLoader |
---|
Reference |
Tutorials |