-
Notifications
You must be signed in to change notification settings - Fork 692
/
DefaultThemeRenderContext.ts
135 lines (123 loc) · 4.82 KB
/
DefaultThemeRenderContext.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
import type { PageEvent, RendererHooks } from "../..";
import {
Comment,
CommentDisplayPart,
DeclarationReflection,
ReferenceType,
Reflection,
} from "../../../models";
import type { NeverIfInternal, Options } from "../../../utils";
import type { DefaultTheme } from "./DefaultTheme";
import { defaultLayout } from "./layouts/default";
import { index } from "./partials";
import { analytics } from "./partials/analytics";
import { breadcrumb } from "./partials/breadcrumb";
import { comment } from "./partials/comment";
import { footer } from "./partials/footer";
import { header } from "./partials/header";
import { hierarchy } from "./partials/hierarchy";
import { icons } from "./partials/icon";
import { member } from "./partials/member";
import { memberDeclaration } from "./partials/member.declaration";
import { memberGetterSetter } from "./partials/member.getterSetter";
import { memberReference } from "./partials/member.reference";
import { memberSignatureBody } from "./partials/member.signature.body";
import { memberSignatureTitle } from "./partials/member.signature.title";
import { memberSignatures } from "./partials/member.signatures";
import { memberSources } from "./partials/member.sources";
import { members } from "./partials/members";
import { membersGroup } from "./partials/members.group";
import {
sidebar,
pageSidebar,
navigation,
pageNavigation,
settings,
sidebarLinks,
} from "./partials/navigation";
import { parameter } from "./partials/parameter";
import { toolbar } from "./partials/toolbar";
import { type } from "./partials/type";
import { typeAndParent } from "./partials/typeAndParent";
import { typeParameters } from "./partials/typeParameters";
import { indexTemplate } from "./templates";
import { reflectionTemplate } from "./templates/reflection";
function bind<F, L extends any[], R>(fn: (f: F, ...a: L) => R, first: F) {
return (...r: L) => fn(first, ...r);
}
export class DefaultThemeRenderContext {
options: Options;
constructor(
private theme: DefaultTheme,
public page: PageEvent<Reflection>,
options: Options
) {
this.options = options;
}
icons = icons;
hook = (name: keyof RendererHooks) =>
this.theme.owner.hooks.emit(name, this);
/** Avoid this in favor of urlTo if possible */
relativeURL = (url: string, cacheBust = false) => {
const result = this.theme.markedPlugin.getRelativeUrl(url);
if (cacheBust && this.theme.owner.cacheBust) {
return result + `?cache=${this.theme.owner.renderStartTime}`;
}
return result;
};
urlTo = (reflection: Reflection) => {
return reflection.url ? this.relativeURL(reflection.url) : "";
};
markdown = (
md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>
) => {
if (md instanceof Array) {
return this.theme.markedPlugin.parseMarkdown(
Comment.displayPartsToMarkdown(md, this.urlTo),
this.page
);
}
return md ? this.theme.markedPlugin.parseMarkdown(md, this.page) : "";
};
/**
* Using this method will repeat work already done, instead of calling it, use `type.externalUrl`.
* @deprecated
* Will be removed in 0.24.
*/
attemptExternalResolution = (type: NeverIfInternal<ReferenceType>) => {
return (type as ReferenceType).externalUrl;
};
getReflectionClasses = (refl: DeclarationReflection) =>
this.theme.getReflectionClasses(refl);
reflectionTemplate = bind(reflectionTemplate, this);
indexTemplate = bind(indexTemplate, this);
defaultLayout = bind(defaultLayout, this);
analytics = bind(analytics, this);
breadcrumb = bind(breadcrumb, this);
comment = bind(comment, this);
footer = bind(footer, this);
header = bind(header, this);
hierarchy = bind(hierarchy, this);
index = bind(index, this);
member = bind(member, this);
memberDeclaration = bind(memberDeclaration, this);
memberGetterSetter = bind(memberGetterSetter, this);
memberReference = bind(memberReference, this);
memberSignatureBody = bind(memberSignatureBody, this);
memberSignatureTitle = bind(memberSignatureTitle, this);
memberSignatures = bind(memberSignatures, this);
memberSources = bind(memberSources, this);
members = bind(members, this);
membersGroup = bind(membersGroup, this);
sidebar = bind(sidebar, this);
pageSidebar = bind(pageSidebar, this);
sidebarLinks = bind(sidebarLinks, this);
settings = bind(settings, this);
navigation = bind(navigation, this);
pageNavigation = bind(pageNavigation, this);
parameter = bind(parameter, this);
toolbar = bind(toolbar, this);
type = bind(type, this);
typeAndParent = bind(typeAndParent, this);
typeParameters = bind(typeParameters, this);
}