MediaWiki:Mobile.js
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.
/* All JavaScript here will be loaded for users of the mobile site */
/* Note, there is no corresponding User:Username/mobile.js; however users may use User:Username/minerva.js */
function addPortletLink() {
mw.log.warn(
'addPortletLink is deprecated on desktop and never implemented on mobile',
'More information on https://www.mediawiki.org/wiki/ResourceLoader/Migration_guide_(users)#addPortletLink'
);
}
/* CapSach — Mobile TOC overlay (phones); robust H2-open-before-scroll for H3+ */
(function () {
/* ---------- utilities ---------- */
function isMobileSite() {
// Stable way to detect the MobileFrontend site (<body class="mw-mf">).
return document.body && document.body.classList.contains('mw-mf'); /* MF site */ /* */
}
function once(id) { return !document.getElementById(id); }
function onReady(fn) {
if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', fn);
else fn();
}
function getContentRoot() {
return (
document.querySelector('#mw-content-text .mw-parser-output') ||
document.querySelector('.mw-parser-output') ||
document.getElementById('mw-content-text') ||
document.querySelector('#content') ||
document.body
);
}
// Account for sticky headers when scrolling
function smoothScrollTo(el) {
var offset = 0;
try {
var fixed = document.querySelectorAll('header, .minerva-header, .mw-header, .site-header, #header, .header');
fixed.forEach(function (node) {
var cs = getComputedStyle(node);
if (cs.position === 'fixed' || cs.position === 'sticky') {
var r = node.getBoundingClientRect();
if (r.top <= 0 && r.bottom > 0) offset = Math.max(offset, r.bottom);
}
});
} catch (_) {}
var y = el.getBoundingClientRect().top + window.pageYOffset - Math.max(0, Math.floor(offset));
try { window.scrollTo({ top: y, behavior: 'smooth' }); } catch (_) { window.scrollTo(0, y); }
}
/* ---------- MF section helpers ---------- */
// NEW heading markup: ids can be on <hN> or on .mw-headline (MW 1.43+ wrappers)
function anchorForHeadingEl(hEl) {
if (!hEl) return null;
var span = hEl.querySelector && hEl.querySelector('.mw-headline[id]');
if (span) return span;
return hEl.id ? hEl : null; /* MW 1.44+ may put id on <hN> */
}
// Find the element that actually toggles the H2 section (owns aria-expanded / aria-controls)
function getH2Toggle(h2El) {
if (!h2El) return null;
var w = h2El.closest('.mw-heading') || h2El;
// Prefer a real control with aria-controls
var ctrl = w.querySelector('button[aria-controls], [aria-expanded][aria-controls]');
if (ctrl) return ctrl;
// Next-best: any descendant exposing aria-expanded
ctrl = w.querySelector('[aria-expanded]');
if (ctrl) return ctrl;
// Legacy: the heading itself behaves as the toggle
if (h2El.hasAttribute('aria-expanded') || h2El.classList.contains('section-heading') ||
h2El.classList.contains('collapsible-heading')) {
return h2El;
}
// As a last resort, some old MF put a separate preceding/next sibling as the toggle
var prev = h2El.previousElementSibling, next = h2El.nextElementSibling;
if (prev && (prev.matches('[aria-expanded], .section-heading, .collapsible-heading'))) return prev;
if (next && (next.matches('[aria-expanded], .section-heading, .collapsible-heading'))) return next;
return null;
}
function h2IsCollapsed(h2El) {
if (!h2El) return false;
var toggle = getH2Toggle(h2El);
if (toggle) {
var ae = toggle.getAttribute('aria-expanded');
if (ae === 'false') return true;
if (ae === 'true') return false;
var cid = toggle.getAttribute('aria-controls');
if (cid) {
var block = document.getElementById(cid);
if (block) {
if (block.hidden || block.getAttribute('hidden') !== null) return true;
if (block.classList.contains('collapsible-block') && !block.classList.contains('open-block')) return true;
}
}
}
// Legacy sibling block
var sib = h2El.nextElementSibling;
if (sib && sib.classList.contains('collapsible-block')) return !sib.classList.contains('open-block');
// Newer wrapper pattern: <section aria-expanded="false"> around heading+content
var sec = h2El.closest('section[aria-expanded]');
if (sec) return sec.getAttribute('aria-expanded') === 'false';
return false;
}
function fireActivation(el) {
// Fire a sequence of events so whichever MF handler is present reacts
var opts = { bubbles: true, cancelable: true, view: window };
try { el.dispatchEvent(new PointerEvent('pointerdown', opts)); } catch (_) {}
try { el.dispatchEvent(new MouseEvent('mousedown', opts)); } catch (_) {}
try { el.dispatchEvent(new TouchEvent('touchstart', opts)); } catch (_) {}
try { el.dispatchEvent(new TouchEvent('touchend', opts)); } catch (_) {}
try { el.dispatchEvent(new MouseEvent('mouseup', opts)); } catch (_) {}
try { el.dispatchEvent(new MouseEvent('click', opts)); } catch (_) { el.click(); }
}
// Open H2 if needed; resolve when open (or after timeout)
function ensureH2Open(h2El) {
return new Promise(function (resolve) {
if (!h2El || !h2IsCollapsed(h2El)) return resolve();
var toggle = getH2Toggle(h2El);
var triedManual = false;
// Observe changes to aria-expanded / classes / hidden
var obs = null;
if (window.MutationObserver) {
obs = new MutationObserver(function () {
if (!h2IsCollapsed(h2El)) {
if (obs) obs.disconnect();
resolve();
}
});
var targets = [];
if (toggle) targets.push(toggle);
var cid = toggle && toggle.getAttribute('aria-controls');
var controlled = cid && document.getElementById(cid);
if (controlled) targets.push(controlled);
// Also watch the wrapper <section aria-expanded>
var sec = h2El.closest('section[aria-expanded]');
if (sec) targets.push(sec);
if (targets.length) {
targets.forEach(function (t) {
obs.observe(t, { attributes: true, attributeFilter: ['aria-expanded', 'class', 'hidden'] });
});
}
}
// First: try to use MF’s own handler
if (toggle) fireActivation(toggle);
// Fallback (after a short tick) – manually open if still collapsed
setTimeout(function manualIfNeeded() {
if (!h2IsCollapsed(h2El)) return; // already open
if (!triedManual) {
triedManual = true;
// Manual open strategy:
// 1) If we have a controls target, unhide it + mark open-block
var cid = toggle && toggle.getAttribute('aria-controls');
var block = cid && document.getElementById(cid);
if (block) {
block.hidden = false;
block.removeAttribute('hidden');
block.classList.add('open-block');
}
// 2) If a wrapper <section aria-expanded> exists, flip it
var sec = h2El.closest('section[aria-expanded]');
if (sec) sec.setAttribute('aria-expanded', 'true');
// 3) If legacy sibling block exists, mark it open
var sib = h2El.nextElementSibling;
if (sib && sib.classList.contains('collapsible-block')) {
sib.classList.add('open-block');
sib.hidden = false;
sib.removeAttribute('hidden');
}
}
// Final safety timeout: stop waiting after 900ms overall
}, 120);
setTimeout(function () {
if (obs) obs.disconnect();
resolve(); // even if still closed, we won’t hang
}, 900);
});
}
/* ---------- main initializer ---------- */
function initTOC() {
// phones only
if (window.matchMedia('(min-width: 768px)').matches) return;
// only in article view
if (mw.config && !mw.config.get('wgIsArticle')) return;
// avoid duplicate buttons
if (!once('cps-open-toc')) return;
var root = getContentRoot();
// Build heading list and indices
var items = [];
var indexById = Object.create(null);
var headingElById = Object.create(null);
root.querySelectorAll('h2, h3, h4, h5, h6').forEach(function (h) {
var level = parseInt(h.tagName.slice(1), 10);
if (level < 2 || level > 6) return;
var anchor = h.querySelector('.mw-headline[id]') || h;
var id = anchor.id || h.id;
var text = (anchor.textContent || h.textContent || '').trim();
if (!id || !text) return;
items.push({ id: id, text: text, level: level });
indexById[id] = items.length - 1;
headingElById[id] = h;
});
if (items.length < 3) return; // match core TOC threshold
// UI: trigger button
var btn = document.createElement('button');
btn.id = 'cps-open-toc';
btn.type = 'button';
btn.setAttribute('aria-label', 'Open table of contents');
btn.innerHTML = '<span class="icon" aria-hidden="true">≡</span><span class="label">TOC</span>';
document.body.appendChild(btn);
// UI: overlay + panel
var overlay = document.createElement('div');
overlay.id = 'cps-toc-overlay';
overlay.setAttribute('aria-hidden', 'true');
var panel = document.createElement('div');
panel.id = 'cps-toc-panel';
panel.setAttribute('role', 'dialog');
panel.setAttribute('aria-modal', 'true');
panel.setAttribute('aria-label', 'Table of contents');
var header = document.createElement('div');
header.id = 'cps-toc-header';
header.innerHTML =
'<h2 id="cps-toc-title">Contents</h2>' +
'<button id="cps-toc-close" type="button" aria-label="Close">×</button>';
var list = document.createElement('ul');
list.id = 'cps-toc-list';
items.forEach(function (it) {
var li = document.createElement('li');
li.setAttribute('data-level', String(it.level));
var a = document.createElement('a');
a.href = '#' + it.id;
a.textContent = it.text;
li.appendChild(a);
list.appendChild(li);
});
panel.appendChild(header);
panel.appendChild(list);
overlay.appendChild(panel);
document.body.appendChild(overlay);
// open/close
var lastFocus = null;
function openOverlay() {
lastFocus = document.activeElement;
overlay.classList.add('is-open');
overlay.setAttribute('aria-hidden', 'false');
document.body.style.overflow = 'hidden';
var firstLink = list.querySelector('a');
if (firstLink) firstLink.focus({ preventScroll: true });
}
function closeOverlay() {
overlay.classList.remove('is-open');
overlay.setAttribute('aria-hidden', 'true');
document.body.style.overflow = '';
if (lastFocus && lastFocus.focus) lastFocus.focus({ preventScroll: true });
}
btn.style.display = 'flex';
btn.addEventListener('click', openOverlay);
overlay.addEventListener('click', function (e) { if (e.target === overlay) closeOverlay(); });
overlay.querySelector('#cps-toc-close').addEventListener('click', closeOverlay);
overlay.addEventListener('keydown', function (e) { if (e.key === 'Escape') closeOverlay(); });
// parent H2 lookup
function parentH2For(id) {
var idx = indexById[id];
if (typeof idx !== 'number') return null;
for (var i = idx - 1; i >= 0; i--) if (items[i].level === 2) return items[i];
return null;
}
// nav: open parent H2 (if collapsed), then scroll to target H3 (or fallback to H2)
list.addEventListener('click', function (e) {
var a = e.target && e.target.closest('a');
if (!a) return;
e.preventDefault();
var targetId = a.getAttribute('href').slice(1);
var li = a.closest('li');
var level = li ? parseInt(li.getAttribute('data-level') || '0', 10) : 0;
closeOverlay();
// H3+ — ensure its parent H2 is open first
if (level >= 3) {
var p = parentH2For(targetId);
if (p) {
var h2El = headingElById[p.id];
ensureH2Open(h2El).then(function () {
// Prefer the intended H3 anchor; if missing, fall back to H2
var dest = document.getElementById(targetId) || anchorForHeadingEl(h2El) || h2El;
if (!dest) return;
requestAnimationFrame(function () {
smoothScrollTo(dest);
var finalId = dest.id || targetId;
setTimeout(function () {
if (history && history.replaceState) history.replaceState(null, '', '#' + finalId);
else location.hash = finalId;
}, 120);
});
});
return;
}
}
// H2 or no parent found: go straight to target
var h = document.getElementById(targetId) ||
(level === 2 ? anchorForHeadingEl(headingElById[targetId]) : null);
if (!h) return;
requestAnimationFrame(function () {
smoothScrollTo(h);
setTimeout(function () {
if (history && history.replaceState) history.replaceState(null, '', '#' + (h.id || targetId));
else location.hash = h.id || targetId;
}, 120);
});
});
// Hide/show trigger on rotation
window.addEventListener('resize', function () {
if (window.matchMedia('(min-width: 768px)').matches) { btn.style.display = 'none'; closeOverlay(); }
else { btn.style.display = 'flex'; }
}, { passive: true });
}
/* ---------- bootstrap ---------- */
if (window.mw && mw.loader) {
// Ensure MobileFrontend client pieces are present before we poke at headings/sections
mw.loader.using('mobile.startup').then(function () { /* MF site modules */
onReady(function () { if (isMobileSite()) initTOC(); });
if (mw.hook) mw.hook('wikipage.content').add(function () { /* re-run after SPA updates */
if (isMobileSite()) initTOC();
});
});
} else {
onReady(function () { if (isMobileSite()) initTOC(); });
}
})();