MediaWiki:Gadget-toc-progress.js
Перейти к навигации
Перейти к поиску
Замечание: Возможно, после публикации вам придётся очистить кэш своего браузера, чтобы увидеть изменения.
- Firefox / Safari: Удерживая клавишу Shift, нажмите на панели инструментов Обновить либо нажмите Ctrl+F5 или Ctrl+R (⌘+R на Mac)
- Google Chrome: Нажмите Ctrl+Shift+R (⌘+Shift+R на Mac)
- Edge: Удерживая Ctrl, нажмите Обновить либо нажмите Ctrl+F5
- Opera: Нажмите Ctrl+F5.
/**
* Gadget: toc-progress
* Плавающее оглавление с прогрессом чтения.
* Заменяет стандартный TOC; уважает __NOTOC__.
* Кнопка перетаскиваемая, видна всегда, по умолчанию — центр правого края.
* Позиция не выходит за пределы видимой области, при зуме не увеличивается.
* Тёмная тема — по классу html.dm («АСТРЕЯ»).
* Идёт в связке с [[MediaWiki:Gadget-toc-progress.css]]
* Лицензия: MIT (opensource.org/license/mit) ==> 2026, absurdopedia.wiki
*/
( function () {
'use strict';
// ---------- Конфигурация ----------
var CONFIG = {
articleSelector: '#mw-content-text',
headingSelector: 'h2, h3',
excludeSelector: '.infobox, .navbox, .toc, .mw-editsection, ' +
'.references, .reflist, .gadget-toc, .navbox-styles, .metadata',
minHeadingsForToc: 4,
minScrollToShow: 0,
autoCollapseMs: 20000,
storageKey: 'gadget-toc-progress-state',
posKey: 'gadget-toc-progress-pos',
headerOffset: 64,
ringRadius: 15,
useVisualViewport: true
};
var article = document.querySelector( CONFIG.articleSelector );
if ( !article ) {
return;
}
// ---------- 1. Сбор заголовков ----------
function slug( s ) {
return s.trim().toLowerCase()
.replace( /[^\w\u0400-\u04FF]+/g, '-' )
.replace( /^-+|-+$/g, '' );
}
var headings = Array.prototype.slice.call(
article.querySelectorAll( CONFIG.headingSelector )
).filter( function ( h ) {
return !h.closest( CONFIG.excludeSelector );
} ).map( function ( h, i ) {
if ( !h.id ) {
h.id = slug( h.textContent ) || ( 'section-' + i );
}
// Клон заголовка без [править] и служебных элементов — для чистого текста в оглавлении.
var clone = h.cloneNode( true );
clone.querySelectorAll( '.mw-editsection, .mw-editsection-like' )
.forEach( function ( el ) { el.remove(); } );
var text = ( clone.textContent || '' ).replace( /\s+/g, ' ' ).trim();
return {
id: h.id,
el: h,
level: h.tagName === 'H2' ? 2 : 3,
text: text
};
} );
// ---------- 2. Проверка условий показа ----------
if ( headings.length < CONFIG.minHeadingsForToc ) {
return;
}
var standardToc = document.querySelector( '.toc, #toc' );
if ( !standardToc ) {
// Заголовков достаточно (>=4), но TOC нет → __NOTOC__. Не показываем гаджет.
return;
}
// Скрываем стандартный TOC
var hideStyle = document.createElement( 'style' );
hideStyle.textContent = '.toc, #toc { display: none !important; }';
document.head.appendChild( hideStyle );
// ---------- 3. Состояние ----------
var state = {};
try {
state = JSON.parse( localStorage.getItem( CONFIG.storageKey ) || '{}' );
} catch ( e ) {
state = {};
}
var expanded = !!state.expanded;
var autoCollapseTimer = null;
function prefersReduced() {
return window.matchMedia( '(prefers-reduced-motion: reduce)' ).matches;
}
// ---------- 4. Разметка ----------
var root = document.createElement( 'div' );
root.className = 'gadget-toc';
root.innerHTML =
'<button class="gadget-toc__btn" aria-expanded="false" aria-label="Оглавление и прогресс чтения">' +
'<svg class="gadget-toc__ring" viewBox="0 0 36 36" aria-hidden="true">' +
'<circle class="gadget-toc__ring-bg" cx="18" cy="18" r="15"></circle>' +
'<circle class="gadget-toc__ring-fg" cx="18" cy="18" r="15"></circle>' +
'</svg>' +
'<span class="gadget-toc__pct">0%</span>' +
'</button>' +
'<nav class="gadget-toc__panel" aria-label="Оглавление статьи" hidden>' +
'<div class="gadget-toc__head">' +
'<span>Содержание</span>' +
'<button class="gadget-toc__close" aria-label="Закрыть">×</button>' +
'</div>' +
'<ol class="gadget-toc__list"></ol>' +
'</nav>';
document.body.appendChild( root );
var btn = root.querySelector( '.gadget-toc__btn' );
var panel = root.querySelector( '.gadget-toc__panel' );
var list = root.querySelector( '.gadget-toc__list' );
var pct = root.querySelector( '.gadget-toc__pct' );
var ringFg = root.querySelector( '.gadget-toc__ring-fg' );
var closeBtn = root.querySelector( '.gadget-toc__close' );
// Не сворачивать, пока курсор над панелью
panel.addEventListener( 'mouseenter', function () {
clearTimeout( autoCollapseTimer );
} );
panel.addEventListener( 'mouseleave', function () {
if ( expanded ) {
scheduleAutoCollapse();
}
} );
// ---------- 4a. Синхронизация color-scheme с темой «АСТРЕЯ» ----------
// Только html.dm. Системный fallback обрабатывается в CSS
// через @media (prefers-color-scheme: dark) { html:not(.dm) ... }.
function syncColorScheme() {
var isDark = document.documentElement.classList.contains( 'dm' );
root.style.colorScheme = isDark ? 'dark' : 'light';
}
syncColorScheme();
if ( window.MutationObserver ) {
new MutationObserver( syncColorScheme ).observe(
document.documentElement,
{ attributes: true, attributeFilter: [ 'class' ] }
);
}
// ---------- 4b. Плавающая кнопка (drag) ----------
( function makeDraggable() {
var pos = null;
try {
pos = JSON.parse( localStorage.getItem( CONFIG.posKey ) || 'null' );
} catch ( e ) { pos = null; }
var vv = window.visualViewport || null;
var useVV = CONFIG.useVisualViewport && vv;
// Текущий масштаб (1 на десктопе и без зума)
function currentScale() {
return useVV ? vv.scale : 1;
}
// Видимая область в координатах layout viewport
function viewRect() {
if ( useVV ) {
return {
left: vv.offsetLeft,
top: vv.offsetTop,
width: vv.width,
height: vv.height
};
}
return {
left: 0,
top: 0,
width: window.innerWidth,
height: window.innerHeight
};
}
function btnSize() {
var w = btn.offsetWidth || 56;
var h = btn.offsetHeight || 56;
return { w: w, h: h };
}
// Клампинг в координатах layout viewport с учётом видимой области
function clamp( p ) {
var s = btnSize();
var vr = viewRect();
var maxLeft = Math.max( vr.left, vr.left + vr.width - s.w );
var maxTop = Math.max( vr.top, vr.top + vr.height - s.h );
return {
left: Math.min( Math.max( vr.left, p.left ), maxLeft ),
top: Math.min( Math.max( vr.top, p.top ), maxTop )
};
}
// Применяем позицию + компенсируем масштаб, чтобы кнопка не росла
function applyPos( p ) {
var scale = currentScale();
// Компенсируем только увеличение (зум > 1), чтобы кнопка не росла.
var inv = scale > 1 ? 1 / scale : 1;
root.style.transformOrigin = '0 0';
root.style.transform =
'translate(' + p.left + 'px,' + p.top + 'px) scale(' + inv + ')';
// Если панель открыта — пересчитать её позицию относительно кнопки
if ( expanded ) {
positionPanel();
}
}
function currentPos() {
var r = root.getBoundingClientRect();
return { left: r.left, top: r.top };
}
function savePos( p ) {
try {
localStorage.setItem( CONFIG.posKey, JSON.stringify( p ) );
} catch ( e ) { /* ignore */ }
}
// Дефолт: центр правого края видимой области
function defaultPos() {
var s = btnSize();
var vr = viewRect();
return clamp( {
left: vr.left + vr.width - s.w - 16,
top: vr.top + Math.round( ( vr.height - s.h ) / 2 )
} );
}
var wasUserMoved = !!( pos && typeof pos.left === 'number' && typeof pos.top === 'number' );
if ( wasUserMoved ) {
applyPos( clamp( pos ) );
} else {
applyPos( defaultPos() );
}
var dragging = false;
var moved = false;
var startX = 0, startY = 0;
var startLeft = 0, startTop = 0;
var pointerId = null;
function onDown( e ) {
if ( e.target.closest( '.gadget-toc__panel' ) ) {
return;
}
dragging = true;
moved = false;
pointerId = e.pointerId;
var r = currentPos();
startX = e.clientX;
startY = e.clientY;
startLeft = r.left;
startTop = r.top;
btn.classList.add( 'is-dragging' );
if ( btn.setPointerCapture ) {
btn.setPointerCapture( pointerId );
}
e.preventDefault();
}
function onMove( e ) {
if ( !dragging || e.pointerId !== pointerId ) {
return;
}
var dx = e.clientX - startX;
var dy = e.clientY - startY;
if ( Math.abs( dx ) > 3 || Math.abs( dy ) > 3 ) {
moved = true;
}
applyPos( clamp( { left: startLeft + dx, top: startTop + dy } ) );
}
function onUp( e ) {
if ( !dragging || e.pointerId !== pointerId ) {
return;
}
dragging = false;
btn.classList.remove( 'is-dragging' );
if ( btn.releasePointerCapture ) {
btn.releasePointerCapture( pointerId );
}
pointerId = null;
if ( moved ) {
savePos( clamp( currentPos() ) );
}
}
btn.addEventListener( 'pointerdown', onDown );
document.addEventListener( 'pointermove', onMove );
document.addEventListener( 'pointerup', onUp );
document.addEventListener( 'pointercancel', onUp );
// Пересчёт при изменении видимой области (зум, скролл, поворот)
function onViewportChange() {
if ( wasUserMoved ) {
applyPos( clamp( currentPos() ) );
} else {
applyPos( defaultPos() );
}
}
if ( useVV ) {
vv.addEventListener( 'resize', onViewportChange );
vv.addEventListener( 'scroll', onViewportChange );
}
window.addEventListener( 'resize', onViewportChange );
window.addEventListener( 'orientationchange', onViewportChange );
// Подавляем click после перетаскивания
btn.addEventListener( 'click', function ( e ) {
if ( moved ) {
e.stopImmediatePropagation();
e.preventDefault();
moved = false;
}
}, true );
btn.addEventListener( 'pointerdown', function () {
wasUserMoved = true;
} );
}() );
// ---------- 5. Список ----------
var links = {};
// Пункт «Преамбула» — переход к началу статьи (нулевой раздел)
var introLi = document.createElement( 'li' );
introLi.className = 'gadget-toc__item gadget-toc__item--intro';
var introA = document.createElement( 'a' );
introA.href = '#';
introA.textContent = 'Преамбула';
introA.dataset.id = '__intro__';
introA.addEventListener( 'click', function ( e ) {
e.preventDefault();
article.scrollIntoView( {
behavior: prefersReduced() ? 'auto' : 'smooth',
block: 'start'
} );
if ( window.history && window.history.replaceState ) {
window.history.replaceState( null, '', '#' );
}
setActive( '__intro__' );
if ( window.innerWidth < 720 ) {
setExpanded( false );
}
} );
introLi.appendChild( introA );
list.appendChild( introLi );
links[ '__intro__' ] = introA;
headings.forEach( function ( h ) {
var li = document.createElement( 'li' );
li.className = 'gadget-toc__item' + ( h.level === 3 ? ' gadget-toc__item--sub' : '' );
var a = document.createElement( 'a' );
a.href = '#' + h.id;
a.textContent = h.text;
a.dataset.id = h.id;
a.addEventListener( 'click', function ( e ) {
e.preventDefault();
h.el.scrollIntoView( {
behavior: prefersReduced() ? 'auto' : 'smooth',
block: 'start'
} );
if ( window.history && window.history.replaceState ) {
window.history.replaceState( null, '', '#' + h.id );
}
setActive( h.id );
if ( window.innerWidth < 720 ) {
setExpanded( false );
}
} );
li.appendChild( a );
list.appendChild( li );
links[ h.id ] = a;
} );
// ---------- 6. Прогресс ----------
var RING_LEN = 2 * Math.PI * CONFIG.ringRadius;
ringFg.style.strokeDasharray = RING_LEN;
function updateProgress() {
var doc = document.documentElement;
var max = doc.scrollHeight - window.innerHeight;
var p = max > 0 ? Math.min( 1, Math.max( 0, window.scrollY / max ) ) : 1;
pct.textContent = Math.round( p * 100 ) + '%';
ringFg.style.strokeDashoffset = RING_LEN * ( 1 - p );
root.classList.toggle( 'is-visible', window.scrollY >= CONFIG.minScrollToShow );
// При зуме ограничиваем высоту панели видимой областью,
// чтобы внутренний скролл доходил до конца.
if ( expanded && window.visualViewport && window.visualViewport.scale > 1 ) {
var vv = window.visualViewport;
var b = btn.getBoundingClientRect();
var available = vv.offsetTop + vv.height - b.bottom - 8;
var scale = vv.scale;
panel.style.maxHeight = Math.max( 120, available * scale ) + 'px';
} else if ( expanded ) {
panel.style.maxHeight = '';
}
headings.forEach( function ( h ) {
var done = h.el.getBoundingClientRect().bottom < 0;
var a = links[ h.id ];
if ( a ) {
a.classList.toggle( 'is-done', done );
}
} );
}
var ticking = false;
window.addEventListener( 'scroll', function () {
if ( !ticking ) {
ticking = true;
window.requestAnimationFrame( function () {
updateProgress();
ticking = false;
} );
}
}, { passive: true } );
window.addEventListener( 'resize', updateProgress );
// Если мы выше первого заголовка — активна «Преамбула»
if ( headings.length ) {
var firstTop = headings[ 0 ].el.getBoundingClientRect().top;
if ( firstTop > CONFIG.headerOffset ) {
setActive( '__intro__' );
}
}
// ---------- 7. Scroll-spy ----------
function setActive( id ) {
Object.keys( links ).forEach( function ( key ) {
var on = key === id;
links[ key ].classList.toggle( 'is-active', on );
links[ key ].setAttribute( 'aria-current', on ? 'location' : 'false' );
} );
}
if ( 'IntersectionObserver' in window ) {
var io = new IntersectionObserver( function ( entries ) {
entries.forEach( function ( e ) {
if ( e.isIntersecting ) {
setActive( e.target.id );
}
} );
}, { rootMargin: '-' + ( CONFIG.headerOffset + 8 ) + 'px 0px -70% 0px' } );
headings.forEach( function ( h ) { io.observe( h.el ); } );
}
// ---------- 7b. Авто-позиционирование панели ----------
// Открывает панель в ту сторону от кнопки, где есть место,
// и клампит её по видимой области. На мобильном (bottom-sheet) не трогает.
function positionPanel() {
if ( window.innerWidth < 720 ) {
// Мобильный bottom-sheet — позиционируется CSS
panel.style.transform = '';
return;
}
var vv = window.visualViewport || null;
var useVV = CONFIG.useVisualViewport && vv;
// Видимая область
var vr = useVV ? {
left: vv.offsetLeft,
top: vv.offsetTop,
width: vv.width,
height: vv.height
} : {
left: 0,
top: 0,
width: window.innerWidth,
height: window.innerHeight
};
// Размеры кнопки
var b = btn.getBoundingClientRect();
// Панель измеряем до позиционирования — временно показываем
var wasHidden = panel.hidden;
panel.hidden = false;
panel.style.transform = 'translate(0,0)';
var pw = panel.offsetWidth || 280;
var ph = panel.offsetHeight || 300;
var gap = 8; // отступ между кнопкой и панелью
// Куда открывать по вертикали: вниз, если есть место, иначе вверх
var spaceBelow = vr.top + vr.height - ( b.bottom + gap );
var spaceAbove = ( b.top - gap ) - vr.top;
var openBelow = spaceBelow >= ph || spaceBelow >= spaceAbove;
var top;
if ( openBelow ) {
top = b.bottom + gap;
} else {
top = b.top - gap - ph;
}
// Куда открывать по горизонтали: вправо от кнопки,
// если не влезает — влево.
var spaceRight = vr.left + vr.width - b.right;
var spaceLeft = b.left - vr.left;
var openRight = spaceRight >= pw || spaceRight >= spaceLeft;
var left;
if ( openRight ) {
left = b.right + gap;
} else {
left = b.left - gap - pw;
}
// Клампим по видимой области
var maxLeft = vr.left + vr.width - pw;
var maxTop = vr.top + vr.height - ph;
left = Math.min( Math.max( vr.left, left ), Math.max( vr.left, maxLeft ) );
top = Math.min( Math.max( vr.top, top ), Math.max( vr.top, maxTop ) );
// translate задаём относительно root (у него transform = translate кнопки).
// Панель — дочерний элемент root, поэтому её координаты абсолютные
// внутри root; вычитаем позицию root.
var r = root.getBoundingClientRect();
var relLeft = left - r.left;
var relTop = top - r.top;
// Компенсируем масштаб, чтобы панель не росла при зуме
var scale = useVV ? vv.scale : 1;
var inv = scale > 1 ? 1 / scale : 1;
panel.style.transformOrigin = '0 0';
panel.style.transform =
'translate(' + relLeft + 'px,' + relTop + 'px) scale(' + inv + ')';
if ( wasHidden ) {
panel.hidden = true;
}
}
// ---------- 8. Свернуть/развернуть ----------
function setExpanded( v ) {
expanded = v;
root.classList.toggle( 'is-open', v );
panel.hidden = !v;
btn.setAttribute( 'aria-expanded', String( v ) );
if ( v ) {
positionPanel();
}
try {
localStorage.setItem( CONFIG.storageKey, JSON.stringify( { expanded: v } ) );
} catch ( e ) { /* ignore */ }
if ( v ) {
scheduleAutoCollapse();
} else {
clearTimeout( autoCollapseTimer );
}
}
function scheduleAutoCollapse() {
clearTimeout( autoCollapseTimer );
autoCollapseTimer = setTimeout( function () {
if ( window.innerWidth >= 720 ) {
setExpanded( false );
}
}, CONFIG.autoCollapseMs );
}
btn.addEventListener( 'click', function () {
setExpanded( !expanded );
} );
closeBtn.addEventListener( 'click', function () {
setExpanded( false );
} );
document.addEventListener( 'click', function ( e ) {
if ( expanded && !root.contains( e.target ) ) {
setExpanded( false );
}
} );
document.addEventListener( 'keydown', function ( e ) {
if ( e.key === 'Escape' && expanded ) {
setExpanded( false );
btn.focus();
}
} );
// Пересчёт панели при изменении видимой области
function repositionPanel() {
if ( expanded ) {
positionPanel();
}
}
if ( window.visualViewport ) {
window.visualViewport.addEventListener( 'resize', repositionPanel );
}
window.addEventListener( 'resize', repositionPanel );
// ---------- 9. Старт ----------
setExpanded( expanded );
updateProgress();
}() );