typedoc 0.24.0-beta.6 → 0.24.0-beta.8

package/dist/lib/models/comments/comment.d.ts

@@ -1,4 +1,5 @@
-import type { Reflection, ReflectionSymbolId } from "../reflections";
+import type { Reflection } from "../reflections";
+import { ReflectionSymbolId } from "../reflections/ReflectionSymbolId";
 import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
 export type CommentDisplayPart = {
     kind: "text";
@@ -9,13 +10,16 @@ export type CommentDisplayPart = {
 } | InlineTagDisplayPart;
 /**
  * The `@link`, `@linkcode`, and `@linkplain` tags may have a `target`
- * property set indicating which reflection/url they link to.
+ * property set indicating which reflection/url they link to. They may also
+ * have a `tsLinkText` property which includes the part of the `text` which
+ * TypeScript thinks should be displayed as the link text.
  */
 export interface InlineTagDisplayPart {
     kind: "inline-tag";
     tag: `@${string}`;
     text: string;
     target?: Reflection | string | ReflectionSymbolId;
+    tsLinkText?: string;
 }
 /**
  * A model that represents a single TypeDoc comment tag.
@@ -76,6 +80,7 @@ export declare class Comment {
         tag: `@${string}`;
         text: string;
         target?: string | Reflection | ReflectionSymbolId | undefined;
+        tsLinkText?: string | undefined;
     })[];
     static serializeDisplayParts(serializer: Serializer, parts: CommentDisplayPart[]): JSONOutput.CommentDisplayPart[];
     /** @hidden no point in showing this signature in api docs */
@@ -95,7 +100,6 @@ export declare class Comment {
     modifierTags: Set<string>;
     /**
      * Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)
-     * Added by the CommentPlugin during resolution.
      */
     label?: string;
     /**

package/dist/lib/models/comments/comment.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Comment = exports.CommentTag = void 0;
 const utils_1 = require("../../utils");
+const ReflectionSymbolId_1 = require("../reflections/ReflectionSymbolId");
 /**
  * A model that represents a single TypeDoc comment tag.
  *
@@ -162,19 +163,39 @@ class Comment {
                 case "code":
                     return { ...part };
                 case "inline-tag": {
-                    if (typeof part.target !== "number") {
-                        // TS isn't quite smart enough here...
-                        return { ...part };
-                    }
-                    else {
+                    if (typeof part.target === "number") {
                         const part2 = {
                             kind: part.kind,
                             tag: part.tag,
                             text: part.text,
+                            target: undefined,
+                            tsLinkText: part.tsLinkText,
                         };
                         links.push([part.target, part2]);
                         return part2;
                     }
+                    else if (typeof part.target === "string" ||
+                        part.target === undefined) {
+                        return {
+                            kind: "inline-tag",
+                            tag: part.tag,
+                            text: part.text,
+                            target: part.target,
+                            tsLinkText: part.tsLinkText,
+                        };
+                    }
+                    else if (typeof part.target === "object") {
+                        return {
+                            kind: "inline-tag",
+                            tag: part.tag,
+                            text: part.text,
+                            target: new ReflectionSymbolId_1.ReflectionSymbolId(part.target),
+                            tsLinkText: part.tsLinkText,
+                        };
+                    }
+                    else {
+                        (0, utils_1.assertNever)(part.target);
+                    }
                 }
             }
         });

package/dist/lib/models/reflections/declaration.d.ts

@@ -40,7 +40,7 @@ export declare enum ConversionFlags {
  * kind of a reflection is stored in its ´kind´ member.
  */
 export declare class DeclarationReflection extends ContainerReflection {
-    readonly variant: "reference" | "declaration";
+    readonly variant: "declaration" | "reference";
     /**
      * A list of all source files that contributed to this reflection.
      */

package/dist/lib/models/reflections/project.d.ts

@@ -52,12 +52,6 @@ export declare class ProjectReflection extends ContainerReflection {
      * @returns     An array containing all reflections with the desired kind.
      */
     getReflectionsByKind(kind: ReflectionKind): Reflection[];
-    /**
-     * Disassociate this project with all TypeScript created objects, allowing the underlying
-     * `ts.Program` to be garbage collected. This is very important for monorepo projects where
-     * we need to create multiple programs. See #1606 and surrounding discussion.
-     */
-    forgetTsReferences(): void;
     /**
      * Registers the given reflection so that it can be quickly looked up by helper methods.
      * Should be called for *every* reflection added to the project.

package/dist/lib/models/reflections/project.js

@@ -49,22 +49,6 @@ class ProjectReflection extends container_1.ContainerReflection {
     getReflectionsByKind(kind) {
         return Object.values(this.reflections).filter((reflection) => reflection.kindOf(kind));
     }
-    /**
-     * Disassociate this project with all TypeScript created objects, allowing the underlying
-     * `ts.Program` to be garbage collected. This is very important for monorepo projects where
-     * we need to create multiple programs. See #1606 and surrounding discussion.
-     */
-    forgetTsReferences() {
-        // Clear ts.Symbol references
-        this.reflectionIdToSymbolMap.clear();
-        // TODO: I think we need to do something like this.
-        // Update local references
-        this.symbolToReflectionIdMap.clear();
-        for (const [k, v] of this.reflectionIdToSymbolIdMap) {
-            v.pos = Infinity;
-            this.symbolToReflectionIdMap.set(v, k);
-        }
-    }
     /**
      * Registers the given reflection so that it can be quickly looked up by helper methods.
      * Should be called for *every* reflection added to the project.

package/dist/lib/models/types.js

@@ -24,11 +24,10 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnknownType = exports.UnionType = exports.TypeOperatorType = exports.NamedTupleMember = exports.TupleType = exports.TemplateLiteralType = exports.RestType = exports.ReflectionType = exports.ReferenceType = exports.QueryType = exports.PredicateType = exports.OptionalType = exports.MappedType = exports.LiteralType = exports.IntrinsicType = exports.IntersectionType = exports.InferredType = exports.IndexedAccessType = exports.ConditionalType = exports.ArrayType = exports.TypeContext = exports.makeRecursiveVisitor = exports.Type = void 0;
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
 const ts = __importStar(require("typescript"));
 const tsutils_1 = require("../utils/tsutils");
 const ReflectionSymbolId_1 = require("./reflections/ReflectionSymbolId");
+const fs_1 = require("../utils/fs");
 /**
  * Base class of all type definitions.
  */
@@ -740,7 +739,7 @@ class ReferenceType extends Type {
             return ref;
         }
         // Otherwise, look for a "package.json" file in a parent path
-        ref.package = findPackageForPath(symbolPath);
+        ref.package = (0, fs_1.findPackageForPath)(symbolPath);
         return ref;
     }
     /** @internal this is used for type parameters, which don't actually point to something */
@@ -1134,31 +1133,3 @@ class UnknownType extends Type {
     }
 }
 exports.UnknownType = UnknownType;
-const packageJsonLookupCache = {};
-function findPackageForPath(sourcePath) {
-    if (packageJsonLookupCache[sourcePath] !== undefined) {
-        return packageJsonLookupCache[sourcePath];
-    }
-    let basePath = sourcePath;
-    for (;;) {
-        const nextPath = path.dirname(basePath);
-        if (nextPath === basePath) {
-            return;
-        }
-        basePath = nextPath;
-        const projectPath = path.join(basePath, "package.json");
-        try {
-            const packageJsonData = fs.readFileSync(projectPath, {
-                encoding: "utf8",
-            });
-            const packageJson = JSON.parse(packageJsonData);
-            if (packageJson.name !== undefined) {
-                packageJsonLookupCache[sourcePath] = packageJson.name;
-            }
-            return packageJson.name;
-        }
-        catch (err) {
-            continue;
-        }
-    }
-}

package/dist/lib/output/components.d.ts

@@ -1,5 +1,5 @@
 import { Component, AbstractComponent } from "../utils/component";
-import { ProjectReflection, DeclarationReflection } from "../models/reflections/index";
+import type { ProjectReflection, Reflection } from "../models/reflections/index";
 import type { Renderer } from "./renderer";
 import { RendererEvent, PageEvent } from "./events";
 export { Component };
@@ -16,7 +16,7 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
     /**
      * The reflection that is currently processed.
      */
-    protected reflection?: DeclarationReflection;
+    protected page?: PageEvent<Reflection>;
     /**
      * The url of the document that is being currently generated.
      * Set when a page begins rendering.
@@ -50,5 +50,5 @@ export declare abstract class ContextAwareRendererComponent extends RendererComp
      *
      * @param page  An event object describing the current render operation.
      */
-    protected onBeginPage(page: PageEvent): void;
+    protected onBeginPage(page: PageEvent<Reflection>): void;
 }

package/dist/lib/output/components.js

@@ -27,7 +27,6 @@ exports.ContextAwareRendererComponent = exports.RendererComponent = exports.Comp
 const Path = __importStar(require("path"));
 const component_1 = require("../utils/component");
 Object.defineProperty(exports, "Component", { enumerable: true, get: function () { return component_1.Component; } });
-const index_1 = require("../models/reflections/index");
 const events_1 = require("./events");
 class RendererComponent extends component_1.AbstractComponent {
 }
@@ -84,10 +83,7 @@ class ContextAwareRendererComponent extends RendererComponent {
      */
     onBeginPage(page) {
         this.location = page.url;
-        this.reflection =
-            page.model instanceof index_1.DeclarationReflection
-                ? page.model
-                : undefined;
+        this.page = page;
     }
 }
 exports.ContextAwareRendererComponent = ContextAwareRendererComponent;

package/dist/lib/output/events.d.ts

@@ -1,7 +1,7 @@
 import { Event } from "../utils/events";
 import type { ProjectReflection } from "../models/reflections/project";
 import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
-import type { DeclarationReflection } from "../models";
+import type { DeclarationReflection, ReflectionKind } from "../models";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.
@@ -42,7 +42,7 @@ export declare class RendererEvent extends Event {
      * @param mapping  The mapping that defines the generated {@link PageEvent} state.
      * @returns A newly created {@link PageEvent} instance.
      */
-    createPageEvent<Model>(mapping: UrlMapping<Model>): PageEvent<Model>;
+    createPageEvent<Model>(mapping: UrlMapping<Model>): [RenderTemplate<PageEvent<Model>>, PageEvent<Model>];
 }
 /**
  * An event emitted by the {@link Renderer} class before and after the
@@ -51,7 +51,7 @@ export declare class RendererEvent extends Event {
  * @see {@link Renderer.EVENT_BEGIN_PAGE}
  * @see {@link Renderer.EVENT_END_PAGE}
  */
-export declare class PageEvent<Model = unknown> extends Event {
+export declare class PageEvent<out Model = unknown> extends Event {
     /**
      * The project the renderer is currently processing.
      */
@@ -67,17 +67,24 @@ export declare class PageEvent<Model = unknown> extends Event {
     /**
      * The model that should be rendered on this page.
      */
-    model: Model;
-    /**
-     * The template that should be used to render this page.
-     */
-    template: RenderTemplate<this>;
+    readonly model: Model;
     /**
      * The final html content of this page.
      *
      * Should be rendered by layout templates and can be modified by plugins.
      */
     contents?: string;
+    /**
+     * Links to content within this page that should be rendered in the page navigation.
+     * This is built when rendering the document content.
+     */
+    pageHeadings: Array<{
+        link: string;
+        text: string;
+        level?: number;
+        kind?: ReflectionKind;
+        classes?: string;
+    }>;
     /**
      * Triggered before a document will be rendered.
      * @event
@@ -88,11 +95,12 @@ export declare class PageEvent<Model = unknown> extends Event {
      * @event
      */
     static readonly END = "endPage";
+    constructor(name: string, model: Model);
 }
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
- * @see {@link PARSE}
+ * @see {@link MarkdownEvent.PARSE}
  */
 export declare class MarkdownEvent extends Event {
     /**
@@ -103,12 +111,16 @@ export declare class MarkdownEvent extends Event {
      * The parsed output.
      */
     parsedText: string;
+    /**
+     * The page that this markdown is being parsed for.
+     */
+    readonly page: PageEvent;
     /**
      * Triggered on the renderer when this plugin parses a markdown string.
      * @event
      */
     static readonly PARSE = "parseMarkdown";
-    constructor(name: string, originalText: string, parsedText: string);
+    constructor(name: string, page: PageEvent, originalText: string, parsedText: string);
 }
 /**
  * An event emitted when the search index is being prepared.

package/dist/lib/output/events.js

@@ -47,13 +47,11 @@ class RendererEvent extends events_1.Event {
      * @returns A newly created {@link PageEvent} instance.
      */
     createPageEvent(mapping) {
-        const event = new PageEvent(PageEvent.BEGIN);
+        const event = new PageEvent(PageEvent.BEGIN, mapping.model);
         event.project = this.project;
         event.url = mapping.url;
-        event.model = mapping.model;
-        event.template = mapping.template;
         event.filename = Path.join(this.outputDirectory, mapping.url);
-        return event;
+        return [mapping.template, event];
     }
 }
 /**
@@ -75,6 +73,15 @@ exports.RendererEvent = RendererEvent;
  * @see {@link Renderer.EVENT_END_PAGE}
  */
 class PageEvent extends events_1.Event {
+    constructor(name, model) {
+        super(name);
+        /**
+         * Links to content within this page that should be rendered in the page navigation.
+         * This is built when rendering the document content.
+         */
+        this.pageHeadings = [];
+        this.model = model;
+    }
 }
 /**
  * Triggered before a document will be rendered.
@@ -90,11 +97,12 @@ exports.PageEvent = PageEvent;
 /**
  * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  *
- * @see {@link PARSE}
+ * @see {@link MarkdownEvent.PARSE}
  */
 class MarkdownEvent extends events_1.Event {
-    constructor(name, originalText, parsedText) {
+    constructor(name, page, originalText, parsedText) {
         super(name);
+        this.page = page;
         this.originalText = originalText;
         this.parsedText = parsedText;
     }

package/dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -95,9 +95,7 @@ let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.Ren
                 kind: reflection.kind,
                 name: reflection.name,
                 url: reflection.url,
-                classes: this.owner.theme
-                    .getRenderContext()
-                    .getReflectionClasses(reflection),
+                classes: this.owner.theme.getReflectionClasses(reflection),
             };
             if (parent) {
                 row.parent = parent.getFullName();

package/dist/lib/output/renderer.d.ts

@@ -38,13 +38,21 @@ export interface RendererHooks {
      */
     "content.end": [DefaultThemeRenderContext];
     /**
-     * Applied immediately before calling `context.navigation`.
+     * Applied immediately before calling `context.sidebar`.
      */
-    "navigation.begin": [DefaultThemeRenderContext];
+    "sidebar.begin": [DefaultThemeRenderContext];
     /**
-     * Applied immediately after calling `context.navigation`.
+     * Applied immediately after calling `context.sidebar`.
      */
-    "navigation.end": [DefaultThemeRenderContext];
+    "sidebar.end": [DefaultThemeRenderContext];
+    /**
+     * Applied immediately before calling `context.pageSidebar`.
+     */
+    "pageSidebar.begin": [DefaultThemeRenderContext];
+    /**
+     * Applied immediately after calling `context.pageSidebar`.
+     */
+    "pageSidebar.end": [DefaultThemeRenderContext];
 }
 /**
  * The renderer processes a {@link ProjectReflection} using a {@link Theme} instance and writes

package/dist/lib/output/renderer.js

@@ -156,7 +156,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
             this.application.logger.verbose(`There are ${output.urls.length} pages to write.`);
             output.urls.forEach((mapping) => {
                 (0, icon_1.clearSeenIconCache)();
-                this.renderDocument(output.createPageEvent(mapping));
+                this.renderDocument(...output.createPageEvent(mapping));
                 (0, type_1.validateStateIsClean)(mapping.url);
             });
             await Promise.all(this.postRenderAsyncJobs.map((job) => job(output)));
@@ -172,7 +172,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
      * @param page An event describing the current page.
      * @return TRUE if the page has been saved to disc, otherwise FALSE.
      */
-    renderDocument(page) {
+    renderDocument(template, page) {
         const momento = this.hooks.saveMomento();
         this.trigger(events_1.PageEvent.BEGIN, page);
         if (page.isDefaultPrevented) {
@@ -180,7 +180,7 @@ let Renderer = class Renderer extends component_1.ChildableComponent {
             return false;
         }
         if (page.model instanceof models_1.Reflection) {
-            page.contents = this.theme.render(page);
+            page.contents = this.theme.render(page, template);
         }
         else {
             throw new Error("Should be unreachable");

package/dist/lib/output/theme.d.ts

@@ -1,6 +1,6 @@
 import type { Renderer } from "./renderer";
 import type { ProjectReflection } from "../models/reflections/project";
-import type { UrlMapping } from "./models/UrlMapping";
+import type { RenderTemplate, UrlMapping } from "./models/UrlMapping";
 import { RendererComponent } from "./components";
 import type { PageEvent } from "./events";
 import type { Reflection } from "../models";
@@ -39,5 +39,5 @@ export declare abstract class Theme extends RendererComponent {
     /**
      * Renders the provided page to a string, which will be written to disk by the {@link Renderer}
      */
-    abstract render(page: PageEvent<Reflection>): string;
+    abstract render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string;
 }

package/dist/lib/output/themes/MarkedPlugin.d.ts

@@ -1,5 +1,5 @@
 import { ContextAwareRendererComponent } from "../components";
-import { RendererEvent, MarkdownEvent } from "../events";
+import { RendererEvent, MarkdownEvent, PageEvent } from "../events";
 import type { Theme } from "shiki";
 /**
  * Implements markdown and relativeURL helpers for templates.
@@ -46,7 +46,7 @@ export declare class MarkedPlugin extends ContextAwareRendererComponent {
      * @param text  The markdown string that should be parsed.
      * @returns The resulting html string.
      */
-    parseMarkdown(text: string): string;
+    parseMarkdown(text: string, page: PageEvent<any>): string;
     /**
      * Triggered before the renderer starts rendering a project.
      *

package/dist/lib/output/themes/MarkedPlugin.js

@@ -37,15 +37,6 @@ const components_1 = require("../components");
 const events_1 = require("../events");
 const utils_1 = require("../../utils");
 const highlighter_1 = require("../../utils/highlighter");
-const customMarkedRenderer = new Marked.Renderer();
-customMarkedRenderer.heading = (text, level, _, slugger) => {
-    const slug = slugger.slug(text);
-    return `
-<a href="#${slug}" id="${slug}" style="color: inherit; text-decoration: none;">
-  <h${level}>${text}</h${level}>
-</a>
-`;
-};
 /**
  * Implements markdown and relativeURL helpers for templates.
  * @internal
@@ -98,7 +89,7 @@ output file :
      * @param text  The markdown string that should be parsed.
      * @returns The resulting html string.
      */
-    parseMarkdown(text) {
+    parseMarkdown(text, page) {
         if (this.includes) {
             text = text.replace(this.includePattern, (_match, path) => {
                 path = Path.join(this.includes, path.trim());
@@ -124,7 +115,7 @@ output file :
                 }
             });
         }
-        const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.PARSE, text, text);
+        const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.PARSE, page, text, text);
         this.owner.trigger(event);
         return event.parsedText;
     }
@@ -169,7 +160,19 @@ output file :
         const markedOptions = (this.application.options.getValue("markedOptions") ?? {});
         // Set some default values if they are not specified via the TypeDoc option
         markedOptions.highlight ?? (markedOptions.highlight = (text, lang) => this.getHighlighted(text, lang));
-        markedOptions.renderer ?? (markedOptions.renderer = customMarkedRenderer);
+        if (!markedOptions.renderer) {
+            markedOptions.renderer = new Marked.Renderer();
+            markedOptions.renderer.heading = (text, level, _, slugger) => {
+                const slug = slugger.slug(text);
+                // Prefix the slug with an extra `$` to prevent conflicts with TypeDoc's anchors.
+                this.page.pageHeadings.push({
+                    link: `#$${slug}`,
+                    text,
+                    level,
+                });
+                return `<a id="$${slug}" class="tsd-anchor"></a><h${level}><a href="#$${slug}" style="color:inherit;text-decoration:none">${text}</a></h${level}>`;
+            };
+        }
         markedOptions.mangle ?? (markedOptions.mangle = false); // See https://github.com/TypeStrong/typedoc/issues/1395
         return markedOptions;
     }

package/dist/lib/output/themes/default/DefaultTheme.d.ts

@@ -1,7 +1,7 @@
 import { Theme } from "../../theme";
 import type { Renderer } from "../../renderer";
 import { Reflection, ProjectReflection, ContainerReflection, DeclarationReflection } from "../../../models";
-import { UrlMapping } from "../../models/UrlMapping";
+import { RenderTemplate, UrlMapping } from "../../models/UrlMapping";
 import type { PageEvent } from "../../events";
 import type { MarkedPlugin } from "../../plugins";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext";
@@ -13,11 +13,11 @@ import { JSX } from "../../../utils";
 export declare class DefaultTheme extends Theme {
     /** @internal */
     markedPlugin: MarkedPlugin;
-    private _renderContext?;
-    getRenderContext(): DefaultThemeRenderContext;
+    getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
     reflectionTemplate: (pageEvent: PageEvent<ContainerReflection>) => JSX.Element;
     indexTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
-    defaultLayoutTemplate: (pageEvent: PageEvent<Reflection>) => JSX.Element;
+    defaultLayoutTemplate: (pageEvent: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>) => JSX.Element;
+    getReflectionClasses(reflection: DeclarationReflection): string;
     /**
      * Mappings of reflections kinds to templates used by this theme.
      */
@@ -62,7 +62,7 @@ export declare class DefaultTheme extends Theme {
      * @returns           The altered urls array.
      */
     buildUrls(reflection: DeclarationReflection, urls: UrlMapping[]): UrlMapping[];
-    render(page: PageEvent<Reflection>): string;
+    render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string;
     /**
      * Generate an anchor url for the given reflection and all of its children.
      *

package/dist/lib/output/themes/default/DefaultTheme.js

@@ -11,11 +11,12 @@ const utils_1 = require("../../../utils");
  * {@link Theme} implementation, this theme class will be used.
  */
 class DefaultTheme extends theme_1.Theme {
-    getRenderContext() {
-        if (!this._renderContext) {
-            this._renderContext = new DefaultThemeRenderContext_1.DefaultThemeRenderContext(this, this.application.options);
-        }
-        return this._renderContext;
+    getRenderContext(pageEvent) {
+        return new DefaultThemeRenderContext_1.DefaultThemeRenderContext(this, pageEvent, this.application.options);
+    }
+    getReflectionClasses(reflection) {
+        const filters = this.application.options.getValue("visibilityFilters");
+        return getReflectionClasses(reflection, filters);
     }
     /**
      * Create a new DefaultTheme instance.
@@ -26,13 +27,13 @@ class DefaultTheme extends theme_1.Theme {
     constructor(renderer) {
         super(renderer);
         this.reflectionTemplate = (pageEvent) => {
-            return this.getRenderContext().reflectionTemplate(pageEvent);
+            return this.getRenderContext(pageEvent).reflectionTemplate(pageEvent);
         };
         this.indexTemplate = (pageEvent) => {
-            return this.getRenderContext().indexTemplate(pageEvent);
+            return this.getRenderContext(pageEvent).indexTemplate(pageEvent);
         };
-        this.defaultLayoutTemplate = (pageEvent) => {
-            return this.getRenderContext().defaultLayout(pageEvent);
+        this.defaultLayoutTemplate = (pageEvent, template) => {
+            return this.getRenderContext(pageEvent).defaultLayout(template, pageEvent);
         };
         /**
          * Mappings of reflections kinds to templates used by this theme.
@@ -162,8 +163,8 @@ class DefaultTheme extends theme_1.Theme {
         }
         return urls;
     }
-    render(page) {
-        const templateOutput = this.defaultLayoutTemplate(page);
+    render(page, template) {
+        const templateOutput = this.defaultLayoutTemplate(page, template);
         return "<!DOCTYPE html>" + utils_1.JSX.renderElement(templateOutput);
     }
     /**
@@ -193,3 +194,49 @@ exports.DefaultTheme = DefaultTheme;
 function hasReadme(readme) {
     return !readme.endsWith("none");
 }
+function toStyleClass(str) {
+    return str.replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2).toLowerCase();
+}
+function getReflectionClasses(reflection, filters) {
+    const classes = [];
+    classes.push(toStyleClass("tsd-kind-" + models_1.ReflectionKind[reflection.kind]));
+    if (reflection.parent && reflection.parent instanceof models_1.DeclarationReflection) {
+        classes.push(toStyleClass(`tsd-parent-kind-${models_1.ReflectionKind[reflection.parent.kind]}`));
+    }
+    // Filter classes should match up with the settings function in
+    // partials/navigation.tsx.
+    for (const key of Object.keys(filters)) {
+        if (key === "inherited") {
+            if (reflection.inheritedFrom) {
+                classes.push("tsd-is-inherited");
+            }
+        }
+        else if (key === "protected") {
+            if (reflection.flags.isProtected) {
+                classes.push("tsd-is-protected");
+            }
+        }
+        else if (key === "private") {
+            if (reflection.flags.isPrivate) {
+                classes.push("tsd-is-private");
+            }
+        }
+        else if (key === "external") {
+            if (reflection.flags.isExternal) {
+                classes.push("tsd-is-external");
+            }
+        }
+        else if (key.startsWith("@")) {
+            if (key === "@deprecated") {
+                if (reflection.isDeprecated()) {
+                    classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+                }
+            }
+            else if (reflection.comment?.hasModifier(key) ||
+                reflection.comment?.getTag(key)) {
+                classes.push(toStyleClass(`tsd-is-${key.substring(1)}`));
+            }
+        }
+    }
+    return classes.join(" ");
+}