Mirrors
/
gitea
mirror of https://github.com/go-gitea/gitea.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix and rewrite markup anchor processing (#29931) 

Fix #29877

---------

Co-authored-by: silverwind <me@silverwind.io>
This commit is contained in:
Lunny Xiao 2024-03-21 07:02:53 +08:00 committed by GitHub
parent 286268c915
commit 76ec541051
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 50 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
web_src/js/markup/anchors.js
View File

@ -1,50 +1,68 @@
import {svg} from '../svg.js'; import {svg} from '../svg.js';
const headingSelector = '.markup h1, .markup h2, .markup h3, .markup h4, .markup h5, .markup h6';
// 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(hash, initial) { function scrollToAnchor(encodedId, initial) {
// abort if the browser has already scrolled to another anchor during page load // abort if the browser has already scrolled to another anchor during page load
if (initial && document.querySelector(':target')) return; if (!encodedId || (initial && document.querySelector(':target'))) return;
if (hash?.length <= 1) return; const id = decodeURIComponent(encodedId);
const id = decodeURIComponent(hash.substring(1)); let el = document.getElementById(`user-content-${id}`);
const el = document.getElementById(`user-content-${id}`);
if (el) { // check for matching user-generated `a[name]`
el.scrollIntoView(); if (!el) {
} else if (id.startsWith('user-content-')) { // compat for links with old 'user-content-' prefixed hashes const nameAnchors = document.getElementsByName(`user-content-${id}`);
if (nameAnchors.length) {
el = nameAnchors[0];
}
}
// compat for links with old 'user-content-' prefixed hashes
if (!el && id.startsWith('user-content-')) {
const el = document.getElementById(id); const el = document.getElementById(id);
if (el) el.scrollIntoView(); if (el) el.scrollIntoView();
} }
if (el) {
el.scrollIntoView();
}
} }
export function initMarkupAnchors() { export function initMarkupAnchors() {
if (!document.querySelector('.markup')) return; const markupEls = document.querySelectorAll('.markup');
if (!markupEls.length) return;
// create link icons for markup headings, the resulting link href will remove `user-content-` for (const markupEl of markupEls) {
for (const heading of document.querySelectorAll(headingSelector)) { // create link icons for markup headings, the resulting link href will remove `user-content-`
const originalId = heading.id.replace(/^user-content-/, ''); for (const heading of markupEl.querySelectorAll(`:is(h1, h2, h3, h4, h5, h6`)) {
const a = document.createElement('a'); const originalId = heading.id.replace(/^user-content-/, '');
a.classList.add('anchor'); const a = document.createElement('a');
a.setAttribute('href', `#${encodeURIComponent(originalId)}`); a.classList.add('anchor');
a.innerHTML = svg('octicon-link'); a.setAttribute('href', `#${encodeURIComponent(originalId)}`);
a.addEventListener('click', (e) => { a.innerHTML = svg('octicon-link');
scrollToAnchor(e.currentTarget.getAttribute('href'), false); heading.prepend(a);
}); }
heading.prepend(a);
}
// handle user-defined `name` anchors like `[Link](#link)` linking to `<a name="link"></a>Link` // remove `user-content-` prefix from links so they don't show in url bar when clicked
for (const a of document.querySelectorAll('.markup 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-/, ''); const originalId = href.replace(/^#user-content-/, '');
a.setAttribute('href', `#${encodeURIComponent(originalId)}`); a.setAttribute('href', `#${originalId}`);
if (a.closest('.markup').querySelectorAll(`a[name="${originalId}"]`).length !== 1) { }
// add `user-content-` prefix to user-generated `a[name]` link targets
// TODO: this prefix should be added in backend instead
for (const a of markupEl.querySelectorAll('a[name]')) {
const name = a.getAttribute('name');
if (!name) continue;
a.setAttribute('name', `user-content-${a.name}`);
}
for (const a of markupEl.querySelectorAll('a[href^="#"]')) {
a.addEventListener('click', (e) => { a.addEventListener('click', (e) => {
scrollToAnchor(e.currentTarget.getAttribute('href'), false); scrollToAnchor(e.currentTarget.getAttribute('href')?.substring(1), false);
}); });
} }
} }
scrollToAnchor(window.location.hash, true); scrollToAnchor(window.location.hash.substring(1), true);
} }