typedoc 0.26.10 → 0.27.0-beta.0
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.
- package/bin/package.json +3 -0
- package/bin/typedoc +1 -1
- package/dist/index.d.ts +23 -13
- package/dist/index.js +22 -81
- package/dist/lib/application-events.js +1 -4
- package/dist/lib/application.d.ts +26 -16
- package/dist/lib/application.js +222 -242
- package/dist/lib/cli.js +3 -40
- package/dist/lib/converter/comments/blockLexer.d.ts +1 -1
- package/dist/lib/converter/comments/blockLexer.js +24 -30
- package/dist/lib/converter/comments/declarationReference.js +10 -21
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +2 -2
- package/dist/lib/converter/comments/declarationReferenceResolver.js +40 -36
- package/dist/lib/converter/comments/discovery.d.ts +4 -4
- package/dist/lib/converter/comments/discovery.js +172 -148
- package/dist/lib/converter/comments/index.d.ts +4 -4
- package/dist/lib/converter/comments/index.js +39 -50
- package/dist/lib/converter/comments/lexer.d.ts +1 -1
- package/dist/lib/converter/comments/lexer.js +2 -5
- package/dist/lib/converter/comments/lineLexer.d.ts +1 -1
- package/dist/lib/converter/comments/lineLexer.js +12 -15
- package/dist/lib/converter/comments/linkResolver.d.ts +2 -2
- package/dist/lib/converter/comments/linkResolver.js +14 -21
- package/dist/lib/converter/comments/parser.d.ts +6 -6
- package/dist/lib/converter/comments/parser.js +69 -96
- package/dist/lib/converter/comments/rawLexer.d.ts +1 -1
- package/dist/lib/converter/comments/rawLexer.js +13 -16
- package/dist/lib/converter/comments/tagName.js +1 -4
- package/dist/lib/converter/comments/textParser.d.ts +4 -4
- package/dist/lib/converter/comments/textParser.js +28 -30
- package/dist/lib/converter/components.d.ts +2 -3
- package/dist/lib/converter/components.js +2 -7
- package/dist/lib/converter/context.d.ts +9 -9
- package/dist/lib/converter/context.js +54 -44
- package/dist/lib/converter/convert-expression.js +16 -23
- package/dist/lib/converter/converter-events.d.ts +1 -0
- package/dist/lib/converter/converter-events.js +2 -4
- package/dist/lib/converter/converter.d.ts +16 -13
- package/dist/lib/converter/converter.js +210 -238
- package/dist/lib/converter/factories/index-signature.d.ts +1 -1
- package/dist/lib/converter/factories/index-signature.js +11 -17
- package/dist/lib/converter/factories/signature.d.ts +2 -2
- package/dist/lib/converter/factories/signature.js +95 -106
- package/dist/lib/converter/index.d.ts +6 -7
- package/dist/lib/converter/index.js +3 -11
- package/dist/lib/converter/jsdoc.d.ts +1 -1
- package/dist/lib/converter/jsdoc.js +34 -41
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts +6 -21
- package/dist/lib/converter/plugins/CategoryPlugin.js +57 -139
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/CommentPlugin.js +153 -163
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +10 -9
- package/dist/lib/converter/plugins/GroupPlugin.js +87 -124
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/ImplementsPlugin.js +255 -321
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +11 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +72 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/InheritDocPlugin.js +41 -72
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +5 -5
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +37 -58
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts +12 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +49 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +4 -3
- package/dist/lib/converter/plugins/PackagePlugin.js +62 -111
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +3 -5
- package/dist/lib/converter/plugins/SourcePlugin.js +69 -110
- package/dist/lib/converter/plugins/TypePlugin.d.ts +4 -6
- package/dist/lib/converter/plugins/TypePlugin.js +95 -158
- package/dist/lib/converter/plugins/index.d.ts +10 -9
- package/dist/lib/converter/plugins/index.js +10 -21
- package/dist/lib/converter/symbols.d.ts +1 -1
- package/dist/lib/converter/symbols.js +234 -227
- package/dist/lib/converter/types.d.ts +2 -2
- package/dist/lib/converter/types.js +252 -237
- package/dist/lib/converter/utils/nodes.js +5 -13
- package/dist/lib/converter/utils/reflections.d.ts +1 -1
- package/dist/lib/converter/utils/reflections.js +4 -7
- package/dist/lib/converter/utils/repository.d.ts +1 -1
- package/dist/lib/converter/utils/repository.js +103 -97
- package/dist/lib/converter/utils/symbols.js +3 -9
- package/dist/lib/internationalization/index.d.ts +3 -4
- package/dist/lib/internationalization/index.js +3 -8
- package/dist/lib/internationalization/internationalization.d.ts +5 -4
- package/dist/lib/internationalization/internationalization.js +97 -103
- package/dist/lib/internationalization/locale-utils.cjs +8 -0
- package/dist/lib/internationalization/locale-utils.d.cts +8 -0
- package/dist/lib/internationalization/locales/en.cjs +366 -2
- package/dist/lib/internationalization/locales/en.d.cts +339 -2
- package/dist/lib/internationalization/locales/jp.cjs +8 -11
- package/dist/lib/internationalization/locales/jp.d.cts +310 -1
- package/dist/lib/internationalization/locales/ko.cjs +7 -9
- package/dist/lib/internationalization/locales/ko.d.cts +223 -1
- package/dist/lib/internationalization/locales/zh.cjs +7 -10
- package/dist/lib/internationalization/locales/zh.d.cts +381 -1
- package/dist/lib/internationalization/translatable.d.ts +4 -327
- package/dist/lib/internationalization/translatable.js +2 -360
- package/dist/lib/models/FileRegistry.d.ts +20 -9
- package/dist/lib/models/FileRegistry.js +54 -45
- package/dist/lib/models/ReflectionCategory.d.ts +2 -2
- package/dist/lib/models/ReflectionCategory.js +16 -12
- package/dist/lib/models/ReflectionGroup.d.ts +3 -3
- package/dist/lib/models/ReflectionGroup.js +23 -14
- package/dist/lib/models/comments/comment.d.ts +23 -37
- package/dist/lib/models/comments/comment.js +388 -325
- package/dist/lib/models/comments/index.d.ts +2 -2
- package/dist/lib/models/comments/index.js +1 -6
- package/dist/lib/models/index.d.ts +7 -7
- package/dist/lib/models/index.js +7 -23
- package/dist/lib/models/reflections/ReflectionSymbolId.d.ts +2 -2
- package/dist/lib/models/reflections/ReflectionSymbolId.js +42 -34
- package/dist/lib/models/reflections/abstract.d.ts +17 -20
- package/dist/lib/models/reflections/abstract.js +249 -256
- package/dist/lib/models/reflections/container.d.ts +7 -7
- package/dist/lib/models/reflections/container.js +43 -16
- package/dist/lib/models/reflections/declaration.d.ts +15 -12
- package/dist/lib/models/reflections/declaration.js +150 -29
- package/dist/lib/models/reflections/document.d.ts +3 -3
- package/dist/lib/models/reflections/document.js +26 -13
- package/dist/lib/models/reflections/index.d.ts +15 -15
- package/dist/lib/models/reflections/index.js +12 -31
- package/dist/lib/models/reflections/kind.d.ts +1 -1
- package/dist/lib/models/reflections/kind.js +3 -6
- package/dist/lib/models/reflections/parameter.d.ts +5 -4
- package/dist/lib/models/reflections/parameter.js +11 -13
- package/dist/lib/models/reflections/project.d.ts +14 -9
- package/dist/lib/models/reflections/project.js +104 -56
- package/dist/lib/models/reflections/reference.d.ts +3 -3
- package/dist/lib/models/reflections/reference.js +6 -9
- package/dist/lib/models/reflections/signature.d.ts +8 -8
- package/dist/lib/models/reflections/signature.js +35 -14
- package/dist/lib/models/reflections/type-parameter.d.ts +5 -5
- package/dist/lib/models/reflections/type-parameter.js +9 -10
- package/dist/lib/models/reflections/utils.js +1 -4
- package/dist/lib/models/reflections/variant.d.ts +8 -7
- package/dist/lib/models/reflections/variant.js +1 -2
- package/dist/lib/models/sources/file.d.ts +2 -2
- package/dist/lib/models/sources/file.js +22 -5
- package/dist/lib/models/sources/index.d.ts +1 -1
- package/dist/lib/models/sources/index.js +1 -5
- package/dist/lib/models/types.d.ts +26 -13
- package/dist/lib/models/types.js +236 -151
- package/dist/lib/output/components.d.ts +5 -11
- package/dist/lib/output/components.js +84 -125
- package/dist/lib/output/events.d.ts +3 -3
- package/dist/lib/output/events.js +128 -94
- package/dist/lib/output/formatter.d.ts +84 -0
- package/dist/lib/output/formatter.js +619 -0
- package/dist/lib/output/index.d.ts +9 -8
- package/dist/lib/output/index.js +7 -19
- package/dist/lib/output/models/UrlMapping.d.ts +2 -2
- package/dist/lib/output/models/UrlMapping.js +4 -5
- package/dist/lib/output/output.d.ts +13 -0
- package/dist/lib/output/output.js +72 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts +7 -8
- package/dist/lib/output/plugins/AssetsPlugin.js +62 -80
- package/dist/lib/output/plugins/IconsPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/IconsPlugin.js +28 -84
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts +9 -2
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +90 -96
- package/dist/lib/output/plugins/NavigationPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/NavigationPlugin.js +22 -102
- package/dist/lib/output/plugins/SitemapPlugin.d.ts +3 -2
- package/dist/lib/output/plugins/SitemapPlugin.js +60 -120
- package/dist/lib/output/plugins/index.d.ts +6 -6
- package/dist/lib/output/plugins/index.js +6 -15
- package/dist/lib/output/renderer.d.ts +14 -13
- package/dist/lib/output/renderer.js +129 -185
- package/dist/lib/output/theme.d.ts +9 -5
- package/dist/lib/output/theme.js +14 -62
- package/dist/lib/output/themes/MarkedPlugin.d.ts +8 -9
- package/dist/lib/output/themes/MarkedPlugin.js +152 -117
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +17 -29
- package/dist/lib/output/themes/default/DefaultTheme.js +334 -310
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +63 -48
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +119 -95
- package/dist/lib/output/themes/default/Slugger.d.ts +13 -0
- package/dist/lib/output/themes/default/Slugger.js +46 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +5 -5
- package/dist/lib/output/themes/default/layouts/default.js +67 -34
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/anchor-icon.js +4 -7
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/breadcrumb.js +4 -8
- package/dist/lib/output/themes/default/partials/comment.d.ts +6 -4
- package/dist/lib/output/themes/default/partials/comment.js +52 -29
- package/dist/lib/output/themes/default/partials/footer.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/footer.js +11 -14
- package/dist/lib/output/themes/default/partials/header.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/header.js +9 -13
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/hierarchy.js +9 -12
- package/dist/lib/output/themes/default/partials/icon.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/icon.js +78 -73
- package/dist/lib/output/themes/default/partials/index.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/index.js +19 -22
- package/dist/lib/output/themes/default/partials/member.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.declaration.js +18 -61
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +10 -26
- package/dist/lib/output/themes/default/partials/member.js +19 -24
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signature.body.js +17 -21
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +4 -7
- package/dist/lib/output/themes/default/partials/member.signature.title.js +8 -35
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.signatures.js +9 -13
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/member.sources.js +13 -17
- package/dist/lib/output/themes/default/partials/members.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/members.js +10 -42
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +62 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/navigation.js +51 -62
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +12 -15
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +4 -4
- package/dist/lib/output/themes/default/partials/toolbar.js +16 -20
- package/dist/lib/output/themes/default/partials/type.d.ts +4 -6
- package/dist/lib/output/themes/default/partials/type.js +8 -388
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeAndParent.js +11 -15
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +221 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +3 -3
- package/dist/lib/output/themes/default/partials/typeParameters.js +14 -17
- package/dist/lib/output/themes/default/templates/document.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/document.js +3 -7
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/hierarchy.js +10 -13
- package/dist/lib/output/themes/default/templates/index.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/index.js +3 -7
- package/dist/lib/output/themes/default/templates/reflection.d.ts +4 -4
- package/dist/lib/output/themes/default/templates/reflection.js +31 -34
- package/dist/lib/output/themes/lib.d.ts +17 -3
- package/dist/lib/output/themes/lib.js +110 -49
- package/dist/lib/serialization/components.d.ts +2 -5
- package/dist/lib/serialization/components.js +1 -2
- package/dist/lib/serialization/deserializer.d.ts +21 -7
- package/dist/lib/serialization/deserializer.js +138 -123
- package/dist/lib/serialization/events.d.ts +2 -2
- package/dist/lib/serialization/events.js +6 -5
- package/dist/lib/serialization/index.d.ts +5 -5
- package/dist/lib/serialization/index.js +4 -33
- package/dist/lib/serialization/schema.d.ts +8 -2
- package/dist/lib/serialization/schema.js +2 -2
- package/dist/lib/serialization/serializer.d.ts +11 -5
- package/dist/lib/serialization/serializer.js +32 -25
- package/dist/lib/utils/array.d.ts +3 -0
- package/dist/lib/utils/array.js +26 -27
- package/dist/lib/utils/component.d.ts +2 -44
- package/dist/lib/utils/component.js +10 -102
- package/dist/lib/utils/entry-point.d.ts +3 -4
- package/dist/lib/utils/entry-point.js +114 -85
- package/dist/lib/utils/enum.js +6 -14
- package/dist/lib/utils/events.js +6 -12
- package/dist/lib/utils/fs.js +50 -91
- package/dist/lib/utils/general.d.ts +2 -1
- package/dist/lib/utils/general.js +50 -40
- package/dist/lib/utils/highlighter.js +30 -57
- package/dist/lib/utils/hooks.js +7 -13
- package/dist/lib/utils/html-entities.d.ts +8926 -0
- package/dist/lib/utils/html-entities.js +2329 -0
- package/dist/lib/utils/html.d.ts +8 -0
- package/dist/lib/utils/html.js +81 -34
- package/dist/lib/utils/index.d.ts +22 -22
- package/dist/lib/utils/index.js +20 -91
- package/dist/lib/utils/jsx.d.ts +12 -5
- package/dist/lib/utils/jsx.elements.js +1 -4
- package/dist/lib/utils/jsx.js +53 -20
- package/dist/lib/utils/loggers.d.ts +3 -3
- package/dist/lib/utils/loggers.js +36 -46
- package/dist/lib/utils/map.d.ts +1 -1
- package/dist/lib/utils/map.js +6 -13
- package/dist/lib/utils/minimalSourceFile.js +5 -7
- package/dist/lib/utils/options/declaration.d.ts +33 -7
- package/dist/lib/utils/options/declaration.js +20 -22
- package/dist/lib/utils/options/defaults.d.ts +3 -2
- package/dist/lib/utils/options/defaults.js +18 -38
- package/dist/lib/utils/options/help.d.ts +2 -2
- package/dist/lib/utils/options/help.js +7 -10
- package/dist/lib/utils/options/index.d.ts +6 -6
- package/dist/lib/utils/options/index.js +4 -18
- package/dist/lib/utils/options/options.d.ts +8 -5
- package/dist/lib/utils/options/options.js +47 -71
- package/dist/lib/utils/options/readers/arguments.d.ts +2 -2
- package/dist/lib/utils/options/readers/arguments.js +15 -17
- package/dist/lib/utils/options/readers/index.d.ts +4 -4
- package/dist/lib/utils/options/readers/index.js +4 -11
- package/dist/lib/utils/options/readers/package-json.d.ts +3 -3
- package/dist/lib/utils/options/readers/package-json.js +15 -21
- package/dist/lib/utils/options/readers/tsconfig.d.ts +2 -2
- package/dist/lib/utils/options/readers/tsconfig.js +54 -63
- package/dist/lib/utils/options/readers/typedoc.d.ts +3 -3
- package/dist/lib/utils/options/readers/typedoc.js +47 -90
- package/dist/lib/utils/options/sources/index.d.ts +1 -1
- package/dist/lib/utils/options/sources/index.js +1 -5
- package/dist/lib/utils/options/sources/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/sources/typedoc.js +220 -196
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +3 -3
- package/dist/lib/utils/options/tsdoc-defaults.js +16 -12
- package/dist/lib/utils/package-manifest.d.ts +1 -1
- package/dist/lib/utils/package-manifest.js +15 -19
- package/dist/lib/utils/paths.js +9 -15
- package/dist/lib/utils/perf.js +6 -11
- package/dist/lib/utils/plugins.d.ts +1 -1
- package/dist/lib/utils/plugins.js +16 -17
- package/dist/lib/utils/reflections.d.ts +1 -1
- package/dist/lib/utils/reflections.js +9 -12
- package/dist/lib/utils/set.js +2 -6
- package/dist/lib/utils/sort.d.ts +3 -3
- package/dist/lib/utils/sort.js +20 -24
- package/dist/lib/utils/tsconfig.d.ts +1 -1
- package/dist/lib/utils/tsconfig.js +13 -21
- package/dist/lib/utils/tsutils.d.ts +1 -1
- package/dist/lib/utils/tsutils.js +3 -30
- package/dist/lib/utils/validation.js +6 -12
- package/dist/lib/validation/documentation.d.ts +2 -2
- package/dist/lib/validation/documentation.js +26 -29
- package/dist/lib/validation/exports.d.ts +2 -2
- package/dist/lib/validation/exports.js +9 -11
- package/dist/lib/validation/links.d.ts +2 -2
- package/dist/lib/validation/links.js +4 -7
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +3 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +11 -0
- package/package.json +14 -11
- package/static/main.js +4 -4
- package/static/style.css +91 -2
- package/tsdoc.json +30 -0
- package/dist/lib/output/themes/default/partials/member.reference.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/member.reference.js +0 -30
- package/dist/lib/output/themes/default/partials/parameter.d.ts +0 -4
- package/dist/lib/output/themes/default/partials/parameter.js +0 -79
- package/dist/lib/utils/html-entities.json +0 -2326
|
@@ -1,9 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
exports.breadcrumb = void 0;
|
|
4
|
-
const utils_1 = require("../../../../utils");
|
|
5
|
-
const breadcrumb = (context, props) => props.parent ? (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
|
|
1
|
+
import { JSX } from "../../../../utils/index.js";
|
|
2
|
+
export const breadcrumb = (context, props) => props.parent ? (JSX.createElement(JSX.Fragment, null,
|
|
6
3
|
context.breadcrumb(props.parent),
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
exports.breadcrumb = breadcrumb;
|
|
4
|
+
JSX.createElement("li", null, props.url ? JSX.createElement("a", { href: context.urlTo(props) }, props.name) : JSX.createElement("span", null, props.name)))) : props.url ? (JSX.createElement("li", null,
|
|
5
|
+
JSX.createElement("a", { href: context.urlTo(props) }, props.name))) : undefined;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import { type Reflection } from "../../../../models";
|
|
4
|
-
export declare function
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import { type CommentDisplayPart, type Reflection } from "../../../../models/index.js";
|
|
4
|
+
export declare function renderDisplayParts({ markdown }: DefaultThemeRenderContext, parts: readonly CommentDisplayPart[] | undefined): JSX.Element | undefined;
|
|
5
|
+
export declare function commentShortSummary(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
|
|
6
|
+
export declare function commentSummary(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
|
|
5
7
|
export declare function commentTags(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
|
|
6
8
|
export declare function reflectionFlags(context: DefaultThemeRenderContext, props: Reflection): JSX.Element;
|
|
@@ -1,46 +1,69 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
exports.reflectionFlags = reflectionFlags;
|
|
6
|
-
const utils_1 = require("../../../../utils");
|
|
7
|
-
const models_1 = require("../../../../models");
|
|
8
|
-
const anchor_icon_1 = require("./anchor-icon");
|
|
9
|
-
const lib_1 = require("../../lib");
|
|
1
|
+
import { JSX, Raw } from "../../../../utils/index.js";
|
|
2
|
+
import { ReflectionKind } from "../../../../models/index.js";
|
|
3
|
+
import { anchorIcon } from "./anchor-icon.js";
|
|
4
|
+
import { join } from "../../lib.js";
|
|
10
5
|
// Note: Comment modifiers are handled in `renderFlags`
|
|
11
|
-
function
|
|
12
|
-
if (!
|
|
6
|
+
export function renderDisplayParts({ markdown }, parts) {
|
|
7
|
+
if (!parts?.length)
|
|
13
8
|
return;
|
|
14
|
-
return (
|
|
15
|
-
|
|
9
|
+
return (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
|
|
10
|
+
JSX.createElement(Raw, { html: markdown(parts) })));
|
|
16
11
|
}
|
|
17
|
-
function
|
|
12
|
+
export function commentShortSummary(context, props) {
|
|
13
|
+
let shortSummary;
|
|
14
|
+
if (props.isDocument()) {
|
|
15
|
+
if (typeof props.frontmatter["summary"] === "string") {
|
|
16
|
+
shortSummary = [{ kind: "text", text: props.frontmatter["summary"] }];
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
else {
|
|
20
|
+
shortSummary = props.comment?.getShortSummary(context.options.getValue("useFirstParagraphOfCommentAsSummary"));
|
|
21
|
+
}
|
|
22
|
+
if (!shortSummary?.some((part) => part.text))
|
|
23
|
+
return;
|
|
24
|
+
return context.displayParts(shortSummary);
|
|
25
|
+
}
|
|
26
|
+
export function commentSummary(context, props) {
|
|
27
|
+
if (props.comment?.summary.some((part) => part.text)) {
|
|
28
|
+
return context.displayParts(props.comment.summary);
|
|
29
|
+
}
|
|
30
|
+
const target = (props.isDeclaration() || props.isParameter()) && props.type?.type === "reference"
|
|
31
|
+
? props.type.reflection
|
|
32
|
+
: undefined;
|
|
33
|
+
if (target?.comment?.hasModifier("@expand") && target?.comment?.summary.some((part) => part.text)) {
|
|
34
|
+
return context.displayParts(target.comment.summary);
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
export function commentTags(context, props) {
|
|
18
38
|
if (!props.comment)
|
|
19
39
|
return;
|
|
40
|
+
const skipSave = props.comment.blockTags.map((tag) => tag.skipRendering);
|
|
41
|
+
const skippedTags = context.options.getValue("notRenderedTags");
|
|
20
42
|
const beforeTags = context.hook("comment.beforeTags", context, props.comment, props);
|
|
21
43
|
const afterTags = context.hook("comment.afterTags", context, props.comment, props);
|
|
22
|
-
const tags = props.kindOf(
|
|
23
|
-
? props.comment.blockTags.filter((tag) => tag.tag !== "@returns" && !tag.skipRendering)
|
|
24
|
-
: props.comment.blockTags.filter((tag) => !tag.skipRendering);
|
|
25
|
-
|
|
44
|
+
const tags = props.kindOf(ReflectionKind.SomeSignature)
|
|
45
|
+
? props.comment.blockTags.filter((tag) => tag.tag !== "@returns" && !tag.skipRendering && !skippedTags.includes(tag.tag))
|
|
46
|
+
: props.comment.blockTags.filter((tag) => !tag.skipRendering && !skippedTags.includes(tag.tag));
|
|
47
|
+
skipSave.forEach((skip, i) => (props.comment.blockTags[i].skipRendering = skip));
|
|
48
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
26
49
|
beforeTags,
|
|
27
|
-
|
|
50
|
+
JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => {
|
|
28
51
|
const name = item.name
|
|
29
52
|
? `${context.internationalization.translateTagName(item.tag)}: ${item.name}`
|
|
30
53
|
: context.internationalization.translateTagName(item.tag);
|
|
31
|
-
const anchor =
|
|
32
|
-
return (
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
54
|
+
const anchor = context.slugger.slug(name);
|
|
55
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
56
|
+
JSX.createElement("div", { class: `tsd-tag-${name}` },
|
|
57
|
+
JSX.createElement("h4", { class: "tsd-anchor-link" },
|
|
58
|
+
JSX.createElement("a", { id: anchor, class: "tsd-anchor" }),
|
|
36
59
|
name,
|
|
37
|
-
|
|
38
|
-
|
|
60
|
+
anchorIcon(context, anchor)),
|
|
61
|
+
JSX.createElement(Raw, { html: context.markdown(item.content) }))));
|
|
39
62
|
})),
|
|
40
63
|
afterTags));
|
|
41
64
|
}
|
|
42
|
-
|
|
43
|
-
|
|
65
|
+
export function reflectionFlags(context, props) {
|
|
66
|
+
const flagsNotRendered = context.options.getValue("notRenderedTags");
|
|
44
67
|
const allFlags = props.flags.getFlagStrings(context.internationalization);
|
|
45
68
|
if (props.comment) {
|
|
46
69
|
for (const tag of props.comment.modifierTags) {
|
|
@@ -49,5 +72,5 @@ function reflectionFlags(context, props) {
|
|
|
49
72
|
}
|
|
50
73
|
}
|
|
51
74
|
}
|
|
52
|
-
return
|
|
75
|
+
return join(" ", allFlags, (item) => JSX.createElement("code", { class: "tsd-tag" }, item));
|
|
53
76
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { JSX } from "../../../../utils";
|
|
2
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
1
|
+
import { JSX } from "../../../../utils/index.js";
|
|
2
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
3
3
|
export declare function footer(context: DefaultThemeRenderContext): JSX.Element;
|
|
@@ -1,38 +1,35 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
exports.footer = footer;
|
|
4
|
-
const utils_1 = require("../../../../utils");
|
|
5
|
-
function footer(context) {
|
|
1
|
+
import { JSX } from "../../../../utils/index.js";
|
|
2
|
+
export function footer(context) {
|
|
6
3
|
const hideGenerator = context.options.getValue("hideGenerator");
|
|
7
|
-
let generatorDisplay =
|
|
4
|
+
let generatorDisplay = JSX.createElement(JSX.Fragment, null);
|
|
8
5
|
if (!hideGenerator) {
|
|
9
6
|
const message = context.i18n.theme_generated_using_typedoc();
|
|
10
7
|
// Only handles one occurrence, but that's all I expect...
|
|
11
8
|
const index = message.indexOf("TypeDoc");
|
|
12
9
|
if (index == -1) {
|
|
13
|
-
generatorDisplay =
|
|
10
|
+
generatorDisplay = JSX.createElement("p", { class: "tsd-generator" }, message);
|
|
14
11
|
}
|
|
15
12
|
else {
|
|
16
13
|
const pre = message.substring(0, index);
|
|
17
14
|
const post = message.substring(index + "TypeDoc".length);
|
|
18
|
-
generatorDisplay = (
|
|
15
|
+
generatorDisplay = (JSX.createElement("p", { class: "tsd-generator" },
|
|
19
16
|
pre,
|
|
20
|
-
|
|
17
|
+
JSX.createElement("a", { href: "https://typedoc.org/", target: "_blank" }, "TypeDoc"),
|
|
21
18
|
post));
|
|
22
19
|
}
|
|
23
20
|
}
|
|
24
21
|
const customFooterHtml = context.options.getValue("customFooterHtml");
|
|
25
|
-
let customFooterDisplay =
|
|
22
|
+
let customFooterDisplay = JSX.createElement(JSX.Fragment, null);
|
|
26
23
|
if (customFooterHtml) {
|
|
27
24
|
if (context.options.getValue("customFooterHtmlDisableWrapper")) {
|
|
28
|
-
customFooterDisplay =
|
|
25
|
+
customFooterDisplay = JSX.createElement(JSX.Raw, { html: customFooterHtml });
|
|
29
26
|
}
|
|
30
27
|
else {
|
|
31
|
-
customFooterDisplay = (
|
|
32
|
-
|
|
28
|
+
customFooterDisplay = (JSX.createElement("p", null,
|
|
29
|
+
JSX.createElement(JSX.Raw, { html: customFooterHtml })));
|
|
33
30
|
}
|
|
34
31
|
}
|
|
35
|
-
return (
|
|
32
|
+
return (JSX.createElement("footer", null,
|
|
36
33
|
context.hook("footer.begin", context),
|
|
37
34
|
generatorDisplay,
|
|
38
35
|
customFooterDisplay,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { JSX } from "../../../../utils";
|
|
2
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
3
|
-
import type { PageEvent } from "../../../events";
|
|
4
|
-
import type { Reflection } from "../../../../models";
|
|
1
|
+
import { JSX } from "../../../../utils/index.js";
|
|
2
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
3
|
+
import type { PageEvent } from "../../../events.js";
|
|
4
|
+
import type { Reflection } from "../../../../models/index.js";
|
|
5
5
|
export declare const header: (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => JSX.Element;
|
|
@@ -1,9 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
const lib_1 = require("../../lib");
|
|
5
|
-
const utils_1 = require("../../../../utils");
|
|
6
|
-
const header = (context, props) => {
|
|
1
|
+
import { classNames, getDisplayName, hasTypeParameters, join } from "../../lib.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
export const header = (context, props) => {
|
|
7
4
|
const opts = context.options.getValue("headings");
|
|
8
5
|
// Don't render on the index page or the class hierarchy page
|
|
9
6
|
// We should probably someday render on the class hierarchy page, but currently breadcrumbs
|
|
@@ -28,15 +25,14 @@ const header = (context, props) => {
|
|
|
28
25
|
renderTitle = true;
|
|
29
26
|
titleKindString = context.internationalization.kindSingularString(props.model.kind) + " ";
|
|
30
27
|
}
|
|
31
|
-
return (
|
|
32
|
-
renderBreadcrumbs &&
|
|
33
|
-
renderTitle && (
|
|
28
|
+
return (JSX.createElement("div", { class: "tsd-page-title" },
|
|
29
|
+
renderBreadcrumbs && JSX.createElement("ul", { class: "tsd-breadcrumb" }, context.breadcrumb(props.model)),
|
|
30
|
+
renderTitle && (JSX.createElement("h1", { class: classNames({ deprecated: props.model.isDeprecated() }) },
|
|
34
31
|
titleKindString,
|
|
35
|
-
|
|
36
|
-
|
|
32
|
+
getDisplayName(props.model),
|
|
33
|
+
hasTypeParameters(props.model) && (JSX.createElement(JSX.Fragment, null,
|
|
37
34
|
"<",
|
|
38
|
-
|
|
35
|
+
join(", ", props.model.typeParameters, (item) => item.name),
|
|
39
36
|
">")),
|
|
40
37
|
context.reflectionFlags(props.model)))));
|
|
41
38
|
};
|
|
42
|
-
exports.header = header;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import type { DeclarationHierarchy } from "../../../../models";
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import type { DeclarationHierarchy } from "../../../../models/index.js";
|
|
4
4
|
export declare function hierarchy(context: DefaultThemeRenderContext, props: DeclarationHierarchy | undefined): JSX.Element | undefined;
|
|
@@ -1,7 +1,4 @@
|
|
|
1
|
-
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.hierarchy = hierarchy;
|
|
4
|
-
const utils_1 = require("../../../../utils");
|
|
1
|
+
import { JSX } from "../../../../utils/index.js";
|
|
5
2
|
const isLinkedReferenceType = (type) => type.visit({
|
|
6
3
|
reference: (ref) => ref.reflection !== undefined,
|
|
7
4
|
}) ?? false;
|
|
@@ -12,22 +9,22 @@ function hasAnyLinkedReferenceType(h) {
|
|
|
12
9
|
return true;
|
|
13
10
|
return hasAnyLinkedReferenceType(h.next);
|
|
14
11
|
}
|
|
15
|
-
function hierarchy(context, props) {
|
|
12
|
+
export function hierarchy(context, props) {
|
|
16
13
|
if (!props)
|
|
17
14
|
return;
|
|
18
|
-
const fullLink = hasAnyLinkedReferenceType(props) ? (
|
|
15
|
+
const fullLink = hasAnyLinkedReferenceType(props) ? (JSX.createElement(JSX.Fragment, null,
|
|
19
16
|
" ",
|
|
20
17
|
"(",
|
|
21
|
-
|
|
22
|
-
")")) : (
|
|
23
|
-
return (
|
|
24
|
-
|
|
18
|
+
JSX.createElement("a", { href: context.relativeURL("hierarchy.html") + "#" + context.page.model.getFullName() }, context.i18n.theme_hierarchy_view_full()),
|
|
19
|
+
")")) : (JSX.createElement(JSX.Fragment, null));
|
|
20
|
+
return (JSX.createElement("section", { class: "tsd-panel tsd-hierarchy" },
|
|
21
|
+
JSX.createElement("h4", null,
|
|
25
22
|
context.i18n.theme_hierarchy(),
|
|
26
23
|
fullLink),
|
|
27
24
|
hierarchyList(context, props)));
|
|
28
25
|
}
|
|
29
26
|
function hierarchyList(context, props) {
|
|
30
|
-
return (
|
|
31
|
-
props.isTarget ?
|
|
27
|
+
return (JSX.createElement("ul", { class: "tsd-hierarchy" }, props.types.map((item, i, l) => (JSX.createElement("li", null,
|
|
28
|
+
props.isTarget ? JSX.createElement("span", { class: "target" }, item.toString()) : context.type(item),
|
|
32
29
|
i === l.length - 1 && !!props.next && hierarchyList(context, props.next))))));
|
|
33
30
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ReflectionKind } from "../../../../models";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
1
|
+
import { ReflectionKind } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
4
4
|
export declare function buildRefIcons<T extends Record<string, () => JSX.Element>>(icons: T, context: DefaultThemeRenderContext): T;
|
|
5
|
-
export declare const icons: Record<ReflectionKind | "chevronDown" | "checkbox" | "menu" | "search" | "chevronSmall" | "anchor" | "folder", () => JSX.Element>;
|
|
5
|
+
export declare const icons: Record<ReflectionKind | "chevronDown" | "checkbox" | "menu" | "search" | "chevronSmall" | "anchor" | "folder" | "alertNote" | "alertTip" | "alertImportant" | "alertWarning" | "alertCaution", () => JSX.Element>;
|
|
@@ -1,98 +1,103 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
};
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
const assert_1 = __importDefault(require("assert"));
|
|
9
|
-
const models_1 = require("../../../../models");
|
|
10
|
-
const utils_1 = require("../../../../utils");
|
|
11
|
-
const kindIcon = (letterPath, color, circular = false) => (utils_1.JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24" },
|
|
12
|
-
utils_1.JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
|
|
1
|
+
// The alert icons in this file were taken from https://github.com/primer/octicons
|
|
2
|
+
// which is under a MIT license https://github.com/primer/octicons/blob/main/LICENSE
|
|
3
|
+
import assert from "assert";
|
|
4
|
+
import { ReflectionKind } from "../../../../models/index.js";
|
|
5
|
+
import { JSX } from "../../../../utils/index.js";
|
|
6
|
+
const kindIcon = (letterPath, color, circular = false) => (JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24" },
|
|
7
|
+
JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
|
|
13
8
|
letterPath));
|
|
14
|
-
const textIcon = (letter, color, circular = false) => kindIcon(
|
|
15
|
-
function buildRefIcons(icons, context) {
|
|
9
|
+
const textIcon = (letter, color, circular = false) => kindIcon(JSX.createElement("text", { fill: "var(--color-icon-text)", x: "50%", y: "50%", "dominant-baseline": "central", "text-anchor": "middle" }, letter), color, circular);
|
|
10
|
+
export function buildRefIcons(icons, context) {
|
|
16
11
|
const refs = {};
|
|
17
12
|
for (const [name, builder] of Object.entries(icons)) {
|
|
18
13
|
const jsx = builder.call(icons);
|
|
19
|
-
(
|
|
14
|
+
assert(jsx.tag === "svg", "TypeDoc's frontend assumes that icons are written as svg elements");
|
|
20
15
|
// This one cannot be cached because the CSS selector depends on targeting SVG elements
|
|
21
16
|
// within it. Ick. Surely there's a nicer way?
|
|
22
17
|
if (name === "checkbox") {
|
|
23
18
|
refs[name] = () => jsx;
|
|
24
19
|
continue;
|
|
25
20
|
}
|
|
26
|
-
const ref = (
|
|
27
|
-
|
|
21
|
+
const ref = (JSX.createElement("svg", { ...jsx.props, id: undefined },
|
|
22
|
+
JSX.createElement("use", { href: `${context.relativeURL("assets/icons.svg")}#icon-${name}` })));
|
|
28
23
|
refs[name] = () => ref;
|
|
29
24
|
}
|
|
30
25
|
return refs;
|
|
31
26
|
}
|
|
32
|
-
|
|
33
|
-
[
|
|
34
|
-
[
|
|
35
|
-
return this[
|
|
27
|
+
export const icons = {
|
|
28
|
+
[ReflectionKind.Accessor]: () => textIcon("A", "var(--color-ts-accessor)", true),
|
|
29
|
+
[ReflectionKind.CallSignature]() {
|
|
30
|
+
return this[ReflectionKind.Function]();
|
|
36
31
|
},
|
|
37
|
-
[
|
|
38
|
-
[
|
|
39
|
-
[
|
|
40
|
-
return this[
|
|
32
|
+
[ReflectionKind.Class]: () => textIcon("C", "var(--color-ts-class)"),
|
|
33
|
+
[ReflectionKind.Constructor]: () => textIcon("C", "var(--color-ts-constructor)", true),
|
|
34
|
+
[ReflectionKind.ConstructorSignature]() {
|
|
35
|
+
return this[ReflectionKind.Constructor]();
|
|
41
36
|
},
|
|
42
|
-
[
|
|
43
|
-
[
|
|
44
|
-
return this[
|
|
37
|
+
[ReflectionKind.Enum]: () => textIcon("E", "var(--color-ts-enum)"),
|
|
38
|
+
[ReflectionKind.EnumMember]() {
|
|
39
|
+
return this[ReflectionKind.Property]();
|
|
45
40
|
},
|
|
46
|
-
[
|
|
47
|
-
[
|
|
48
|
-
return this[
|
|
41
|
+
[ReflectionKind.Function]: () => textIcon("F", "var(--color-ts-function)"),
|
|
42
|
+
[ReflectionKind.GetSignature]() {
|
|
43
|
+
return this[ReflectionKind.Accessor]();
|
|
49
44
|
},
|
|
50
|
-
[
|
|
51
|
-
return this[
|
|
45
|
+
[ReflectionKind.IndexSignature]() {
|
|
46
|
+
return this[ReflectionKind.Property]();
|
|
52
47
|
},
|
|
53
|
-
[
|
|
54
|
-
[
|
|
55
|
-
[
|
|
56
|
-
[
|
|
57
|
-
[
|
|
58
|
-
return this[
|
|
48
|
+
[ReflectionKind.Interface]: () => textIcon("I", "var(--color-ts-interface)"),
|
|
49
|
+
[ReflectionKind.Method]: () => textIcon("M", "var(--color-ts-method)", true),
|
|
50
|
+
[ReflectionKind.Module]: () => textIcon("M", "var(--color-ts-module)"),
|
|
51
|
+
[ReflectionKind.Namespace]: () => textIcon("N", "var(--color-ts-namespace)"),
|
|
52
|
+
[ReflectionKind.Parameter]() {
|
|
53
|
+
return this[ReflectionKind.Property]();
|
|
59
54
|
},
|
|
60
|
-
[
|
|
61
|
-
return this[
|
|
55
|
+
[ReflectionKind.Project]() {
|
|
56
|
+
return this[ReflectionKind.Module]();
|
|
62
57
|
},
|
|
63
|
-
[
|
|
64
|
-
[
|
|
65
|
-
[
|
|
66
|
-
return this[
|
|
58
|
+
[ReflectionKind.Property]: () => textIcon("P", "var(--color-ts-property)", true),
|
|
59
|
+
[ReflectionKind.Reference]: () => textIcon("R", "var(--color-ts-reference)", true),
|
|
60
|
+
[ReflectionKind.SetSignature]() {
|
|
61
|
+
return this[ReflectionKind.Accessor]();
|
|
67
62
|
},
|
|
68
|
-
[
|
|
69
|
-
[
|
|
70
|
-
return this[
|
|
63
|
+
[ReflectionKind.TypeAlias]: () => textIcon("T", "var(--color-ts-type-alias)"),
|
|
64
|
+
[ReflectionKind.TypeLiteral]() {
|
|
65
|
+
return this[ReflectionKind.TypeAlias]();
|
|
71
66
|
},
|
|
72
|
-
[
|
|
73
|
-
return this[
|
|
67
|
+
[ReflectionKind.TypeParameter]() {
|
|
68
|
+
return this[ReflectionKind.TypeAlias]();
|
|
74
69
|
},
|
|
75
|
-
[
|
|
76
|
-
[
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
folder: () => kindIcon(
|
|
82
|
-
|
|
83
|
-
chevronDown: () => (
|
|
84
|
-
|
|
85
|
-
chevronSmall: () => (
|
|
86
|
-
|
|
87
|
-
checkbox: () => (
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
menu: () => (
|
|
91
|
-
search: () => (
|
|
92
|
-
|
|
93
|
-
anchor: () => (
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
70
|
+
[ReflectionKind.Variable]: () => textIcon("V", "var(--color-ts-variable)"),
|
|
71
|
+
[ReflectionKind.Document]: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
|
|
72
|
+
JSX.createElement("polygon", { points: "6,5 6,19 18,19, 18,10 13,5" }),
|
|
73
|
+
JSX.createElement("line", { x1: "9", y1: "9", x2: "13", y2: "9" }),
|
|
74
|
+
JSX.createElement("line", { x1: "9", y1: "12", x2: "15", y2: "12" }),
|
|
75
|
+
JSX.createElement("line", { x1: "9", y1: "15", x2: "15", y2: "15" })), "var(--color-document)"),
|
|
76
|
+
folder: () => kindIcon(JSX.createElement("g", { stroke: "var(--color-icon-text)", fill: "none", "stroke-width": "1.5" },
|
|
77
|
+
JSX.createElement("polygon", { points: "5,5 10,5 12,8 19,8 19,18 5,18" })), "var(--color-document)"),
|
|
78
|
+
chevronDown: () => (JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" },
|
|
79
|
+
JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-icon-text)" }))),
|
|
80
|
+
chevronSmall: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
|
|
81
|
+
JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-icon-text)" }))),
|
|
82
|
+
checkbox: () => (JSX.createElement("svg", { width: "32", height: "32", viewBox: "0 0 32 32", "aria-hidden": "true" },
|
|
83
|
+
JSX.createElement("rect", { class: "tsd-checkbox-background", width: "30", height: "30", x: "1", y: "1", rx: "6", fill: "none" }),
|
|
84
|
+
JSX.createElement("path", { class: "tsd-checkbox-checkmark", d: "M8.35422 16.8214L13.2143 21.75L24.6458 10.25", stroke: "none", "stroke-width": "3.5", "stroke-linejoin": "round", fill: "none" }))),
|
|
85
|
+
menu: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" }, ["3", "7", "11"].map((y) => (JSX.createElement("rect", { x: "1", y: y, width: "14", height: "2", fill: "var(--color-icon-text)" }))))),
|
|
86
|
+
search: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
|
|
87
|
+
JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-icon-text)" }))),
|
|
88
|
+
anchor: () => (JSX.createElement("svg", { viewBox: "0 0 24 24" },
|
|
89
|
+
JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
|
|
90
|
+
JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
|
|
91
|
+
JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
|
|
92
|
+
JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
|
|
93
|
+
alertNote: () => (JSX.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", width: "16", height: "16", viewBox: "0 0 16 16" },
|
|
94
|
+
JSX.createElement("path", { fill: "var(--color-alert-note)", d: "M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
|
|
95
|
+
alertTip: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
|
|
96
|
+
JSX.createElement("path", { fill: "var(--color-alert-tip)", d: "M8 1.5c-2.363 0-4 1.69-4 3.75 0 .984.424 1.625.984 2.304l.214.253c.223.264.47.556.673.848.284.411.537.896.621 1.49a.75.75 0 0 1-1.484.211c-.04-.282-.163-.547-.37-.847a8.456 8.456 0 0 0-.542-.68c-.084-.1-.173-.205-.268-.32C3.201 7.75 2.5 6.766 2.5 5.25 2.5 2.31 4.863 0 8 0s5.5 2.31 5.5 5.25c0 1.516-.701 2.5-1.328 3.259-.095.115-.184.22-.268.319-.207.245-.383.453-.541.681-.208.3-.33.565-.37.847a.751.751 0 0 1-1.485-.212c.084-.593.337-1.078.621-1.489.203-.292.45-.584.673-.848.075-.088.147-.173.213-.253.561-.679.985-1.32.985-2.304 0-2.06-1.637-3.75-4-3.75ZM5.75 12h4.5a.75.75 0 0 1 0 1.5h-4.5a.75.75 0 0 1 0-1.5ZM6 15.25a.75.75 0 0 1 .75-.75h2.5a.75.75 0 0 1 0 1.5h-2.5a.75.75 0 0 1-.75-.75Z" }))),
|
|
97
|
+
alertImportant: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
|
|
98
|
+
JSX.createElement("path", { fill: "var(--color-alert-important)", d: "M0 1.75C0 .784.784 0 1.75 0h12.5C15.216 0 16 .784 16 1.75v9.5A1.75 1.75 0 0 1 14.25 13H8.06l-2.573 2.573A1.458 1.458 0 0 1 3 14.543V13H1.75A1.75 1.75 0 0 1 0 11.25Zm1.75-.25a.25.25 0 0 0-.25.25v9.5c0 .138.112.25.25.25h2a.75.75 0 0 1 .75.75v2.19l2.72-2.72a.749.749 0 0 1 .53-.22h6.5a.25.25 0 0 0 .25-.25v-9.5a.25.25 0 0 0-.25-.25Zm7 2.25v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 9a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
|
|
99
|
+
alertWarning: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
|
|
100
|
+
JSX.createElement("path", { fill: "var(--color-alert-warning)", d: "M6.457 1.047c.659-1.234 2.427-1.234 3.086 0l6.082 11.378A1.75 1.75 0 0 1 14.082 15H1.918a1.75 1.75 0 0 1-1.543-2.575Zm1.763.707a.25.25 0 0 0-.44 0L1.698 13.132a.25.25 0 0 0 .22.368h12.164a.25.25 0 0 0 .22-.368Zm.53 3.996v2.5a.75.75 0 0 1-1.5 0v-2.5a.75.75 0 0 1 1.5 0ZM9 11a1 1 0 1 1-2 0 1 1 0 0 1 2 0Z" }))),
|
|
101
|
+
alertCaution: () => (JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16" },
|
|
102
|
+
JSX.createElement("path", { fill: "var(--color-alert-caution)", d: "M4.47.22A.749.749 0 0 1 5 0h6c.199 0 .389.079.53.22l4.25 4.25c.141.14.22.331.22.53v6a.749.749 0 0 1-.22.53l-4.25 4.25A.749.749 0 0 1 11 16H5a.749.749 0 0 1-.53-.22L.22 11.53A.749.749 0 0 1 0 11V5c0-.199.079-.389.22-.53Zm.84 1.28L1.5 5.31v5.38l3.81 3.81h5.38l3.81-3.81V5.31L10.69 1.5ZM8 4a.75.75 0 0 1 .75.75v3.5a.75.75 0 0 1-1.5 0v-3.5A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z" }))),
|
|
98
103
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import type { ContainerReflection } from "../../../../models";
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import type { ContainerReflection } from "../../../../models/index.js";
|
|
4
4
|
export declare function index(context: DefaultThemeRenderContext, props: ContainerReflection): JSX.Element;
|
|
@@ -1,20 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
exports.index = index;
|
|
4
|
-
const lib_1 = require("../../lib");
|
|
5
|
-
const utils_1 = require("../../../../utils");
|
|
1
|
+
import { classNames, renderName } from "../../lib.js";
|
|
2
|
+
import { JSX, Raw } from "../../../../utils/index.js";
|
|
6
3
|
function renderCategory({ urlTo, icons, getReflectionClasses, markdown }, item, prependName = "") {
|
|
7
|
-
return (
|
|
8
|
-
|
|
9
|
-
item.description && (
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
4
|
+
return (JSX.createElement("section", { class: "tsd-index-section" },
|
|
5
|
+
JSX.createElement("h3", { class: "tsd-index-heading" }, prependName ? `${prependName} - ${item.title}` : item.title),
|
|
6
|
+
item.description && (JSX.createElement("div", { class: "tsd-comment tsd-typography" },
|
|
7
|
+
JSX.createElement(Raw, { html: markdown(item.description) }))),
|
|
8
|
+
JSX.createElement("div", { class: "tsd-index-list" }, item.children.map((item) => (JSX.createElement(JSX.Fragment, null,
|
|
9
|
+
JSX.createElement("a", { href: urlTo(item), class: classNames({ "tsd-index-link": true, deprecated: item.isDeprecated() }, getReflectionClasses(item)) },
|
|
13
10
|
icons[item.kind](),
|
|
14
|
-
|
|
11
|
+
JSX.createElement("span", null, renderName(item))),
|
|
15
12
|
"\n"))))));
|
|
16
13
|
}
|
|
17
|
-
function index(context, props) {
|
|
14
|
+
export function index(context, props) {
|
|
18
15
|
let content = [];
|
|
19
16
|
if (props.categories?.length) {
|
|
20
17
|
content = props.categories.map((item) => renderCategory(context, item));
|
|
@@ -26,20 +23,20 @@ function index(context, props) {
|
|
|
26
23
|
}
|
|
27
24
|
// Accordion is only needed if any children don't have their own document.
|
|
28
25
|
if ([...(props.groups ?? []), ...(props.categories ?? [])].some((category) => !category.allChildrenHaveOwnDocument())) {
|
|
29
|
-
content = (
|
|
30
|
-
|
|
31
|
-
|
|
26
|
+
content = (JSX.createElement("details", { class: "tsd-index-content tsd-accordion", open: true },
|
|
27
|
+
JSX.createElement("summary", { class: "tsd-accordion-summary tsd-index-summary" },
|
|
28
|
+
JSX.createElement("h5", { class: "tsd-index-heading uppercase", role: "button", "aria-expanded": "false", tabIndex: 0 },
|
|
32
29
|
context.icons.chevronSmall(),
|
|
33
30
|
" ",
|
|
34
31
|
context.i18n.theme_index())),
|
|
35
|
-
|
|
32
|
+
JSX.createElement("div", { class: "tsd-accordion-details" }, content)));
|
|
36
33
|
}
|
|
37
34
|
else {
|
|
38
|
-
content = (
|
|
39
|
-
|
|
35
|
+
content = (JSX.createElement(JSX.Fragment, null,
|
|
36
|
+
JSX.createElement("h3", { class: "tsd-index-heading uppercase" }, context.i18n.theme_index()),
|
|
40
37
|
content));
|
|
41
38
|
}
|
|
42
|
-
return (
|
|
43
|
-
|
|
44
|
-
|
|
39
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
40
|
+
JSX.createElement("section", { class: "tsd-panel-group tsd-index-group" },
|
|
41
|
+
JSX.createElement("section", { class: "tsd-panel tsd-index-panel" }, content))));
|
|
45
42
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import { type DeclarationReflection, type DocumentReflection } from "../../../../models";
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import { type DeclarationReflection, type DocumentReflection } from "../../../../models/index.js";
|
|
4
4
|
export declare function member(context: DefaultThemeRenderContext, props: DeclarationReflection | DocumentReflection): JSX.Element;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { DeclarationReflection } from "../../../../models";
|
|
2
|
-
import { JSX } from "../../../../utils";
|
|
3
|
-
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
|
|
1
|
+
import type { DeclarationReflection } from "../../../../models/index.js";
|
|
2
|
+
import { JSX } from "../../../../utils/index.js";
|
|
3
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
4
4
|
export declare function memberDeclaration(context: DefaultThemeRenderContext, props: DeclarationReflection): JSX.Element;
|