MediaWiki:Common.js
MediaWiki interface page
More actions
Note: After publishing, you may have to bypass your browser's cache to see the changes.
- Firefox / Safari: Hold Shift while clicking Reload, or press either Ctrl-F5 or Ctrl-R (⌘-R on a Mac)
- Google Chrome: Press Ctrl-Shift-R (⌘-Shift-R on a Mac)
- Edge: Hold Ctrl while clicking Refresh, or press Ctrl-F5.
/* Any JavaScript here will be loaded for all users on every page load. */
/**
* Creates minecraft style tooltips
*
* Replaces normal tooltips. Supports minecraft [[formatting codes]] (except k), and a description with line breaks (/).
*
* Source: https://minecraft.wiki/w/MediaWiki:Common.js
*/
(function () {
var escapeChars = { '\\&': '&', '<': '<', '>': '>' };
var escape = function (text) {
// "\" must be escaped first
return text.replace(/\\\\/g, '\')
.replace(/\\&|[<>]/g, function (char) { return escapeChars[char]; });
};
var $tooltip = $();
var $win = $(window), winWidth, winHeight, width, height;
$('#mw-content-text').on({
'mouseenter.minetip': function (e) {
$tooltip.remove();
var $elem = $(this), title = $elem.attr('data-minetip-title');
if (title === undefined) {
title = $elem.attr('title');
if (title !== undefined) {
title = $.trim(title.replace(/&/g, '\\&'));
$elem.attr('data-minetip-title', title);
}
}
// No title or title only contains formatting codes
if (title === undefined || title !== '' && title.replace(/&([0-9a-jl-qs-wr])/g, '') === '') {
// Find deepest child title
var childElem = $elem[0], childTitle;
do {
if (childElem.hasAttribute('title')) {
childTitle = childElem.title;
}
childElem = childElem.firstChild;
} while (childElem && childElem.nodeType === 1);
if (childTitle === undefined) {
return;
}
// Append child title as title may contain formatting codes
if (!title) {
title = '';
}
title += $.trim(childTitle.replace(/&/g, '\\&'));
// Set the retrieved title as data for future use
$elem.attr('data-minetip-title', title);
}
if (!$elem.data('minetip-ready')) {
// Remove title attributes so the native tooltip doesn't get in the way
$elem.find('[title]').addBack().removeAttr('title');
$elem.data('minetip-ready', true);
}
if (title === '') {
return;
}
var content = '<span class="minetip-title">' + escape(title) + '&r</span>';
var description = $.trim($elem.attr('data-minetip-text'));
var miaLayersData = $elem.attr('data-minetip-mia-layers');
if (description || miaLayersData) {
// Apply normal escaping plus "/"
description = escape(description).replace(/\\\//g, '/');
var miaLayers = '';
if (miaLayersData) {
for (let layerText of JSON.parse(miaLayersData)){
miaLayers += '<span class="icon-layer-' + layerText.toLowerCase().replace(/_/g, '-') + '"></span>';
}
miaLayers += '<br>';
}
content += '<span class="minetip-description">' + miaLayers + description.replace(/\//g, '<br>') + '&r</span>';
}
// Add classes for minecraft formatting codes
while (content.search(/&[0-9a-jl-qs-w]/) > -1) {
content = content.replace(/&([0-9a-jl-qs-w])(.*?)(&r|$)/g, '<span class="format-$1">$2</span>&r');
}
// Remove reset formatting
content = content.replace(/&r/g, '');
$tooltip = $('<div id="minetip-tooltip">');
$tooltip.html(content).appendTo('body');
// Cache current window and tooltip size
winWidth = $win.width();
winHeight = $win.height();
width = $tooltip.outerWidth(true);
height = $tooltip.outerHeight(true);
// Trigger a mouse movement to position the tooltip
$elem.trigger('mousemove', e);
},
'mousemove.minetip': function (e, trigger) {
if (!$tooltip.length) {
$(this).trigger('mouseenter');
return;
}
// Get event data from remote trigger
e = trigger || e;
// Get mouse position and add default offsets
var top = e.clientY - 34;
var left = e.clientX + 14;
// If going off the right of the screen, go to the left of the cursor
if (left + width > winWidth) {
left -= width + 36;
}
// If now going off to the left of the screen, resort to going above the cursor
if (left < 0) {
left = 0;
top -= height - 22;
// Go below the cursor if too high
if (top < 0) {
top += height + 47;
}
// Don't go off the top of the screen
} else if (top < 0) {
top = 0;
// Don't go off the bottom of the screen
} else if (top + height > winHeight) {
top = winHeight - height;
}
// Apply the positions
$tooltip.css({ top: top, left: left });
},
'mouseleave.minetip': function () {
if (!$tooltip.length) {
return;
}
$tooltip.remove();
$tooltip = $();
}
}, '.minetip, .invslot-item');
/* Fires when DOM is ready */
$(function () {
/**
* Pause animations on mouseover of a designated container (.animated-container and .mcui)
*
* This is so people have a chance to look at the image and click on pages they want to view.
*/
$('#mw-content-text').on('mouseenter mouseleave', '.animated-container, .mcui', function (e) {
$(this).find('.animated').toggleClass('animated-paused', e.type === 'mouseenter');
});
/* Fired whenever wiki content is added. (#mw-content-text, live preview, load page, etc.) */
mw.hook('wikipage.content').add(function ($wikipageContent) {
/**
* Set minimum height for animations to prevent moving the page if the frames
* differ in height
* Source: https://minecraft.wiki/w/MediaWiki:Gadget-site.js
*/
(function () {
// Set frames to be visible for measuring height
var $animated = $wikipageContent.find('.animated').addClass('animated-visible');
// Group frames per animation
var animateds = [];
$animated.each(function () {
animateds.push({
$: $(this).find('> .animated-subframe').addBack()
.find('> *:not(.animated-subframe)'),
});
});
// Get highest frame for each animation (if heights differ)
$.each(animateds, function () {
var minHeight = 0, differentHeights;
this.$.each(function () {
var height = this.offsetHeight;
differentHeights = differentHeights || minHeight && height !== minHeight;
minHeight = Math.max(height, minHeight);
});
if (differentHeights) {
this.height = minHeight;
}
});
// Set animation to be at least as tall as the tallest frame,
// and set the non-active frames to be hidden again
$animated.each(function (i) {
$(this).css('min-height', animateds[i].height);
}).removeClass('animated-visible');
// Load all images in the animation as soon as the animated content becomes visible
var animatedObserver = new IntersectionObserver(function (entries) {
entries.forEach(function (entry) {
if (entry.isIntersecting && !entry.target.classList.contains('animated-lazyloaded')) {
$(entry.target).find('img').attr('loading', 'eager');
entry.target.classList.add('animated-lazyloaded');
animatedObserver.unobserve(entry.target);
}
});
});
// Observe every animation
$animated.each(function () {
animatedObserver.observe(this);
});
}());
});
/**
* Element animator
*
* Cycles through a set of elements (or "frames") on a 2 second timer per frame
* Add the "animated" class to the frame containing the elements to animate.
* Optionally, add the "animated-active" class to the frame to display first.
* Optionally, add the "animated-subframe" class to a frame, and the
* "animated-active" class to a subframe within, in order to designate a set of
* subframes which will only be cycled every time the parent frame is displayed.
* Animations with the "animated-paused" class will be skipped each interval.
*
* Requires some styling from [[MediaWiki:Gadget-site-styles.css]].
*/
( function() {
var $content = $( '#mw-content-text' );
var advanceFrame = function( parentElem, parentSelector ) {
var curFrame = parentElem.querySelector( parentSelector + ' > .animated-active' );
$( curFrame ).removeClass( 'animated-active' );
var $nextFrame = $( curFrame && curFrame.nextElementSibling || parentElem.firstElementChild );
return $nextFrame.addClass( 'animated-active' );
};
// Set the name of the hidden property
var hidden;
if ( typeof document.hidden !== 'undefined' ) {
hidden = 'hidden';
} else if ( typeof document.msHidden !== 'undefined' ) {
hidden = 'msHidden';
} else if ( typeof document.webkitHidden !== 'undefined' ) {
hidden = 'webkitHidden';
}
setInterval( function() {
if ( hidden && document[hidden] ) {
return;
}
$content.find( '.animated' ).each( function() {
if ( $( this ).hasClass( 'animated-paused' ) ) {
return;
}
var $nextFrame = advanceFrame( this, '.animated' );
if ( $nextFrame.hasClass( 'animated-subframe' ) ) {
advanceFrame( $nextFrame[0], '.animated-subframe' );
}
} );
}, 2000 );
}() );
});
/* End DOM ready */
}());