Fix useTsLinkResolution in block tags

Author: Gerrit0

CHANGELOG.md

@@ -9,6 +9,9 @@
 
 ### Bug Fixes
 
+-   `--useTsLinkResolution` is no longer ignored within block tags, #2260.
+-   The current namespace will also be expanded in the navigation on page load, #2260.
+-   Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
 -   Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
 
 ### Thanks!

src/lib/converter/comments/blockLexer.ts

@@ -45,14 +45,27 @@ function getLinkTags(
 ): ReadonlyArray<ts.JSDocLink | ts.JSDocLinkCode | ts.JSDocLinkPlain> {
     const result: (ts.JSDocLink | ts.JSDocLinkCode | ts.JSDocLinkPlain)[] = [];
 
-    if (!jsDoc || typeof jsDoc.comment !== "object") return result;
-
-    for (const part of jsDoc.comment) {
-        switch (part.kind) {
-            case ts.SyntaxKind.JSDocLink:
-            case ts.SyntaxKind.JSDocLinkCode:
-            case ts.SyntaxKind.JSDocLinkPlain:
-                result.push(part);
+    if (jsDoc?.comment && typeof jsDoc.comment !== "string") {
+        for (const part of jsDoc.comment) {
+            switch (part.kind) {
+                case ts.SyntaxKind.JSDocLink:
+                case ts.SyntaxKind.JSDocLinkCode:
+                case ts.SyntaxKind.JSDocLinkPlain:
+                    result.push(part);
+            }
+        }
+    }
+
+    for (const block of jsDoc?.tags || []) {
+        if (!block.comment || typeof block.comment === "string") continue;
+
+        for (const part of block.comment) {
+            switch (part.kind) {
+                case ts.SyntaxKind.JSDocLink:
+                case ts.SyntaxKind.JSDocLinkCode:
+                case ts.SyntaxKind.JSDocLinkPlain:
+                    result.push(part);
+            }
         }
     }
 

src/lib/output/themes/default/assets/bootstrap.ts

@@ -5,42 +5,17 @@ import { Filter } from "./typedoc/components/Filter";
 import { Accordion } from "./typedoc/components/Accordion";
 import { initTheme } from "./typedoc/Theme";
 
-addEventListener("load", () => {
-    initSearch();
-    initCopyCode();
+initSearch();
 
-    registerComponent(Toggle, "a[data-toggle]");
-    registerComponent(Accordion, ".tsd-index-accordion");
-    registerComponent(Filter, ".tsd-filter-item input[type=checkbox]");
+registerComponent(Toggle, "a[data-toggle]");
+registerComponent(Accordion, ".tsd-index-accordion");
+registerComponent(Filter, ".tsd-filter-item input[type=checkbox]");
 
-    const themeChoice = document.getElementById("tsd-theme");
-    if (themeChoice) {
-        initTheme(themeChoice as HTMLOptionElement);
-    }
-
-    const app = new Application();
+const themeChoice = document.getElementById("tsd-theme");
+if (themeChoice) {
+    initTheme(themeChoice as HTMLOptionElement);
+}
 
-    Object.defineProperty(window, "app", { value: app });
-});
+const app = new Application();
 
-function initCopyCode() {
-    document.querySelectorAll("pre > button").forEach((button) => {
-        let timeout: ReturnType<typeof setTimeout>;
-        button.addEventListener("click", () => {
-            if (button.previousElementSibling instanceof HTMLElement) {
-                navigator.clipboard.writeText(
-                    button.previousElementSibling.innerText.trim()
-                );
-            }
-            button.textContent = "Copied!";
-            button.classList.add("visible");
-            clearTimeout(timeout);
-            timeout = setTimeout(() => {
-                button.classList.remove("visible");
-                timeout = setTimeout(() => {
-                    button.textContent = "Copy";
-                }, 100);
-            }, 1000);
-        });
-    });
-}
+Object.defineProperty(window, "app", { value: app });

src/lib/output/themes/default/assets/typedoc/Application.ts

@@ -39,6 +39,7 @@ export class Application {
         this.createComponents(document.body);
         this.ensureActivePageVisible();
         this.ensureFocusedElementVisible();
+        this.listenForCodeCopies();
         window.addEventListener("hashchange", () =>
             this.ensureFocusedElementVisible()
         );
@@ -66,11 +67,8 @@ export class Application {
         const pageLink = document.querySelector(".tsd-navigation .current");
         let iter = pageLink?.parentElement;
         while (iter && !iter.classList.contains(".tsd-navigation")) {
-            // Expand parent namespaces if collapsed, don't expand current namespace
-            if (
-                iter instanceof HTMLDetailsElement &&
-                pageLink?.parentElement?.parentElement !== iter
-            ) {
+            // Expand parent namespaces if collapsed, and this module
+            if (iter instanceof HTMLDetailsElement) {
                 iter.open = true;
             }
             iter = iter.parentElement;
@@ -125,4 +123,26 @@ export class Application {
             reflContainer.prepend(warning);
         }
     }
+
+    private listenForCodeCopies() {
+        document.querySelectorAll("pre > button").forEach((button) => {
+            let timeout: ReturnType<typeof setTimeout>;
+            button.addEventListener("click", () => {
+                if (button.previousElementSibling instanceof HTMLElement) {
+                    navigator.clipboard.writeText(
+                        button.previousElementSibling.innerText.trim()
+                    );
+                }
+                button.textContent = "Copied!";
+                button.classList.add("visible");
+                clearTimeout(timeout);
+                timeout = setTimeout(() => {
+                    button.classList.remove("visible");
+                    timeout = setTimeout(() => {
+                        button.textContent = "Copy";
+                    }, 100);
+                }, 1000);
+            });
+        });
+    }
 }