我最终为它使用了一个自定义主题组件:
// A-Z 排序需要获取整个分类:核心代码无法按标题对主题列表进行排序
// (TopicQuery::SORTABLE_MAPPING 中没有 "title"),因此我们在排序前
// 先遍历完分页列表。设置了上限——文档分类通常较小;如果更大,则回退到
// 对已加载的内容进行排序,下方的 MutationObserver 会保持其最新状态。
// ponytail: 如果核心代码将来支持服务端标题排序,请删除此整个循环。
const MAX_DOC_PAGES = 12; // 每页 30 个主题,约 360 个主题
let docLoadRun = 0;
async function loadAllDocTopics(api) {
const run = ++docLoadRun;
// `controller:discovery/topics` 在当前 Discourse 版本中已弃用
// (弃用 ID: discourse.discovery-topics-controller)。Discovery 现在为每个筛选器
// 使用专用的控制器;文档分类始终是最新主题列表,因此我们直接查找该控制器。
// 如果这里失败,只是意味着我们只排序第一页,因此每一步都使用了可选链。
const list = api.container.lookup("controller:discovery/latest")?.model;
if (!list?.loadMore) {
return;
}
for (let page = 0; page < MAX_DOC_PAGES; page++) {
if (!list.more_topics_url) {
return;
}
const before = list.topics?.length ?? 0;
await list.loadMore();
// 加载中途导航离开,或者列表停止增长——无论哪种情况,都停止。
if (run !== docLoadRun || (list.topics?.length ?? 0) === before) {
return;
}
}
}
// 按 A-Z 顺序对文档主题列表进行排序,并使用页面自身的 <html lang> 进行排序规则匹配。
let docSortObservers = new Map();
function docSortLocale() {
const lang = document.documentElement.lang;
if (!lang) {
return undefined;
}
try {
Intl.getCanonicalLocales(lang); // 如果标签格式错误,会抛出 RangeError
return lang;
} catch {
return undefined; // 回退到浏览器的默认区域设置
}
}
function sortDocTopicList(body, locale) {
const rows = [...body.querySelectorAll(":scope > .topic-list-item")];
if (rows.length < 2) {
return;
}
const sorted = [...rows].sort((a, b) => {
const titleA = a.querySelector(".title")?.textContent.trim() ?? "";
const titleB = b.querySelector(".title")?.textContent.trim() ?? "";
return titleA.localeCompare(titleB, locale);
});
if (sorted.every((row, i) => rows[i] === row)) {
return; // 已经排序——防止观察器自我触发
}
// 插入到行之后跟随的内容之前,保持任何“加载更多”哨兵在最后。
const anchor = rows[rows.length - 1].nextSibling;
// 固定第一个可见行,以便在其上方插入时不会导致滚动跳动。
const pinned = rows.find((row) => row.getBoundingClientRect().bottom > 0);
const pinnedTop = pinned?.getBoundingClientRect().top;
// 暂停观察器,以便我们自己的移动不会重新进入此函数。
const observer = docSortObservers.get(body);
observer?.disconnect();
sorted.forEach((row) => body.insertBefore(row, anchor));
observer?.observe(body, { childList: true });
if (pinned) {
window.scrollBy(0, pinned.getBoundingClientRect().top - pinnedTop);
}
}
function sortDocCategoryTopicLists() {
docSortObservers.forEach((observer) => observer.disconnect());
docSortObservers = new Map();
const locale = docSortLocale();
// 不是 flex/grid 容器,因此重新排序必须移动 DOM 节点——CSS `order` 会被忽略。
document.querySelectorAll(".topic-list.doc-simple-mode .topic-list-body").forEach((body) => {
// try/finally 确保即使排序抛出异常,列表也会始终显示。
try {
sortDocTopicList(body, locale);
} finally {
body.classList.add("docs-sorted");
}
// 仅在加载平静后排序一次——加载中途重新排序会导致加载器停滞。
let settleTimer = null;
const observer = new MutationObserver(() => {
window.clearTimeout(settleTimer);
settleTimer = window.setTimeout(() => {
sortDocTopicList(body, locale);
}, 400);
});
observer.observe(body, { childList: true });
docSortObservers.set(body, observer);
});
}
我认为这段代码很可能可以改进,我很乐意接受建议和/或 PR。