1 | import { Theme } from "../../theme";
|
2 | import type { Renderer } from "../../renderer";
|
3 | import { ReflectionKind, ProjectReflection, type ContainerReflection, DeclarationReflection, type Reflection, type DocumentReflection } from "../../../models";
|
4 | import { type RenderTemplate, UrlMapping } from "../../models/UrlMapping";
|
5 | import type { PageEvent } from "../../events";
|
6 | import type { MarkedPlugin } from "../../plugins";
|
7 | import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext";
|
8 | import { JSX } from "../../../utils";
|
9 | export interface NavigationElement {
|
10 | text: string;
|
11 | path?: string;
|
12 | kind?: ReflectionKind;
|
13 | class?: string;
|
14 | children?: NavigationElement[];
|
15 | }
|
16 |
|
17 |
|
18 |
|
19 | export declare class Slugger {
|
20 | private seen;
|
21 | private serialize;
|
22 | slug(value: string): string;
|
23 | }
|
24 |
|
25 |
|
26 |
|
27 |
|
28 | export declare class DefaultTheme extends Theme {
|
29 |
|
30 | markedPlugin: MarkedPlugin;
|
31 | |
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | icons: {
|
45 | search: () => JSX.Element;
|
46 | anchor: () => JSX.Element;
|
47 | 1: () => JSX.Element;
|
48 | 2: () => JSX.Element;
|
49 | 4: () => JSX.Element;
|
50 | 8: () => JSX.Element;
|
51 | 16: () => JSX.Element;
|
52 | 32: () => JSX.Element;
|
53 | 64: () => JSX.Element;
|
54 | 128: () => JSX.Element;
|
55 | 256: () => JSX.Element;
|
56 | 512: () => JSX.Element;
|
57 | 1024: () => JSX.Element;
|
58 | 2048: () => JSX.Element;
|
59 | 4096: () => JSX.Element;
|
60 | 8192: () => JSX.Element;
|
61 | 16384: () => JSX.Element;
|
62 | 32768: () => JSX.Element;
|
63 | 65536: () => JSX.Element;
|
64 | 131072: () => JSX.Element;
|
65 | 262144: () => JSX.Element;
|
66 | 524288: () => JSX.Element;
|
67 | 1048576: () => JSX.Element;
|
68 | 2097152: () => JSX.Element;
|
69 | 4194304: () => JSX.Element;
|
70 | 8388608: () => JSX.Element;
|
71 | checkbox: () => JSX.Element;
|
72 | chevronDown: () => JSX.Element;
|
73 | menu: () => JSX.Element;
|
74 | chevronSmall: () => JSX.Element;
|
75 | folder: () => JSX.Element;
|
76 | };
|
77 | getRenderContext(pageEvent: PageEvent<Reflection>): DefaultThemeRenderContext;
|
78 | documentTemplate: (pageEvent: PageEvent<DocumentReflection>) => JSX.Element;
|
79 | reflectionTemplate: (pageEvent: PageEvent<ContainerReflection>) => JSX.Element;
|
80 | indexTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
|
81 | hierarchyTemplate: (pageEvent: PageEvent<ProjectReflection>) => JSX.Element;
|
82 | defaultLayoutTemplate: (pageEvent: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>) => JSX.Element;
|
83 | getReflectionClasses(reflection: DeclarationReflection | DocumentReflection): string;
|
84 | |
85 |
|
86 |
|
87 | private mappings;
|
88 | static URL_PREFIX: RegExp;
|
89 | |
90 |
|
91 |
|
92 |
|
93 |
|
94 | constructor(renderer: Renderer);
|
95 | /**
|
96 | * Map the models of the given project to the desired output files.
|
97 | *
|
98 | * @param project The project whose urls should be generated.
|
99 | * @returns A list of {@link UrlMapping} instances defining which models
|
100 | * should be rendered to which files.
|
101 | */
|
102 | getUrls(project: ProjectReflection): UrlMapping[];
|
103 | |
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 | static getUrl(reflection: Reflection, relative?: Reflection, separator?: string): string;
|
112 | |
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 | private getMapping;
|
119 | |
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 | buildUrls(reflection: DeclarationReflection | DocumentReflection, urls: UrlMapping[]): UrlMapping[];
|
127 | render(page: PageEvent<Reflection>, template: RenderTemplate<PageEvent<Reflection>>): string;
|
128 | private _navigationCache;
|
129 | |
130 |
|
131 |
|
132 | getNavigation(project: ProjectReflection): NavigationElement[];
|
133 | buildNavigation(project: ProjectReflection): NavigationElement[];
|
134 | private sluggers;
|
135 | getSlugger(reflection: Reflection): Slugger;
|
136 | |
137 |
|
138 |
|
139 |
|
140 |
|
141 |
|
142 | static applyAnchorUrl(reflection: Reflection, container: Reflection): void;
|
143 | }
|