forks/forgejo
1
0
Fork 0
Code Releases Activity

Small refactors in anchors.js (#29947)

Browse source 
Some minor refactors, remove unnecessary `:is` selector and move the
`:target` check out of the function. Might as well backport for the rare
browser that does not support `:is`.

(cherry picked from commit 29118743a58cf3172bddb6a4fa287484c62b4eb1)
This commit is contained in:
silverwind 2024-03-22 13:28:38 +01:00 committed by Earl Warren
parent f63ed42087
commit c97a7b8347
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
1 changed files with 21 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
web_src/js/markup/anchors.js
View file

@ -1,29 +1,30 @@
import {svg} from '../svg.js'; import {svg} from '../svg.js';
const addPrefix = (str) => `user-content-${str}`;
const removePrefix = (str) => str.replace(/^user-content-/, '');
const hasPrefix = (str) => str.startsWith('user-content-');
// scroll to anchor while respecting the `user-content` prefix that exists on the target // scroll to anchor while respecting the `user-content` prefix that exists on the target
function scrollToAnchor(encodedId, initial) { function scrollToAnchor(encodedId) {
// abort if the browser has already scrolled to another anchor during page load if (!encodedId) return;
if (!encodedId || (initial && document.querySelector(':target'))) return;
const id = decodeURIComponent(encodedId); const id = decodeURIComponent(encodedId);
let el = document.getElementById(`user-content-${id}`); const prefixedId = addPrefix(id);
let el = document.getElementById(prefixedId);
// check for matching user-generated `a[name]` // check for matching user-generated `a[name]`
if (!el) { if (!el) {
const nameAnchors = document.getElementsByName(`user-content-${id}`); const nameAnchors = document.getElementsByName(prefixedId);
if (nameAnchors.length) { if (nameAnchors.length) {
el = nameAnchors[0]; el = nameAnchors[0];
} }
} }
// compat for links with old 'user-content-' prefixed hashes // compat for links with old 'user-content-' prefixed hashes
if (!el && id.startsWith('user-content-')) { if (!el && hasPrefix(id)) {
const el = document.getElementById(id); return document.getElementById(id)?.scrollIntoView();
if (el) el.scrollIntoView();
} }
if (el) { el?.scrollIntoView();
el.scrollIntoView();
}
} }
export function initMarkupAnchors() { export function initMarkupAnchors() {
@ -32,11 +33,10 @@ export function initMarkupAnchors() {
for (const markupEl of markupEls) { for (const markupEl of markupEls) {
// create link icons for markup headings, the resulting link href will remove `user-content-` // create link icons for markup headings, the resulting link href will remove `user-content-`
for (const heading of markupEl.querySelectorAll(`:is(h1, h2, h3, h4, h5, h6`)) { for (const heading of markupEl.querySelectorAll('h1, h2, h3, h4, h5, h6')) {
const originalId = heading.id.replace(/^user-content-/, '');
const a = document.createElement('a'); const a = document.createElement('a');
a.classList.add('anchor'); a.classList.add('anchor');
a.setAttribute('href', `#${encodeURIComponent(originalId)}`); a.setAttribute('href', `#${encodeURIComponent(removePrefix(heading.id))}`);
a.innerHTML = svg('octicon-link'); a.innerHTML = svg('octicon-link');
heading.prepend(a); heading.prepend(a);
} }
@ -45,8 +45,7 @@ export function initMarkupAnchors() {
for (const a of markupEl.querySelectorAll('a[href^="#"]')) { for (const a of markupEl.querySelectorAll('a[href^="#"]')) {
const href = a.getAttribute('href'); const href = a.getAttribute('href');
if (!href.startsWith('#user-content-')) continue; if (!href.startsWith('#user-content-')) continue;
const originalId = href.replace(/^#user-content-/, ''); a.setAttribute('href', `#${removePrefix(href.substring(1))}`);
a.setAttribute('href', `#${originalId}`);
} }
// add `user-content-` prefix to user-generated `a[name]` link targets // add `user-content-` prefix to user-generated `a[name]` link targets
@ -54,15 +53,18 @@ export function initMarkupAnchors() {
for (const a of markupEl.querySelectorAll('a[name]')) { for (const a of markupEl.querySelectorAll('a[name]')) {
const name = a.getAttribute('name'); const name = a.getAttribute('name');
if (!name) continue; if (!name) continue;
a.setAttribute('name', `user-content-${a.name}`); a.setAttribute('name', addPrefix(a.name));
} }
for (const a of markupEl.querySelectorAll('a[href^="#"]')) { for (const a of markupEl.querySelectorAll('a[href^="#"]')) {
a.addEventListener('click', (e) => { a.addEventListener('click', (e) => {
scrollToAnchor(e.currentTarget.getAttribute('href')?.substring(1), false); scrollToAnchor(e.currentTarget.getAttribute('href')?.substring(1));
}); });
} }
} }
scrollToAnchor(window.location.hash.substring(1), true); // scroll to anchor unless the browser has already scrolled somewhere during page load
if (!document.querySelector(':target')) {
scrollToAnchor(window.location.hash?.substring(1));
}
} }