typedoc 0.28.0-beta.0 → 0.28.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (460) hide show
  1. package/dist/index.d.ts +2 -2
  2. package/dist/index.js +1 -1
  3. package/dist/lib/application.d.ts +1 -1
  4. package/dist/lib/application.js +6 -0
  5. package/dist/lib/converter/context.d.ts +16 -6
  6. package/dist/lib/converter/context.js +40 -5
  7. package/dist/lib/converter/factories/index-signature.js +3 -2
  8. package/dist/lib/converter/factories/signature.js +1 -1
  9. package/dist/lib/converter/factories/symbol-id.js +1 -0
  10. package/dist/lib/converter/jsdoc.js +2 -1
  11. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +1 -1
  12. package/dist/lib/converter/plugins/PackagePlugin.js +18 -8
  13. package/dist/lib/converter/plugins/SourcePlugin.js +1 -1
  14. package/dist/lib/converter/symbols.js +59 -6
  15. package/dist/lib/converter/types.js +16 -21
  16. package/dist/lib/internationalization/locales/en.cjs +2 -0
  17. package/dist/lib/internationalization/locales/en.d.cts +2 -0
  18. package/dist/lib/internationalization/locales/zh.cjs +8 -3
  19. package/dist/lib/internationalization/locales/zh.d.cts +6 -1
  20. package/dist/lib/models/ContainerReflection.d.ts +2 -2
  21. package/dist/lib/models/ContainerReflection.js +28 -4
  22. package/dist/lib/models/ProjectReflection.d.ts +1 -1
  23. package/dist/lib/models/ProjectReflection.js +1 -1
  24. package/dist/lib/models/ReflectionSymbolId.d.ts +10 -0
  25. package/dist/lib/models/ReflectionSymbolId.js +10 -0
  26. package/dist/lib/output/formatter.d.ts +1 -0
  27. package/dist/lib/output/formatter.js +3 -0
  28. package/dist/lib/output/index.d.ts +1 -3
  29. package/dist/lib/output/index.js +0 -1
  30. package/dist/lib/output/plugins/JavascriptIndexPlugin.js +4 -0
  31. package/dist/lib/output/renderer.d.ts +0 -5
  32. package/dist/lib/output/renderer.js +3 -40
  33. package/dist/lib/output/router.js +6 -0
  34. package/dist/lib/output/theme.d.ts +9 -1
  35. package/dist/lib/output/theme.js +8 -0
  36. package/dist/lib/output/themes/MarkedPlugin.js +3 -3
  37. package/dist/lib/output/themes/default/DefaultTheme.d.ts +16 -6
  38. package/dist/lib/output/themes/default/DefaultTheme.js +275 -209
  39. package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +47 -40
  40. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +11 -12
  41. package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +1 -2
  42. package/dist/lib/output/themes/default/partials/anchor-icon.js +2 -9
  43. package/dist/lib/output/themes/default/partials/breadcrumb.js +2 -2
  44. package/dist/lib/output/themes/default/partials/comment.js +2 -3
  45. package/dist/lib/output/themes/default/partials/index.js +4 -6
  46. package/dist/lib/output/themes/default/partials/member.declaration.js +1 -1
  47. package/dist/lib/output/themes/default/partials/member.js +3 -5
  48. package/dist/lib/output/themes/default/partials/member.signature.body.js +2 -2
  49. package/dist/lib/output/themes/default/partials/member.signatures.js +2 -3
  50. package/dist/lib/output/themes/default/partials/members.js +2 -4
  51. package/dist/lib/output/themes/default/partials/moduleReflection.js +6 -10
  52. package/dist/lib/output/themes/default/partials/navigation.js +5 -7
  53. package/dist/lib/output/themes/default/partials/reflectionPreview.js +8 -0
  54. package/dist/lib/output/themes/default/partials/typeDetails.d.ts +5 -5
  55. package/dist/lib/output/themes/default/partials/typeDetails.js +99 -53
  56. package/dist/lib/output/themes/default/partials/typeParameters.js +10 -5
  57. package/dist/lib/output/themes/default/templates/hierarchy.js +3 -5
  58. package/dist/lib/output/themes/default/templates/reflection.js +7 -3
  59. package/dist/lib/output/themes/lib.js +8 -4
  60. package/dist/lib/utils/fs.d.ts +0 -4
  61. package/dist/lib/utils/fs.js +0 -21
  62. package/dist/lib/utils/highlighter.d.ts +1 -0
  63. package/dist/lib/utils/highlighter.js +16 -2
  64. package/dist/lib/utils/index.d.ts +1 -0
  65. package/dist/lib/utils/index.js +1 -0
  66. package/dist/lib/utils/options/declaration.d.ts +13 -1
  67. package/dist/lib/utils/options/declaration.js +68 -0
  68. package/dist/lib/utils/options/defaults.js +2 -0
  69. package/dist/lib/utils/options/index.d.ts +1 -1
  70. package/dist/lib/utils/options/sources/typedoc.js +1 -1
  71. package/dist/lib/utils/options/tsdoc-defaults.d.ts +2 -2
  72. package/dist/lib/utils/options/tsdoc-defaults.js +5 -0
  73. package/dist/lib/utils-common/jsx.elements.d.ts +16 -0
  74. package/dist/lib/utils-common/path.js +4 -1
  75. package/package.json +1 -1
  76. package/static/main.js +4 -4
  77. package/static/style.css +48 -36
  78. package/tsdoc.json +20 -0
  79. package/dist/browser-utils.d.ts.map +0 -1
  80. package/dist/browser-utils.js.map +0 -1
  81. package/dist/generated/en.d.ts +0 -2
  82. package/dist/generated/en.js +0 -62
  83. package/dist/generated/ja.d.ts +0 -2
  84. package/dist/generated/ja.js +0 -62
  85. package/dist/generated/ko.d.ts +0 -2
  86. package/dist/generated/ko.js +0 -62
  87. package/dist/generated/zh.d.ts +0 -2
  88. package/dist/generated/zh.js +0 -62
  89. package/dist/index.d.ts.map +0 -1
  90. package/dist/index.js.map +0 -1
  91. package/dist/lib/application-events.d.ts.map +0 -1
  92. package/dist/lib/application-events.js.map +0 -1
  93. package/dist/lib/application.d.ts.map +0 -1
  94. package/dist/lib/application.js.map +0 -1
  95. package/dist/lib/cli.d.ts.map +0 -1
  96. package/dist/lib/cli.js.map +0 -1
  97. package/dist/lib/converter/comments/blockLexer.d.ts.map +0 -1
  98. package/dist/lib/converter/comments/blockLexer.js.map +0 -1
  99. package/dist/lib/converter/comments/declarationReferenceResolver.d.ts.map +0 -1
  100. package/dist/lib/converter/comments/declarationReferenceResolver.js.map +0 -1
  101. package/dist/lib/converter/comments/discovery.d.ts.map +0 -1
  102. package/dist/lib/converter/comments/discovery.js.map +0 -1
  103. package/dist/lib/converter/comments/index.d.ts.map +0 -1
  104. package/dist/lib/converter/comments/index.js.map +0 -1
  105. package/dist/lib/converter/comments/lexer.d.ts.map +0 -1
  106. package/dist/lib/converter/comments/lexer.js.map +0 -1
  107. package/dist/lib/converter/comments/lineLexer.d.ts.map +0 -1
  108. package/dist/lib/converter/comments/lineLexer.js.map +0 -1
  109. package/dist/lib/converter/comments/linkResolver.d.ts.map +0 -1
  110. package/dist/lib/converter/comments/linkResolver.js.map +0 -1
  111. package/dist/lib/converter/comments/parser.d.ts.map +0 -1
  112. package/dist/lib/converter/comments/parser.js.map +0 -1
  113. package/dist/lib/converter/comments/rawLexer.d.ts.map +0 -1
  114. package/dist/lib/converter/comments/rawLexer.js.map +0 -1
  115. package/dist/lib/converter/comments/tagName.d.ts.map +0 -1
  116. package/dist/lib/converter/comments/tagName.js.map +0 -1
  117. package/dist/lib/converter/comments/textParser.d.ts.map +0 -1
  118. package/dist/lib/converter/comments/textParser.js.map +0 -1
  119. package/dist/lib/converter/components.d.ts.map +0 -1
  120. package/dist/lib/converter/components.js.map +0 -1
  121. package/dist/lib/converter/context.d.ts.map +0 -1
  122. package/dist/lib/converter/context.js.map +0 -1
  123. package/dist/lib/converter/convert-expression.d.ts.map +0 -1
  124. package/dist/lib/converter/convert-expression.js.map +0 -1
  125. package/dist/lib/converter/converter-events.d.ts.map +0 -1
  126. package/dist/lib/converter/converter-events.js.map +0 -1
  127. package/dist/lib/converter/converter.d.ts.map +0 -1
  128. package/dist/lib/converter/converter.js.map +0 -1
  129. package/dist/lib/converter/factories/index-signature.d.ts.map +0 -1
  130. package/dist/lib/converter/factories/index-signature.js.map +0 -1
  131. package/dist/lib/converter/factories/signature.d.ts.map +0 -1
  132. package/dist/lib/converter/factories/signature.js.map +0 -1
  133. package/dist/lib/converter/factories/symbol-id.d.ts.map +0 -1
  134. package/dist/lib/converter/factories/symbol-id.js.map +0 -1
  135. package/dist/lib/converter/factories/types.d.ts +0 -4
  136. package/dist/lib/converter/factories/types.d.ts.map +0 -1
  137. package/dist/lib/converter/factories/types.js +0 -13
  138. package/dist/lib/converter/factories/types.js.map +0 -1
  139. package/dist/lib/converter/index.d.ts.map +0 -1
  140. package/dist/lib/converter/index.js.map +0 -1
  141. package/dist/lib/converter/jsdoc.d.ts.map +0 -1
  142. package/dist/lib/converter/jsdoc.js.map +0 -1
  143. package/dist/lib/converter/plugins/CategoryPlugin.d.ts.map +0 -1
  144. package/dist/lib/converter/plugins/CategoryPlugin.js.map +0 -1
  145. package/dist/lib/converter/plugins/CommentPlugin.d.ts.map +0 -1
  146. package/dist/lib/converter/plugins/CommentPlugin.js.map +0 -1
  147. package/dist/lib/converter/plugins/GroupPlugin.d.ts.map +0 -1
  148. package/dist/lib/converter/plugins/GroupPlugin.js.map +0 -1
  149. package/dist/lib/converter/plugins/ImplementsPlugin.d.ts.map +0 -1
  150. package/dist/lib/converter/plugins/ImplementsPlugin.js.map +0 -1
  151. package/dist/lib/converter/plugins/IncludePlugin.d.ts.map +0 -1
  152. package/dist/lib/converter/plugins/IncludePlugin.js.map +0 -1
  153. package/dist/lib/converter/plugins/InheritDocPlugin.d.ts.map +0 -1
  154. package/dist/lib/converter/plugins/InheritDocPlugin.js.map +0 -1
  155. package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts.map +0 -1
  156. package/dist/lib/converter/plugins/LinkResolverPlugin.js.map +0 -1
  157. package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts.map +0 -1
  158. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js.map +0 -1
  159. package/dist/lib/converter/plugins/PackagePlugin.d.ts.map +0 -1
  160. package/dist/lib/converter/plugins/PackagePlugin.js.map +0 -1
  161. package/dist/lib/converter/plugins/SourcePlugin.d.ts.map +0 -1
  162. package/dist/lib/converter/plugins/SourcePlugin.js.map +0 -1
  163. package/dist/lib/converter/plugins/TypePlugin.d.ts.map +0 -1
  164. package/dist/lib/converter/plugins/TypePlugin.js.map +0 -1
  165. package/dist/lib/converter/plugins/index.d.ts.map +0 -1
  166. package/dist/lib/converter/plugins/index.js.map +0 -1
  167. package/dist/lib/converter/symbols.d.ts.map +0 -1
  168. package/dist/lib/converter/symbols.js.map +0 -1
  169. package/dist/lib/converter/types.d.ts.map +0 -1
  170. package/dist/lib/converter/types.js.map +0 -1
  171. package/dist/lib/converter/utils/nodes.d.ts.map +0 -1
  172. package/dist/lib/converter/utils/nodes.js.map +0 -1
  173. package/dist/lib/converter/utils/reflections.d.ts.map +0 -1
  174. package/dist/lib/converter/utils/reflections.js.map +0 -1
  175. package/dist/lib/converter/utils/repository.d.ts.map +0 -1
  176. package/dist/lib/converter/utils/repository.js.map +0 -1
  177. package/dist/lib/converter/utils/symbols.d.ts.map +0 -1
  178. package/dist/lib/converter/utils/symbols.js.map +0 -1
  179. package/dist/lib/debug/index.d.ts.map +0 -1
  180. package/dist/lib/debug/index.js.map +0 -1
  181. package/dist/lib/debug/reflectionLifetimes.d.ts.map +0 -1
  182. package/dist/lib/debug/reflectionLifetimes.js.map +0 -1
  183. package/dist/lib/debug/rendererUrls.d.ts.map +0 -1
  184. package/dist/lib/debug/rendererUrls.js.map +0 -1
  185. package/dist/lib/internationalization/index.d.ts.map +0 -1
  186. package/dist/lib/internationalization/index.js.map +0 -1
  187. package/dist/lib/internationalization/internationalization.d.ts.map +0 -1
  188. package/dist/lib/internationalization/internationalization.js.map +0 -1
  189. package/dist/lib/internationalization/locale-utils.cjs.map +0 -1
  190. package/dist/lib/internationalization/locale-utils.d.cts.map +0 -1
  191. package/dist/lib/internationalization/locales/en.cjs.map +0 -1
  192. package/dist/lib/internationalization/locales/en.d.cts.map +0 -1
  193. package/dist/lib/internationalization/locales/ja.cjs.map +0 -1
  194. package/dist/lib/internationalization/locales/ja.d.cts.map +0 -1
  195. package/dist/lib/internationalization/locales/ko.cjs.map +0 -1
  196. package/dist/lib/internationalization/locales/ko.d.cts.map +0 -1
  197. package/dist/lib/internationalization/locales/zh.cjs.map +0 -1
  198. package/dist/lib/internationalization/locales/zh.d.cts.map +0 -1
  199. package/dist/lib/internationalization/translatable.d.ts.map +0 -1
  200. package/dist/lib/internationalization/translatable.js.map +0 -1
  201. package/dist/lib/models/Comment.d.ts.map +0 -1
  202. package/dist/lib/models/Comment.js.map +0 -1
  203. package/dist/lib/models/ContainerReflection.d.ts.map +0 -1
  204. package/dist/lib/models/ContainerReflection.js.map +0 -1
  205. package/dist/lib/models/DeclarationReflection.d.ts.map +0 -1
  206. package/dist/lib/models/DeclarationReflection.js.map +0 -1
  207. package/dist/lib/models/DocumentReflection.d.ts.map +0 -1
  208. package/dist/lib/models/DocumentReflection.js.map +0 -1
  209. package/dist/lib/models/FileRegistry.d.ts.map +0 -1
  210. package/dist/lib/models/FileRegistry.js.map +0 -1
  211. package/dist/lib/models/ParameterReflection.d.ts.map +0 -1
  212. package/dist/lib/models/ParameterReflection.js.map +0 -1
  213. package/dist/lib/models/ProjectReflection.d.ts.map +0 -1
  214. package/dist/lib/models/ProjectReflection.js.map +0 -1
  215. package/dist/lib/models/ReferenceReflection.d.ts.map +0 -1
  216. package/dist/lib/models/ReferenceReflection.js.map +0 -1
  217. package/dist/lib/models/Reflection.d.ts.map +0 -1
  218. package/dist/lib/models/Reflection.js.map +0 -1
  219. package/dist/lib/models/ReflectionCategory.d.ts.map +0 -1
  220. package/dist/lib/models/ReflectionCategory.js.map +0 -1
  221. package/dist/lib/models/ReflectionGroup.d.ts.map +0 -1
  222. package/dist/lib/models/ReflectionGroup.js.map +0 -1
  223. package/dist/lib/models/ReflectionSymbolId.d.ts.map +0 -1
  224. package/dist/lib/models/ReflectionSymbolId.js.map +0 -1
  225. package/dist/lib/models/SignatureReflection.d.ts.map +0 -1
  226. package/dist/lib/models/SignatureReflection.js.map +0 -1
  227. package/dist/lib/models/SourceReference.d.ts.map +0 -1
  228. package/dist/lib/models/SourceReference.js.map +0 -1
  229. package/dist/lib/models/TypeParameterReflection.d.ts.map +0 -1
  230. package/dist/lib/models/TypeParameterReflection.js.map +0 -1
  231. package/dist/lib/models/index.d.ts.map +0 -1
  232. package/dist/lib/models/index.js.map +0 -1
  233. package/dist/lib/models/kind.d.ts.map +0 -1
  234. package/dist/lib/models/kind.js.map +0 -1
  235. package/dist/lib/models/types.d.ts.map +0 -1
  236. package/dist/lib/models/types.js.map +0 -1
  237. package/dist/lib/models/utils.d.ts.map +0 -1
  238. package/dist/lib/models/utils.js.map +0 -1
  239. package/dist/lib/models/variant.d.ts.map +0 -1
  240. package/dist/lib/models/variant.js.map +0 -1
  241. package/dist/lib/output/components.d.ts.map +0 -1
  242. package/dist/lib/output/components.js.map +0 -1
  243. package/dist/lib/output/events.d.ts.map +0 -1
  244. package/dist/lib/output/events.js.map +0 -1
  245. package/dist/lib/output/formatter.d.ts.map +0 -1
  246. package/dist/lib/output/formatter.js.map +0 -1
  247. package/dist/lib/output/index.d.ts.map +0 -1
  248. package/dist/lib/output/index.js.map +0 -1
  249. package/dist/lib/output/models/UrlMapping.d.ts +0 -13
  250. package/dist/lib/output/models/UrlMapping.d.ts.map +0 -1
  251. package/dist/lib/output/models/UrlMapping.js +0 -10
  252. package/dist/lib/output/models/UrlMapping.js.map +0 -1
  253. package/dist/lib/output/output.d.ts.map +0 -1
  254. package/dist/lib/output/output.js.map +0 -1
  255. package/dist/lib/output/plugins/AssetsPlugin.d.ts.map +0 -1
  256. package/dist/lib/output/plugins/AssetsPlugin.js.map +0 -1
  257. package/dist/lib/output/plugins/HierarchyPlugin.d.ts.map +0 -1
  258. package/dist/lib/output/plugins/HierarchyPlugin.js.map +0 -1
  259. package/dist/lib/output/plugins/IconsPlugin.d.ts.map +0 -1
  260. package/dist/lib/output/plugins/IconsPlugin.js.map +0 -1
  261. package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts.map +0 -1
  262. package/dist/lib/output/plugins/JavascriptIndexPlugin.js.map +0 -1
  263. package/dist/lib/output/plugins/NavigationPlugin.d.ts.map +0 -1
  264. package/dist/lib/output/plugins/NavigationPlugin.js.map +0 -1
  265. package/dist/lib/output/plugins/SitemapPlugin.d.ts.map +0 -1
  266. package/dist/lib/output/plugins/SitemapPlugin.js.map +0 -1
  267. package/dist/lib/output/plugins/index.d.ts.map +0 -1
  268. package/dist/lib/output/plugins/index.js.map +0 -1
  269. package/dist/lib/output/renderer.d.ts.map +0 -1
  270. package/dist/lib/output/renderer.js.map +0 -1
  271. package/dist/lib/output/router.d.ts.map +0 -1
  272. package/dist/lib/output/router.js.map +0 -1
  273. package/dist/lib/output/theme.d.ts.map +0 -1
  274. package/dist/lib/output/theme.js.map +0 -1
  275. package/dist/lib/output/themes/MarkedPlugin.d.ts.map +0 -1
  276. package/dist/lib/output/themes/MarkedPlugin.js.map +0 -1
  277. package/dist/lib/output/themes/default/DefaultTheme.d.ts.map +0 -1
  278. package/dist/lib/output/themes/default/DefaultTheme.js.map +0 -1
  279. package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts.map +0 -1
  280. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js.map +0 -1
  281. package/dist/lib/output/themes/default/Slugger.d.ts.map +0 -1
  282. package/dist/lib/output/themes/default/Slugger.js.map +0 -1
  283. package/dist/lib/output/themes/default/layouts/default.d.ts.map +0 -1
  284. package/dist/lib/output/themes/default/layouts/default.js.map +0 -1
  285. package/dist/lib/output/themes/default/partials/anchor-icon.d.ts.map +0 -1
  286. package/dist/lib/output/themes/default/partials/anchor-icon.js.map +0 -1
  287. package/dist/lib/output/themes/default/partials/breadcrumb.d.ts.map +0 -1
  288. package/dist/lib/output/themes/default/partials/breadcrumb.js.map +0 -1
  289. package/dist/lib/output/themes/default/partials/comment.d.ts.map +0 -1
  290. package/dist/lib/output/themes/default/partials/comment.js.map +0 -1
  291. package/dist/lib/output/themes/default/partials/footer.d.ts.map +0 -1
  292. package/dist/lib/output/themes/default/partials/footer.js.map +0 -1
  293. package/dist/lib/output/themes/default/partials/header.d.ts.map +0 -1
  294. package/dist/lib/output/themes/default/partials/header.js.map +0 -1
  295. package/dist/lib/output/themes/default/partials/hierarchy.d.ts.map +0 -1
  296. package/dist/lib/output/themes/default/partials/hierarchy.js.map +0 -1
  297. package/dist/lib/output/themes/default/partials/icon.d.ts.map +0 -1
  298. package/dist/lib/output/themes/default/partials/icon.js.map +0 -1
  299. package/dist/lib/output/themes/default/partials/index.d.ts.map +0 -1
  300. package/dist/lib/output/themes/default/partials/index.js.map +0 -1
  301. package/dist/lib/output/themes/default/partials/member.d.ts.map +0 -1
  302. package/dist/lib/output/themes/default/partials/member.declaration.d.ts.map +0 -1
  303. package/dist/lib/output/themes/default/partials/member.declaration.js.map +0 -1
  304. package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts.map +0 -1
  305. package/dist/lib/output/themes/default/partials/member.getterSetter.js.map +0 -1
  306. package/dist/lib/output/themes/default/partials/member.js.map +0 -1
  307. package/dist/lib/output/themes/default/partials/member.signature.body.d.ts.map +0 -1
  308. package/dist/lib/output/themes/default/partials/member.signature.body.js.map +0 -1
  309. package/dist/lib/output/themes/default/partials/member.signature.title.d.ts.map +0 -1
  310. package/dist/lib/output/themes/default/partials/member.signature.title.js.map +0 -1
  311. package/dist/lib/output/themes/default/partials/member.signatures.d.ts.map +0 -1
  312. package/dist/lib/output/themes/default/partials/member.signatures.js.map +0 -1
  313. package/dist/lib/output/themes/default/partials/member.sources.d.ts.map +0 -1
  314. package/dist/lib/output/themes/default/partials/member.sources.js.map +0 -1
  315. package/dist/lib/output/themes/default/partials/members.d.ts.map +0 -1
  316. package/dist/lib/output/themes/default/partials/members.js.map +0 -1
  317. package/dist/lib/output/themes/default/partials/moduleReflection.d.ts.map +0 -1
  318. package/dist/lib/output/themes/default/partials/moduleReflection.js.map +0 -1
  319. package/dist/lib/output/themes/default/partials/navigation.d.ts.map +0 -1
  320. package/dist/lib/output/themes/default/partials/navigation.js.map +0 -1
  321. package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts.map +0 -1
  322. package/dist/lib/output/themes/default/partials/reflectionPreview.js.map +0 -1
  323. package/dist/lib/output/themes/default/partials/toolbar.d.ts.map +0 -1
  324. package/dist/lib/output/themes/default/partials/toolbar.js.map +0 -1
  325. package/dist/lib/output/themes/default/partials/type.d.ts.map +0 -1
  326. package/dist/lib/output/themes/default/partials/type.js.map +0 -1
  327. package/dist/lib/output/themes/default/partials/typeAndParent.d.ts.map +0 -1
  328. package/dist/lib/output/themes/default/partials/typeAndParent.js.map +0 -1
  329. package/dist/lib/output/themes/default/partials/typeDetails.d.ts.map +0 -1
  330. package/dist/lib/output/themes/default/partials/typeDetails.js.map +0 -1
  331. package/dist/lib/output/themes/default/partials/typeParameters.d.ts.map +0 -1
  332. package/dist/lib/output/themes/default/partials/typeParameters.js.map +0 -1
  333. package/dist/lib/output/themes/default/templates/document.d.ts.map +0 -1
  334. package/dist/lib/output/themes/default/templates/document.js.map +0 -1
  335. package/dist/lib/output/themes/default/templates/hierarchy.d.ts.map +0 -1
  336. package/dist/lib/output/themes/default/templates/hierarchy.js.map +0 -1
  337. package/dist/lib/output/themes/default/templates/index.d.ts.map +0 -1
  338. package/dist/lib/output/themes/default/templates/index.js.map +0 -1
  339. package/dist/lib/output/themes/default/templates/reflection.d.ts.map +0 -1
  340. package/dist/lib/output/themes/default/templates/reflection.js.map +0 -1
  341. package/dist/lib/output/themes/lib.d.ts.map +0 -1
  342. package/dist/lib/output/themes/lib.js.map +0 -1
  343. package/dist/lib/serialization/components.d.ts.map +0 -1
  344. package/dist/lib/serialization/components.js.map +0 -1
  345. package/dist/lib/serialization/deserializer.d.ts.map +0 -1
  346. package/dist/lib/serialization/deserializer.js.map +0 -1
  347. package/dist/lib/serialization/events.d.ts.map +0 -1
  348. package/dist/lib/serialization/events.js.map +0 -1
  349. package/dist/lib/serialization/index.d.ts.map +0 -1
  350. package/dist/lib/serialization/index.js.map +0 -1
  351. package/dist/lib/serialization/schema.d.ts.map +0 -1
  352. package/dist/lib/serialization/schema.js.map +0 -1
  353. package/dist/lib/serialization/serializer.d.ts.map +0 -1
  354. package/dist/lib/serialization/serializer.js.map +0 -1
  355. package/dist/lib/utils/ValidatingFileRegistry.d.ts.map +0 -1
  356. package/dist/lib/utils/ValidatingFileRegistry.js.map +0 -1
  357. package/dist/lib/utils/component.d.ts.map +0 -1
  358. package/dist/lib/utils/component.js.map +0 -1
  359. package/dist/lib/utils/compress.d.ts.map +0 -1
  360. package/dist/lib/utils/compress.js.map +0 -1
  361. package/dist/lib/utils/entry-point.d.ts.map +0 -1
  362. package/dist/lib/utils/entry-point.js.map +0 -1
  363. package/dist/lib/utils/fs.d.ts.map +0 -1
  364. package/dist/lib/utils/fs.js.map +0 -1
  365. package/dist/lib/utils/general.d.ts.map +0 -1
  366. package/dist/lib/utils/general.js.map +0 -1
  367. package/dist/lib/utils/highlighter.d.ts.map +0 -1
  368. package/dist/lib/utils/highlighter.js.map +0 -1
  369. package/dist/lib/utils/html-entities.d.ts.map +0 -1
  370. package/dist/lib/utils/html-entities.js.map +0 -1
  371. package/dist/lib/utils/html.d.ts.map +0 -1
  372. package/dist/lib/utils/html.js.map +0 -1
  373. package/dist/lib/utils/index.d.ts.map +0 -1
  374. package/dist/lib/utils/index.js.map +0 -1
  375. package/dist/lib/utils/loggers.d.ts.map +0 -1
  376. package/dist/lib/utils/loggers.js.map +0 -1
  377. package/dist/lib/utils/options/declaration.d.ts.map +0 -1
  378. package/dist/lib/utils/options/declaration.js.map +0 -1
  379. package/dist/lib/utils/options/defaults.d.ts.map +0 -1
  380. package/dist/lib/utils/options/defaults.js.map +0 -1
  381. package/dist/lib/utils/options/help.d.ts.map +0 -1
  382. package/dist/lib/utils/options/help.js.map +0 -1
  383. package/dist/lib/utils/options/index.d.ts.map +0 -1
  384. package/dist/lib/utils/options/index.js.map +0 -1
  385. package/dist/lib/utils/options/options.d.ts.map +0 -1
  386. package/dist/lib/utils/options/options.js.map +0 -1
  387. package/dist/lib/utils/options/readers/arguments.d.ts.map +0 -1
  388. package/dist/lib/utils/options/readers/arguments.js.map +0 -1
  389. package/dist/lib/utils/options/readers/index.d.ts.map +0 -1
  390. package/dist/lib/utils/options/readers/index.js.map +0 -1
  391. package/dist/lib/utils/options/readers/package-json.d.ts.map +0 -1
  392. package/dist/lib/utils/options/readers/package-json.js.map +0 -1
  393. package/dist/lib/utils/options/readers/tsconfig.d.ts.map +0 -1
  394. package/dist/lib/utils/options/readers/tsconfig.js.map +0 -1
  395. package/dist/lib/utils/options/readers/typedoc.d.ts.map +0 -1
  396. package/dist/lib/utils/options/readers/typedoc.js.map +0 -1
  397. package/dist/lib/utils/options/sources/index.d.ts.map +0 -1
  398. package/dist/lib/utils/options/sources/index.js.map +0 -1
  399. package/dist/lib/utils/options/sources/typedoc.d.ts.map +0 -1
  400. package/dist/lib/utils/options/sources/typedoc.js.map +0 -1
  401. package/dist/lib/utils/options/tsdoc-defaults.d.ts.map +0 -1
  402. package/dist/lib/utils/options/tsdoc-defaults.js.map +0 -1
  403. package/dist/lib/utils/package-manifest.d.ts.map +0 -1
  404. package/dist/lib/utils/package-manifest.js.map +0 -1
  405. package/dist/lib/utils/paths.d.ts.map +0 -1
  406. package/dist/lib/utils/paths.js.map +0 -1
  407. package/dist/lib/utils/perf.d.ts.map +0 -1
  408. package/dist/lib/utils/perf.js.map +0 -1
  409. package/dist/lib/utils/plugins.d.ts.map +0 -1
  410. package/dist/lib/utils/plugins.js.map +0 -1
  411. package/dist/lib/utils/reflections.d.ts.map +0 -1
  412. package/dist/lib/utils/reflections.js.map +0 -1
  413. package/dist/lib/utils/sort.d.ts.map +0 -1
  414. package/dist/lib/utils/sort.js.map +0 -1
  415. package/dist/lib/utils/tsconfig.d.ts.map +0 -1
  416. package/dist/lib/utils/tsconfig.js.map +0 -1
  417. package/dist/lib/utils/tsutils.d.ts.map +0 -1
  418. package/dist/lib/utils/tsutils.js.map +0 -1
  419. package/dist/lib/utils-common/array.d.ts.map +0 -1
  420. package/dist/lib/utils-common/array.js.map +0 -1
  421. package/dist/lib/utils-common/declarationReference.d.ts.map +0 -1
  422. package/dist/lib/utils-common/declarationReference.js.map +0 -1
  423. package/dist/lib/utils-common/enum.d.ts.map +0 -1
  424. package/dist/lib/utils-common/enum.js.map +0 -1
  425. package/dist/lib/utils-common/events.d.ts.map +0 -1
  426. package/dist/lib/utils-common/events.js.map +0 -1
  427. package/dist/lib/utils-common/general.d.ts.map +0 -1
  428. package/dist/lib/utils-common/general.js.map +0 -1
  429. package/dist/lib/utils-common/hooks.d.ts.map +0 -1
  430. package/dist/lib/utils-common/hooks.js.map +0 -1
  431. package/dist/lib/utils-common/i18n.d.ts.map +0 -1
  432. package/dist/lib/utils-common/i18n.js.map +0 -1
  433. package/dist/lib/utils-common/index.d.ts.map +0 -1
  434. package/dist/lib/utils-common/index.js.map +0 -1
  435. package/dist/lib/utils-common/jsx.d.ts.map +0 -1
  436. package/dist/lib/utils-common/jsx.elements.d.ts.map +0 -1
  437. package/dist/lib/utils-common/jsx.elements.js.map +0 -1
  438. package/dist/lib/utils-common/jsx.js.map +0 -1
  439. package/dist/lib/utils-common/logger.d.ts.map +0 -1
  440. package/dist/lib/utils-common/logger.js.map +0 -1
  441. package/dist/lib/utils-common/map.d.ts.map +0 -1
  442. package/dist/lib/utils-common/map.js.map +0 -1
  443. package/dist/lib/utils-common/minimalSourceFile.d.ts.map +0 -1
  444. package/dist/lib/utils-common/minimalSourceFile.js.map +0 -1
  445. package/dist/lib/utils-common/path.d.ts.map +0 -1
  446. package/dist/lib/utils-common/path.js.map +0 -1
  447. package/dist/lib/utils-common/set.d.ts.map +0 -1
  448. package/dist/lib/utils-common/set.js.map +0 -1
  449. package/dist/lib/utils-common/string.d.ts.map +0 -1
  450. package/dist/lib/utils-common/string.js.map +0 -1
  451. package/dist/lib/utils-common/validation.d.ts.map +0 -1
  452. package/dist/lib/utils-common/validation.js.map +0 -1
  453. package/dist/lib/validation/documentation.d.ts.map +0 -1
  454. package/dist/lib/validation/documentation.js.map +0 -1
  455. package/dist/lib/validation/exports.d.ts.map +0 -1
  456. package/dist/lib/validation/exports.js.map +0 -1
  457. package/dist/lib/validation/links.d.ts.map +0 -1
  458. package/dist/lib/validation/links.js.map +0 -1
  459. package/dist/lib/validation/unusedMergeModuleWith.d.ts.map +0 -1
  460. package/dist/lib/validation/unusedMergeModuleWith.js.map +0 -1
@@ -4,7 +4,7 @@ import { type Options } from "../../../utils/index.js";
4
4
  import type { DefaultTheme } from "./DefaultTheme.js";
5
5
  import { type Icons } from "./partials/icon.js";
6
6
  import type { Router } from "../../router.js";
7
- import type { NeverIfInternal } from "#utils";
7
+ import type { JSX, NeverIfInternal } from "#utils";
8
8
  export declare class DefaultThemeRenderContext {
9
9
  readonly router: Router;
10
10
  readonly theme: DefaultTheme;
@@ -15,11 +15,18 @@ export declare class DefaultThemeRenderContext {
15
15
  constructor(router: Router, theme: DefaultTheme, page: PageEvent<Reflection>, options: Options);
16
16
  /**
17
17
  * Icons available for use within the page.
18
+ * When getting an icon for a reflection, {@link reflectionIcon} should be used so
19
+ * that themes which define multiple icon variants can correctly specify which icon
20
+ * they want to be used.
18
21
  *
19
22
  * Note: This creates a reference to icons declared by {@link DefaultTheme.icons},
20
23
  * to customize icons, that object must be modified instead.
21
24
  */
22
25
  get icons(): Readonly<Icons>;
26
+ /**
27
+ * Do not override this method, override {@link DefaultTheme.getReflectionIcon} instead.
28
+ */
29
+ reflectionIcon: (reflection: Reflection) => JSX.Element;
23
30
  get slugger(): import("./Slugger.js").Slugger;
24
31
  hook: Renderer["hooks"]["emit"];
25
32
  /** Avoid this in favor of urlTo if possible */
@@ -28,14 +35,14 @@ export declare class DefaultThemeRenderContext {
28
35
  urlTo: (reflection: Reflection) => string | undefined;
29
36
  markdown: (md: readonly CommentDisplayPart[] | NeverIfInternal<string | undefined>) => string;
30
37
  /** Renders user comment markdown wrapped in a tsd-comment div */
31
- displayParts: (parts: readonly CommentDisplayPart[] | undefined) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
38
+ displayParts: (parts: readonly CommentDisplayPart[] | undefined) => JSX.Element | undefined;
32
39
  getNavigation: () => import("./DefaultTheme.js").NavigationElement[];
33
40
  getReflectionClasses: (refl: Reflection) => string;
34
- documentTemplate: (props: PageEvent<import("../../../models/DocumentReflection.js").DocumentReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
35
- reflectionTemplate: (props: PageEvent<import("../../../models/ContainerReflection.js").ContainerReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
36
- indexTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
37
- hierarchyTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
38
- defaultLayout: (template: import("../../index.js").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
41
+ documentTemplate: (props: PageEvent<import("../../../models/DocumentReflection.js").DocumentReflection>) => JSX.Element;
42
+ reflectionTemplate: (props: PageEvent<import("../../../models/ContainerReflection.js").ContainerReflection>) => JSX.Element;
43
+ indexTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => JSX.Element;
44
+ hierarchyTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => JSX.Element;
45
+ defaultLayout: (template: import("./DefaultTheme.js").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => JSX.Element;
39
46
  /**
40
47
  * Rendered just after the description for a reflection.
41
48
  * This can be used to render a shortened type display of a reflection that the
@@ -44,55 +51,55 @@ export declare class DefaultThemeRenderContext {
44
51
  * Note: Will not be called for variables/type aliases, as they are summarized
45
52
  * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
46
53
  */
47
- reflectionPreview: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
54
+ reflectionPreview: (props: Reflection) => JSX.Element | undefined;
48
55
  /**
49
56
  * Used to render additional details about a type. This is used to implement
50
57
  * the `@expand` tag, comments on union members, comments on object type members...
51
58
  */
52
- typeDetails: (type: import("../../../models/types.js").SomeType, renderAnchors: boolean) => import("../../../utils-common/jsx.elements.js").JsxChildren;
59
+ typeDetails: (reflectionOwningType: Reflection, type: import("../../../models/types.js").SomeType, renderAnchors: boolean) => JSX.Children;
53
60
  /**
54
61
  * Should call the {@link typeDetails} helper if rendering additional details
55
62
  * about the type will provide the user with more information about the type.
56
63
  */
57
- typeDetailsIfUseful: (type: import("../../../models/types.js").SomeType | undefined) => import("../../../utils-common/jsx.elements.js").JsxChildren;
64
+ typeDetailsIfUseful: (reflectionOwningType: Reflection, type: import("../../../models/types.js").SomeType | undefined) => JSX.Children;
58
65
  /**
59
66
  * Wrapper around {@link typeDetails} which checks if it is useful
60
67
  * and includes a "Type Declaration" header.
61
68
  */
62
- typeDeclaration: (type: import("../../../models/types.js").SomeType) => import("../../../utils-common/jsx.elements.js").JsxChildren;
63
- breadcrumbs: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
64
- commentShortSummary: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
65
- commentSummary: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
66
- commentTags: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
67
- reflectionFlags: (props: Reflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
68
- footer: () => import("../../../utils-common/jsx.elements.js").JsxElement;
69
- header: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
70
- hierarchy: (typeHierarchy: import("../../../models/DeclarationReflection.js").DeclarationHierarchy | undefined) => import("../../../utils-common/jsx.elements.js").JsxElement | undefined;
71
- index: (props: import("../../../models/ContainerReflection.js").ContainerReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
72
- member: (props: import("../../../models/DocumentReflection.js").DocumentReflection | import("../../../models/DeclarationReflection.js").DeclarationReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
73
- moduleReflection: (mod: import("../../../models/DeclarationReflection.js").DeclarationReflection | import("../../../models/ProjectReflection.js").ProjectReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
74
- moduleMemberSummary: (member: import("../../../models/DocumentReflection.js").DocumentReflection | import("../../../models/DeclarationReflection.js").DeclarationReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
75
- memberDeclaration: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
76
- memberGetterSetter: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
69
+ typeDeclaration: (reflectionOwningType: Reflection, type: import("../../../models/types.js").SomeType) => JSX.Children;
70
+ breadcrumbs: (props: Reflection) => JSX.Element;
71
+ commentShortSummary: (props: Reflection) => JSX.Element | undefined;
72
+ commentSummary: (props: Reflection) => JSX.Element | undefined;
73
+ commentTags: (props: Reflection) => JSX.Element | undefined;
74
+ reflectionFlags: (props: Reflection) => JSX.Element;
75
+ footer: () => JSX.Element;
76
+ header: (props: PageEvent<Reflection>) => JSX.Element;
77
+ hierarchy: (typeHierarchy: import("../../../models/DeclarationReflection.js").DeclarationHierarchy | undefined) => JSX.Element | undefined;
78
+ index: (props: import("../../../models/ContainerReflection.js").ContainerReflection) => JSX.Element;
79
+ member: (props: import("../../../models/DocumentReflection.js").DocumentReflection | import("../../../models/DeclarationReflection.js").DeclarationReflection) => JSX.Element;
80
+ moduleReflection: (mod: import("../../../models/DeclarationReflection.js").DeclarationReflection | import("../../../models/ProjectReflection.js").ProjectReflection) => JSX.Element;
81
+ moduleMemberSummary: (member: import("../../../models/DocumentReflection.js").DocumentReflection | import("../../../models/DeclarationReflection.js").DeclarationReflection) => JSX.Element;
82
+ memberDeclaration: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => JSX.Element;
83
+ memberGetterSetter: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => JSX.Element;
77
84
  memberSignatureBody: (props: import("../../../models/SignatureReflection.js").SignatureReflection, r_1?: {
78
85
  hideSources?: boolean;
79
- } | undefined) => import("../../../utils-common/jsx.elements.js").JsxElement;
86
+ } | undefined) => JSX.Element;
80
87
  memberSignatureTitle: (props: import("../../../models/SignatureReflection.js").SignatureReflection, options?: {
81
88
  hideName?: boolean;
82
- } | undefined) => import("../../../utils-common/jsx.elements.js").JsxElement;
83
- memberSignatures: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
84
- memberSources: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection | import("../../../models/SignatureReflection.js").SignatureReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
85
- members: (props: import("../../../models/ContainerReflection.js").ContainerReflection) => import("../../../utils-common/jsx.elements.js").JsxElement;
86
- sidebar: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
87
- pageSidebar: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
88
- sidebarLinks: () => import("../../../utils-common/jsx.elements.js").JsxElement | null;
89
- settings: () => import("../../../utils-common/jsx.elements.js").JsxElement;
90
- navigation: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
91
- pageNavigation: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
92
- toolbar: (props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
89
+ } | undefined) => JSX.Element;
90
+ memberSignatures: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection) => JSX.Element;
91
+ memberSources: (props: import("../../../models/DeclarationReflection.js").DeclarationReflection | import("../../../models/SignatureReflection.js").SignatureReflection) => JSX.Element;
92
+ members: (props: import("../../../models/ContainerReflection.js").ContainerReflection) => JSX.Element;
93
+ sidebar: (props: PageEvent<Reflection>) => JSX.Element;
94
+ pageSidebar: (props: PageEvent<Reflection>) => JSX.Element;
95
+ sidebarLinks: () => JSX.Element | null;
96
+ settings: () => JSX.Element;
97
+ navigation: (props: PageEvent<Reflection>) => JSX.Element;
98
+ pageNavigation: (props: PageEvent<Reflection>) => JSX.Element;
99
+ toolbar: (props: PageEvent<Reflection>) => JSX.Element;
93
100
  type: (type: import("../../../models/types.js").SomeType | undefined, options?: {
94
101
  topLevelLinks: boolean;
95
- } | undefined) => import("../../../utils-common/jsx.elements.js").JsxElement;
96
- typeAndParent: (props: import("../../../models/types.js").Type) => import("../../../utils-common/jsx.elements.js").JsxElement;
97
- typeParameters: (typeParameters: import("../../../models/TypeParameterReflection.js").TypeParameterReflection[]) => import("../../../utils-common/jsx.elements.js").JsxElement;
102
+ } | undefined) => JSX.Element;
103
+ typeAndParent: (props: import("../../../models/types.js").Type) => JSX.Element;
104
+ typeParameters: (typeParameters: import("../../../models/TypeParameterReflection.js").TypeParameterReflection[]) => JSX.Element;
98
105
  }
@@ -47,6 +47,9 @@ export class DefaultThemeRenderContext {
47
47
  }
48
48
  /**
49
49
  * Icons available for use within the page.
50
+ * When getting an icon for a reflection, {@link reflectionIcon} should be used so
51
+ * that themes which define multiple icon variants can correctly specify which icon
52
+ * they want to be used.
50
53
  *
51
54
  * Note: This creates a reference to icons declared by {@link DefaultTheme.icons},
52
55
  * to customize icons, that object must be modified instead.
@@ -54,6 +57,12 @@ export class DefaultThemeRenderContext {
54
57
  get icons() {
55
58
  return this._refIcons;
56
59
  }
60
+ /**
61
+ * Do not override this method, override {@link DefaultTheme.getReflectionIcon} instead.
62
+ */
63
+ reflectionIcon = (reflection) => {
64
+ return this.icons[this.theme.getReflectionIcon(reflection)]();
65
+ };
57
66
  get slugger() {
58
67
  return this.router.getSlugger(this.page.model);
59
68
  }
@@ -69,20 +78,10 @@ export class DefaultThemeRenderContext {
69
78
  return result;
70
79
  };
71
80
  getAnchor = (reflection) => {
72
- const anchor = this.router.getAnchor(reflection);
73
- if (!anchor) {
74
- // This will go to debug level before release
75
- this.theme.application.logger.warn(`${reflection.getFullName()} does not have an anchor but one was requested when generating page for ${this.model.getFullName()}, this is a bug`);
76
- }
77
- return anchor;
81
+ return this.router.getAnchor(reflection);
78
82
  };
79
83
  urlTo = (reflection) => {
80
- if (this.router.hasUrl(reflection)) {
81
- return this.router.relativeUrl(this.page.model, reflection);
82
- }
83
- // This will go to debug level before release
84
- this.theme.application.logger.warn(`${reflection.getFullName()} does not have a URL but was linked to when generating page for ${this.model.getFullName()}, this is a bug`);
85
- return undefined;
84
+ return this.router.relativeUrl(this.page.model, reflection);
86
85
  };
87
86
  markdown = (md) => {
88
87
  return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);
@@ -2,5 +2,4 @@ import type { Reflection } from "../../../../models/index.js";
2
2
  import { JSX } from "#utils";
3
3
  import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
4
4
  export declare function anchorIcon(context: DefaultThemeRenderContext, anchor: string | undefined): JSX.Element;
5
- export declare function anchorLink(anchor: string | undefined): JSX.Element;
6
- export declare function anchorLinkIfPresent(context: DefaultThemeRenderContext, refl: Reflection): JSX.Element;
5
+ export declare function anchorTargetIfPresent(context: DefaultThemeRenderContext, refl: Reflection): string | undefined;
@@ -4,13 +4,6 @@ export function anchorIcon(context, anchor) {
4
4
  return JSX.createElement(JSX.Fragment, null);
5
5
  return (JSX.createElement("a", { href: `#${anchor}`, "aria-label": i18n.theme_permalink(), class: "tsd-anchor-icon" }, context.icons.anchor()));
6
6
  }
7
- export function anchorLink(anchor) {
8
- if (!anchor)
9
- return JSX.createElement(JSX.Fragment, null);
10
- return JSX.createElement("a", { id: anchor, class: "tsd-anchor" });
11
- }
12
- export function anchorLinkIfPresent(context, refl) {
13
- if (!context.router.hasUrl(refl))
14
- return JSX.createElement(JSX.Fragment, null);
15
- return anchorLink(context.router.getAnchor(refl));
7
+ export function anchorTargetIfPresent(context, refl) {
8
+ return context.router.hasUrl(refl) ? context.router.getAnchor(refl) : undefined;
16
9
  }
@@ -6,6 +6,6 @@ export function breadcrumbs(context, props) {
6
6
  path.push(refl);
7
7
  refl = refl.parent;
8
8
  }
9
- return (JSX.createElement("ul", { class: "tsd-breadcrumb" }, path.reverse().map((r) => (JSX.createElement("li", null,
10
- JSX.createElement("a", { href: context.urlTo(r) }, r.name))))));
9
+ return (JSX.createElement("ul", { class: "tsd-breadcrumb", "aria-label": "Breadcrumb" }, path.reverse().map((r, index) => (JSX.createElement("li", null,
10
+ JSX.createElement("a", { href: context.urlTo(r), "aria-current": index === path.length - 1 ? "page" : undefined }, r.name))))));
11
11
  }
@@ -1,6 +1,6 @@
1
1
  import { JSX, translateTagName } from "#utils";
2
2
  import { ReflectionKind } from "../../../../models/index.js";
3
- import { anchorIcon, anchorLink } from "./anchor-icon.js";
3
+ import { anchorIcon } from "./anchor-icon.js";
4
4
  import { join } from "../../lib.js";
5
5
  // Note: Comment modifiers are handled in `renderFlags`
6
6
  export function renderDisplayParts({ markdown }, parts) {
@@ -57,8 +57,7 @@ export function commentTags(context, props) {
57
57
  const anchor = context.slugger.slug(name);
58
58
  return (JSX.createElement(JSX.Fragment, null,
59
59
  JSX.createElement("div", { class: `tsd-tag-${item.tag.substring(1)}` },
60
- JSX.createElement("h4", { class: "tsd-anchor-link" },
61
- anchorLink(anchor),
60
+ JSX.createElement("h4", { class: "tsd-anchor-link", id: anchor },
62
61
  name,
63
62
  anchorIcon(context, anchor)),
64
63
  JSX.createElement(JSX.Raw, { html: context.markdown(item.content) }))));
@@ -1,13 +1,13 @@
1
1
  import { classNames, renderName } from "../../lib.js";
2
2
  import { i18n, JSX } from "#utils";
3
- function renderCategory({ urlTo, icons, getReflectionClasses, markdown }, item, prependName = "") {
3
+ function renderCategory({ urlTo, reflectionIcon, getReflectionClasses, markdown }, item, prependName = "") {
4
4
  return (JSX.createElement("section", { class: "tsd-index-section" },
5
5
  JSX.createElement("h3", { class: "tsd-index-heading" }, prependName ? `${prependName} - ${item.title}` : item.title),
6
6
  item.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
7
7
  JSX.createElement(JSX.Raw, { html: markdown(item.description) }))),
8
8
  JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (JSX.createElement(JSX.Fragment, null,
9
9
  JSX.createElement("a", { href: urlTo(item), class: classNames({ "tsd-index-link": true, deprecated: item.isDeprecated() }, getReflectionClasses(item)) },
10
- icons[item.kind](),
10
+ reflectionIcon(item),
11
11
  JSX.createElement("span", null, renderName(item))),
12
12
  "\n"))))));
13
13
  }
@@ -26,9 +26,7 @@ export function index(context, props) {
26
26
  JSX.createElement("section", { class: "tsd-panel tsd-index-panel" },
27
27
  JSX.createElement("details", { class: "tsd-index-content tsd-accordion", open: true },
28
28
  JSX.createElement("summary", { class: "tsd-accordion-summary tsd-index-summary" },
29
- JSX.createElement("h5", { class: "tsd-index-heading uppercase", role: "button", "aria-expanded": "false", tabIndex: 0 },
30
- context.icons.chevronSmall(),
31
- " ",
32
- i18n.theme_index())),
29
+ context.icons.chevronSmall(),
30
+ JSX.createElement("h5", { class: "tsd-index-heading uppercase" }, i18n.theme_index())),
33
31
  JSX.createElement("div", { class: "tsd-accordion-details" }, content))))));
34
32
  }
@@ -27,7 +27,7 @@ export function memberDeclaration(context, props) {
27
27
  props.defaultValue)))),
28
28
  context.commentSummary(props),
29
29
  hasTypeParameters(props) && context.typeParameters(props.typeParameters),
30
- props.type && context.typeDeclaration(props.type),
30
+ props.type && context.typeDeclaration(props, props.type),
31
31
  context.commentTags(props),
32
32
  context.memberSources(props)));
33
33
  }
@@ -1,7 +1,7 @@
1
1
  import { classNames, getDisplayName, wbr } from "../../lib.js";
2
2
  import { JSX } from "#utils";
3
3
  import {} from "../../../../models/index.js";
4
- import { anchorIcon, anchorLink } from "./anchor-icon.js";
4
+ import { anchorIcon } from "./anchor-icon.js";
5
5
  export function member(context, props) {
6
6
  const anchor = context.getAnchor(props);
7
7
  context.page.pageHeadings.push({
@@ -14,8 +14,7 @@ export function member(context, props) {
14
14
  // own pages. Handle it here in case someone creates a custom url scheme which embeds guides within the page.
15
15
  if (props.isDocument()) {
16
16
  return (JSX.createElement("section", { class: classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
17
- anchorLink(anchor),
18
- !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link" },
17
+ !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link", id: anchor },
19
18
  context.reflectionFlags(props),
20
19
  JSX.createElement("span", { class: classNames({ deprecated: props.isDeprecated() }) }, wbr(props.name)),
21
20
  anchorIcon(context, anchor))),
@@ -23,8 +22,7 @@ export function member(context, props) {
23
22
  JSX.createElement(JSX.Raw, { html: context.markdown(props.content) }))));
24
23
  }
25
24
  return (JSX.createElement("section", { class: classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props)) },
26
- anchorLink(anchor),
27
- !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link" },
25
+ !!props.name && (JSX.createElement("h3", { class: "tsd-anchor-link", id: anchor },
28
26
  context.reflectionFlags(props),
29
27
  JSX.createElement("span", { class: classNames({ deprecated: props.isDeprecated() }) }, wbr(props.name)),
30
28
  anchorIcon(context, anchor))),
@@ -20,14 +20,14 @@ export function memberSignatureBody(context, props, { hideSources = false } = {}
20
20
  item.defaultValue))),
21
21
  context.commentSummary(item),
22
22
  context.commentTags(item),
23
- context.typeDetailsIfUseful(item.type))))))),
23
+ context.typeDetailsIfUseful(item, item.type))))))),
24
24
  props.type && (JSX.createElement(JSX.Fragment, null,
25
25
  JSX.createElement("h4", { class: "tsd-returns-title" },
26
26
  i18n.theme_returns(),
27
27
  " ",
28
28
  context.type(props.type)),
29
29
  returnsTag && JSX.createElement(JSX.Raw, { html: context.markdown(returnsTag.content) }),
30
- context.typeDetailsIfUseful(props.type))),
30
+ context.typeDetailsIfUseful(props, props.type))),
31
31
  context.commentTags(props),
32
32
  !hideSources && context.memberSources(props)));
33
33
  }
@@ -1,10 +1,9 @@
1
1
  import { JSX } from "#utils";
2
- import { anchorIcon, anchorLink } from "./anchor-icon.js";
2
+ import { anchorIcon } from "./anchor-icon.js";
3
3
  import { classNames } from "../../lib.js";
4
4
  export const memberSignatures = (context, props) => (JSX.createElement(JSX.Fragment, null,
5
5
  JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (JSX.createElement("li", { class: context.getReflectionClasses(item) },
6
- JSX.createElement("div", { class: "tsd-signature tsd-anchor-link" },
7
- anchorLink(context.getAnchor(item)),
6
+ JSX.createElement("div", { class: "tsd-signature tsd-anchor-link", id: context.getAnchor(item) },
8
7
  context.memberSignatureTitle(item),
9
8
  anchorIcon(context, context.getAnchor(item))),
10
9
  JSX.createElement("div", { class: "tsd-description" }, context.memberSignatureBody(item))))))));
@@ -7,10 +7,8 @@ export function members(context, props) {
7
7
  context.page.startNewSection(title);
8
8
  return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
9
9
  JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
10
- JSX.createElement("h2", null,
11
- context.icons.chevronDown(),
12
- " ",
13
- title)),
10
+ context.icons.chevronDown(),
11
+ JSX.createElement("h2", null, title)),
14
12
  JSX.createElement("section", null, children.map((item) => context.member(item)))));
15
13
  })));
16
14
  }
@@ -1,7 +1,7 @@
1
1
  import { ReferenceReflection, ReflectionKind, } from "../../../../models/index.js";
2
2
  import { JSX } from "#utils";
3
3
  import { classNames, getDisplayName, getMemberSections, getUniquePath, join } from "../../lib.js";
4
- import { anchorIcon, anchorLink } from "./anchor-icon.js";
4
+ import { anchorIcon } from "./anchor-icon.js";
5
5
  export function moduleReflection(context, mod) {
6
6
  const sections = getMemberSections(mod);
7
7
  return (JSX.createElement(JSX.Fragment, null,
@@ -14,10 +14,8 @@ export function moduleReflection(context, mod) {
14
14
  context.page.startNewSection(title);
15
15
  return (JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
16
16
  JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
17
- JSX.createElement("h2", null,
18
- context.icons.chevronDown(),
19
- " ",
20
- title)),
17
+ context.icons.chevronDown(),
18
+ JSX.createElement("h2", null, title)),
21
19
  description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
22
20
  JSX.createElement(JSX.Raw, { html: context.markdown(description) }))),
23
21
  JSX.createElement("dl", { class: "tsd-member-summaries" }, children.map((item) => context.moduleMemberSummary(item)))));
@@ -35,7 +33,7 @@ export function moduleMemberSummary(context, member) {
35
33
  if (member instanceof ReferenceReflection) {
36
34
  const target = member.getTargetReflectionDeep();
37
35
  name = (JSX.createElement("span", { class: "tsd-member-summary-name" },
38
- context.icons[target.kind](),
36
+ context.reflectionIcon(target),
39
37
  JSX.createElement("span", { class: classNames({ deprecated: member.isDeprecated() }) }, member.name),
40
38
  JSX.createElement("span", null,
41
39
  "\u00A0",
@@ -46,14 +44,12 @@ export function moduleMemberSummary(context, member) {
46
44
  }
47
45
  else {
48
46
  name = (JSX.createElement("span", { class: "tsd-member-summary-name" },
49
- context.icons[member.kind](),
47
+ context.reflectionIcon(member),
50
48
  JSX.createElement("a", { class: classNames({ deprecated: member.isDeprecated() }), href: context.urlTo(member) }, member.name),
51
49
  anchorIcon(context, id)));
52
50
  }
53
51
  return (JSX.createElement(JSX.Fragment, null,
54
- JSX.createElement("dt", { class: classNames({ "tsd-member-summary": true }, context.getReflectionClasses(member)) },
55
- anchorLink(id),
56
- name),
52
+ JSX.createElement("dt", { class: classNames({ "tsd-member-summary": true }, context.getReflectionClasses(member)), id: id }, name),
57
53
  JSX.createElement("dd", { class: classNames({ "tsd-member-summary": true }, context.getReflectionClasses(member)) }, context.commentShortSummary(member))));
58
54
  }
59
55
  // Note: This version of uniqueName does NOT include colors... they looked weird to me
@@ -50,9 +50,8 @@ export function settings(context) {
50
50
  return (JSX.createElement("div", { class: "tsd-navigation settings" },
51
51
  JSX.createElement("details", { class: "tsd-accordion", open: false },
52
52
  JSX.createElement("summary", { class: "tsd-accordion-summary" },
53
- JSX.createElement("h3", null,
54
- context.icons.chevronDown(),
55
- i18n.theme_settings())),
53
+ context.icons.chevronDown(),
54
+ JSX.createElement("h3", null, i18n.theme_settings())),
56
55
  JSX.createElement("div", { class: "tsd-accordion-details" },
57
56
  visibilityOptions.length && (JSX.createElement("div", { class: "tsd-filter-visibility" },
58
57
  JSX.createElement("span", { class: "settings-label" }, i18n.theme_member_visibility()),
@@ -101,7 +100,7 @@ function buildSectionNavigation(context, headings) {
101
100
  // Lower level than before
102
101
  levels.push([]);
103
102
  }
104
- levels[levels.length - 1].push(JSX.createElement("a", { href: heading.link, class: heading.classes },
103
+ levels[levels.length - 1].push(JSX.createElement("a", { href: heading.link, class: classNames({}, heading.classes) },
105
104
  heading.kind && context.icons[heading.kind](),
106
105
  JSX.createElement("span", null, wbr(heading.text))));
107
106
  }
@@ -131,8 +130,7 @@ export function pageNavigation(context, props) {
131
130
  }
132
131
  return (JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation" },
133
132
  JSX.createElement("summary", { class: "tsd-accordion-summary" },
134
- JSX.createElement("h3", null,
135
- context.icons.chevronDown(),
136
- i18n.theme_on_this_page())),
133
+ context.icons.chevronDown(),
134
+ JSX.createElement("h3", null, i18n.theme_on_this_page())),
137
135
  JSX.createElement("div", { class: "tsd-accordion-details" }, sections)));
138
136
  }
@@ -15,4 +15,12 @@ export function reflectionPreview(context, props) {
15
15
  generator.node(tree, Wrap.Enable);
16
16
  return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
17
17
  }
18
+ if (props.kindOf(ReflectionKind.TypeAlias) && props.children) {
19
+ const builder = new FormattedCodeBuilder(context.router, context.model);
20
+ const tree = builder.typeAlias(props);
21
+ const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
22
+ generator.forceWrap(builder.forceWrap); // Ensure elements are added to new lines.
23
+ generator.node(tree, Wrap.Enable);
24
+ return JSX.createElement("div", { class: "tsd-signature" }, generator.toElement());
25
+ }
18
26
  }
@@ -1,8 +1,8 @@
1
- import { type CommentDisplayPart } from "../../../../models/index.js";
1
+ import { type CommentDisplayPart, Reflection } from "../../../../models/index.js";
2
2
  import type { SomeType } from "../../../../models/types.js";
3
3
  import { JSX } from "#utils";
4
4
  import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
5
- export declare function typeDeclaration(context: DefaultThemeRenderContext, type: SomeType): JSX.Children;
6
- export declare function typeDetails(context: DefaultThemeRenderContext, type: SomeType, renderAnchors: boolean): JSX.Children;
7
- export declare function typeDetailsImpl(context: DefaultThemeRenderContext, type: SomeType, renderAnchors: boolean, highlighted?: Map<string, CommentDisplayPart[]>): JSX.Children;
8
- export declare function typeDetailsIfUseful(context: DefaultThemeRenderContext, type: SomeType | undefined): JSX.Children;
5
+ export declare function typeDeclaration(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType): JSX.Children;
6
+ export declare function typeDetails(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType, renderAnchors: boolean): JSX.Children;
7
+ export declare function typeDetailsImpl(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType, renderAnchors: boolean, highlighted?: Map<string, CommentDisplayPart[]>): JSX.Children;
8
+ export declare function typeDetailsIfUseful(context: DefaultThemeRenderContext, reflectionOwningType: Reflection, type: SomeType | undefined): JSX.Children;