From 46b63b68bf02491f841a794d72f3def6649ec72f Mon Sep 17 00:00:00 2001
From: Danny van Tol <19685217+dannyvtol@users.noreply.github.com>
Date: Sat, 24 Aug 2024 19:56:17 +0000
Subject: [PATCH] fix: Link visibility in exampanded TOC while collapseByDefault is true (#1371)
---
quartz/components/scripts/graph.inline.ts | 139 ++++++++++++++++++++++++++++++++++------------
1 files changed, 102 insertions(+), 37 deletions(-)
diff --git a/quartz/components/scripts/graph.inline.ts b/quartz/components/scripts/graph.inline.ts
index bea32eb..cda6fb5 100644
--- a/quartz/components/scripts/graph.inline.ts
+++ b/quartz/components/scripts/graph.inline.ts
@@ -1,31 +1,32 @@
import type { ContentDetails } from "../../plugins/emitters/contentIndex"
import * as d3 from "d3"
import { registerEscapeHandler, removeAllChildren } from "./util"
-import { CanonicalSlug, getCanonicalSlug, getClientSlug, resolveRelative } from "../../util/path"
+import { FullSlug, SimpleSlug, getFullSlug, resolveRelative, simplifySlug } from "../../util/path"
type NodeData = {
- id: CanonicalSlug
+ id: SimpleSlug
text: string
tags: string[]
} & d3.SimulationNodeDatum
type LinkData = {
- source: CanonicalSlug
- target: CanonicalSlug
+ source: SimpleSlug
+ target: SimpleSlug
}
const localStorageKey = "graph-visited"
-function getVisited(): Set<CanonicalSlug> {
+function getVisited(): Set<SimpleSlug> {
return new Set(JSON.parse(localStorage.getItem(localStorageKey) ?? "[]"))
}
-function addToVisited(slug: CanonicalSlug) {
+function addToVisited(slug: SimpleSlug) {
const visited = getVisited()
visited.add(slug)
localStorage.setItem(localStorageKey, JSON.stringify([...visited]))
}
-async function renderGraph(container: string, slug: CanonicalSlug) {
+async function renderGraph(container: string, fullSlug: FullSlug) {
+ const slug = simplifySlug(fullSlug)
const visited = getVisited()
const graph = document.getElementById(container)
if (!graph) return
@@ -41,22 +42,45 @@
linkDistance,
fontSize,
opacityScale,
+ removeTags,
+ showTags,
+ focusOnHover,
} = JSON.parse(graph.dataset["cfg"]!)
- const data = await fetchData
-
+ const data: Map<SimpleSlug, ContentDetails> = new Map(
+ Object.entries<ContentDetails>(await fetchData).map(([k, v]) => [
+ simplifySlug(k as FullSlug),
+ v,
+ ]),
+ )
const links: LinkData[] = []
- for (const [src, details] of Object.entries<ContentDetails>(data)) {
+ const tags: SimpleSlug[] = []
+
+ const validLinks = new Set(data.keys())
+ for (const [source, details] of data.entries()) {
const outgoing = details.links ?? []
+
for (const dest of outgoing) {
- if (src in data && dest in data) {
- links.push({ source: src as CanonicalSlug, target: dest })
+ if (validLinks.has(dest)) {
+ links.push({ source: source, target: dest })
+ }
+ }
+
+ if (showTags) {
+ const localTags = details.tags
+ .filter((tag) => !removeTags.includes(tag))
+ .map((tag) => simplifySlug(("tags/" + tag) as FullSlug))
+
+ tags.push(...localTags.filter((tag) => !tags.includes(tag)))
+
+ for (const tag of localTags) {
+ links.push({ source: source, target: tag })
}
}
}
- const neighbourhood = new Set<CanonicalSlug>()
- const wl: (CanonicalSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
+ const neighbourhood = new Set<SimpleSlug>()
+ const wl: (SimpleSlug | "__SENTINEL")[] = [slug, "__SENTINEL"]
if (depth >= 0) {
while (depth >= 0 && wl.length > 0) {
// compute neighbours
@@ -72,15 +96,19 @@
}
}
} else {
- Object.keys(data).forEach((id) => neighbourhood.add(id as CanonicalSlug))
+ validLinks.forEach((id) => neighbourhood.add(id))
+ if (showTags) tags.forEach((tag) => neighbourhood.add(tag))
}
const graphData: { nodes: NodeData[]; links: LinkData[] } = {
- nodes: [...neighbourhood].map((url) => ({
- id: url,
- text: data[url]?.title ?? url,
- tags: data[url]?.tags ?? [],
- })),
+ nodes: [...neighbourhood].map((url) => {
+ const text = url.startsWith("tags/") ? "#" + url.substring(5) : (data.get(url)?.title ?? url)
+ return {
+ id: url,
+ text: text,
+ tags: data.get(url)?.tags ?? [],
+ }
+ }),
links: links.filter((l) => neighbourhood.has(l.source) && neighbourhood.has(l.target)),
}
@@ -124,7 +152,7 @@
const isCurrent = d.id === slug
if (isCurrent) {
return "var(--secondary)"
- } else if (visited.has(d.id)) {
+ } else if (visited.has(d.id) || d.id.startsWith("tags/")) {
return "var(--tertiary)"
} else {
return "var(--gray)"
@@ -162,6 +190,8 @@
return 2 + Math.sqrt(numLinks)
}
+ let connectedNodes: SimpleSlug[] = []
+
// draw individual nodes
const node = graphNode
.append("circle")
@@ -171,21 +201,41 @@
.attr("fill", color)
.style("cursor", "pointer")
.on("click", (_, d) => {
- const targ = resolveRelative(slug, d.id)
- window.spaNavigate(new URL(targ, getClientSlug(window)))
+ const targ = resolveRelative(fullSlug, d.id)
+ window.spaNavigate(new URL(targ, window.location.toString()))
})
.on("mouseover", function (_, d) {
- const neighbours: CanonicalSlug[] = data[slug].links ?? []
- const neighbourNodes = d3
- .selectAll<HTMLElement, NodeData>(".node")
- .filter((d) => neighbours.includes(d.id))
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
.filter((d: any) => d.source.id === currentId || d.target.id === currentId)
- // highlight neighbour nodes
- neighbourNodes.transition().duration(200).attr("fill", color)
+ if (focusOnHover) {
+ // fade out non-neighbour nodes
+ connectedNodes = linkNodes.data().flatMap((d: any) => [d.source.id, d.target.id])
+
+ d3.selectAll<HTMLElement, NodeData>(".link")
+ .transition()
+ .duration(200)
+ .style("opacity", 0.2)
+ d3.selectAll<HTMLElement, NodeData>(".node")
+ .filter((d) => !connectedNodes.includes(d.id))
+ .transition()
+ .duration(200)
+ .style("opacity", 0.2)
+
+ d3.selectAll<HTMLElement, NodeData>(".node")
+ .filter((d) => !connectedNodes.includes(d.id))
+ .nodes()
+ .map((it) => d3.select(it.parentNode as HTMLElement).select("text"))
+ .forEach((it) => {
+ let opacity = parseFloat(it.style("opacity"))
+ it.transition()
+ .duration(200)
+ .attr("opacityOld", opacity)
+ .style("opacity", Math.min(opacity, 0.2))
+ })
+ }
// highlight links
linkNodes.transition().duration(200).attr("stroke", "var(--gray)").attr("stroke-width", 1)
@@ -204,6 +254,16 @@
.style("font-size", bigFont + "em")
})
.on("mouseleave", function (_, d) {
+ if (focusOnHover) {
+ d3.selectAll<HTMLElement, NodeData>(".link").transition().duration(200).style("opacity", 1)
+ d3.selectAll<HTMLElement, NodeData>(".node").transition().duration(200).style("opacity", 1)
+
+ d3.selectAll<HTMLElement, NodeData>(".node")
+ .filter((d) => !connectedNodes.includes(d.id))
+ .nodes()
+ .map((it) => d3.select(it.parentNode as HTMLElement).select("text"))
+ .forEach((it) => it.transition().duration(200).style("opacity", it.attr("opacityOld")))
+ }
const currentId = d.id
const linkNodes = d3
.selectAll(".link")
@@ -222,15 +282,20 @@
// @ts-ignore
.call(drag(simulation))
+ // make tags hollow circles
+ node
+ .filter((d) => d.id.startsWith("tags/"))
+ .attr("stroke", color)
+ .attr("stroke-width", 2)
+ .attr("fill", "var(--light)")
+
// draw labels
const labels = graphNode
.append("text")
.attr("dx", 0)
.attr("dy", (d) => -nodeRadius(d) + "px")
.attr("text-anchor", "middle")
- .text(
- (d) => data[d.id]?.title || (d.id.charAt(1).toUpperCase() + d.id.slice(2)).replace("-", " "),
- )
+ .text((d) => d.text)
.style("opacity", (opacityScale - 1) / 3.75)
.style("pointer-events", "none")
.style("font-size", fontSize + "em")
@@ -271,7 +336,7 @@
}
function renderGlobalGraph() {
- const slug = getCanonicalSlug(window)
+ const slug = getFullSlug(window)
const container = document.getElementById("global-graph-outer")
const sidebar = container?.closest(".sidebar") as HTMLElement
container?.classList.add("active")
@@ -294,12 +359,12 @@
registerEscapeHandler(container, hideGlobalGraph)
}
-document.addEventListener("nav", async (e: unknown) => {
- const slug = (e as CustomEventMap["nav"]).detail.url
- addToVisited(slug)
+document.addEventListener("nav", async (e: CustomEventMap["nav"]) => {
+ const slug = e.detail.url
+ addToVisited(simplifySlug(slug))
await renderGraph("graph-container", slug)
const containerIcon = document.getElementById("global-graph-icon")
- containerIcon?.removeEventListener("click", renderGlobalGraph)
containerIcon?.addEventListener("click", renderGlobalGraph)
+ window.addCleanup(() => containerIcon?.removeEventListener("click", renderGlobalGraph))
})
--
Gitblit v1.10.0