@apify/docusaurus-plugin-typedoc-api 3.0.1 → 4.2.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/README.md +27 -5
- package/lib/components/AnchorLink.js +15 -10
- package/lib/components/AnchorLink.js.map +1 -1
- package/lib/components/ApiChangelog.js +9 -11
- package/lib/components/ApiChangelog.js.map +1 -1
- package/lib/components/ApiDataContext.js +2 -2
- package/lib/components/ApiIndex.js +55 -37
- package/lib/components/ApiIndex.js.map +1 -1
- package/lib/components/ApiItem.js +33 -29
- package/lib/components/ApiItem.js.map +1 -1
- package/lib/components/ApiItemLayout.js +49 -27
- package/lib/components/ApiItemLayout.js.map +1 -1
- package/lib/components/ApiPage.js +18 -10
- package/lib/components/ApiPage.js.map +1 -1
- package/lib/components/Breadcrumb.js +27 -14
- package/lib/components/Breadcrumb.js.map +1 -1
- package/lib/components/Comment.js +24 -18
- package/lib/components/Comment.js.map +1 -1
- package/lib/components/CommentBadges.js +8 -11
- package/lib/components/CommentBadges.js.map +1 -1
- package/lib/components/DefaultValue.js +20 -20
- package/lib/components/DefaultValue.js.map +1 -1
- package/lib/components/Flags.js +9 -11
- package/lib/components/Flags.js.map +1 -1
- package/lib/components/Footer.js +11 -12
- package/lib/components/Footer.js.map +1 -1
- package/lib/components/Hierarchy.js +15 -16
- package/lib/components/Hierarchy.js.map +1 -1
- package/lib/components/Icon.js +2 -6
- package/lib/components/Icon.js.map +1 -1
- package/lib/components/Index.js +84 -62
- package/lib/components/Index.js.map +1 -1
- package/lib/components/Markdown.js +80 -66
- package/lib/components/Markdown.js.map +1 -1
- package/lib/components/Member.js +28 -28
- package/lib/components/Member.js.map +1 -1
- package/lib/components/MemberDeclaration.js +51 -42
- package/lib/components/MemberDeclaration.js.map +1 -1
- package/lib/components/MemberGetterSetter.js +50 -40
- package/lib/components/MemberGetterSetter.js.map +1 -1
- package/lib/components/MemberReference.js +27 -16
- package/lib/components/MemberReference.js.map +1 -1
- package/lib/components/MemberSignatureBody.js +57 -45
- package/lib/components/MemberSignatureBody.js.map +1 -1
- package/lib/components/MemberSignatureTitle.js +48 -27
- package/lib/components/MemberSignatureTitle.js.map +1 -1
- package/lib/components/MemberSignatures.js +46 -38
- package/lib/components/MemberSignatures.js.map +1 -1
- package/lib/components/MemberSources.js +18 -15
- package/lib/components/MemberSources.js.map +1 -1
- package/lib/components/Members.js +32 -31
- package/lib/components/Members.js.map +1 -1
- package/lib/components/MembersGroup.js +24 -22
- package/lib/components/MembersGroup.js.map +1 -1
- package/lib/components/Parameter.js +139 -109
- package/lib/components/Parameter.js.map +1 -1
- package/lib/components/Reflection.js +113 -90
- package/lib/components/Reflection.js.map +1 -1
- package/lib/components/SourceLink.js +12 -13
- package/lib/components/SourceLink.js.map +1 -1
- package/lib/components/Type.js +320 -206
- package/lib/components/Type.js.map +1 -1
- package/lib/components/TypeAndParent.js +11 -10
- package/lib/components/TypeAndParent.js.map +1 -1
- package/lib/components/TypeParameters.js +23 -20
- package/lib/components/TypeParameters.js.map +1 -1
- package/lib/components/TypeParametersGeneric.js +17 -16
- package/lib/components/TypeParametersGeneric.js.map +1 -1
- package/lib/components/VersionBanner.js +21 -9
- package/lib/components/VersionBanner.js.map +1 -1
- package/lib/hooks/useBreadcrumbs.js +2 -2
- package/lib/hooks/useGitRefName.js +2 -2
- package/lib/hooks/useMinimalLayout.js +2 -2
- package/lib/hooks/useReflection.js +10 -6
- package/lib/hooks/useReflection.js.map +1 -1
- package/lib/hooks/useReflectionMap.js +2 -2
- package/lib/index.js +62 -25
- package/lib/index.js.map +1 -1
- package/lib/plugin/data.js +61 -18
- package/lib/plugin/data.js.map +1 -1
- package/lib/plugin/version.js +5 -4
- package/lib/plugin/version.js.map +1 -1
- package/lib/utils/helpers.js +8 -0
- package/lib/utils/helpers.js.map +1 -0
- package/lib/utils/hierarchy.js +6 -3
- package/lib/utils/hierarchy.js.map +1 -1
- package/lib/utils/icons.js +2 -5
- package/lib/utils/icons.js.map +1 -1
- package/lib/utils/markdown.js +5 -7
- package/lib/utils/markdown.js.map +1 -1
- package/package.json +17 -14
- package/src/components/AnchorLink.tsx +6 -3
- package/src/components/ApiChangelog.tsx +0 -1
- package/src/components/ApiDataContext.ts +2 -2
- package/src/components/ApiIndex.tsx +1 -1
- package/src/components/ApiItem.tsx +18 -20
- package/src/components/ApiItemLayout.tsx +1 -2
- package/src/components/ApiPage.tsx +18 -13
- package/src/components/Breadcrumb.tsx +2 -3
- package/src/components/Comment.tsx +3 -4
- package/src/components/CommentBadges.tsx +0 -1
- package/src/components/DefaultValue.tsx +0 -1
- package/src/components/Flags.tsx +1 -1
- package/src/components/Footer.tsx +0 -2
- package/src/components/Hierarchy.tsx +0 -1
- package/src/components/Icon.tsx +2 -3
- package/src/components/Index.tsx +14 -19
- package/src/components/Markdown.tsx +54 -25
- package/src/components/Member.tsx +7 -6
- package/src/components/MemberDeclaration.tsx +7 -7
- package/src/components/MemberGetterSetter.tsx +6 -6
- package/src/components/MemberReference.tsx +4 -4
- package/src/components/MemberSignatureBody.tsx +5 -5
- package/src/components/MemberSignatureTitle.tsx +11 -9
- package/src/components/MemberSignatures.tsx +5 -5
- package/src/components/MemberSources.tsx +3 -5
- package/src/components/Members.tsx +3 -4
- package/src/components/MembersGroup.tsx +1 -2
- package/src/components/Parameter.tsx +7 -12
- package/src/components/README.md +1 -1
- package/src/components/Reflection.tsx +7 -10
- package/src/components/SourceLink.tsx +0 -2
- package/src/components/Type.tsx +34 -22
- package/src/components/TypeAndParent.tsx +0 -1
- package/src/components/TypeParameters.tsx +0 -1
- package/src/components/TypeParametersGeneric.tsx +3 -3
- package/src/components/VersionBanner.tsx +1 -1
- package/src/hooks/useReflection.ts +11 -4
- package/src/hooks/useReflectionMap.ts +2 -2
- package/src/index.ts +92 -39
- package/src/plugin/data.ts +123 -54
- package/src/plugin/sidebar.ts +4 -3
- package/src/types.ts +24 -33
- package/src/utils/helpers.ts +4 -0
- package/src/utils/hierarchy.ts +11 -7
- package/src/utils/icons.ts +2 -3
- package/src/utils/markdown.ts +10 -7
- package/src/utils/visibility.ts +4 -4
package/README.md
CHANGED
|
@@ -13,8 +13,8 @@ package's entry point), so any private, protected, or internal code will not be
|
|
|
13
13
|
## Requirements
|
|
14
14
|
|
|
15
15
|
- `typescript` >= v4
|
|
16
|
-
- `@docusaurus/core` >= v2.0.0
|
|
17
|
-
- `@docusaurus/preset-classic` >= v2.0.0
|
|
16
|
+
- `@docusaurus/core` >= v2.0.0
|
|
17
|
+
- `@docusaurus/preset-classic` >= v2.0.0
|
|
18
18
|
|
|
19
19
|
## Examples
|
|
20
20
|
|
|
@@ -95,6 +95,10 @@ The following options are available to the plugin:
|
|
|
95
95
|
- `readmeName` (`string`) - Name of the readme file within a package. Defaults to `README.md`.
|
|
96
96
|
- `readmes` (`boolean`) - Include and render the readme file from every package. Defaults to
|
|
97
97
|
`false`.
|
|
98
|
+
- `rehypePlugins` (`MDXPlugin[]`) - List of rehype plugins to use for
|
|
99
|
+
[MDX compilation](https://mdxjs.com/docs/extending-mdx).
|
|
100
|
+
- `remarkPlugins` (`MDXPlugin[]`) - List of remark plugins to use for
|
|
101
|
+
[MDX compilation](https://mdxjs.com/docs/extending-mdx).
|
|
98
102
|
- `removeScopes` (`string[]`) - Package scopes and prefixes to remove when displaying the package
|
|
99
103
|
name in the sidebar and index. For example, `boost` will remove `@boost/` and `boost-`.
|
|
100
104
|
- `sortPackages` (`(a, d) => number`) - Function to sort the package list in the sidebar and on the
|
|
@@ -159,11 +163,11 @@ module.exports = {
|
|
|
159
163
|
// import {} from 'package'
|
|
160
164
|
index: 'src/index.tsx',
|
|
161
165
|
// import {} from 'package/client'
|
|
162
|
-
client: {
|
|
166
|
+
client: { path: 'src/client.tsx', label: 'Client' },
|
|
163
167
|
// import {} from 'package/server'
|
|
164
|
-
server: {
|
|
168
|
+
server: { path: 'src/server.tsx', label: 'Server' },
|
|
165
169
|
// import {} from 'package/server/test'
|
|
166
|
-
'server/test': {
|
|
170
|
+
'server/test': { path: 'src/server/test-utils.tsx', label: 'Server test utils' },
|
|
167
171
|
},
|
|
168
172
|
},
|
|
169
173
|
],
|
|
@@ -266,6 +270,24 @@ module.exports = {
|
|
|
266
270
|
|
|
267
271
|
> This workaround isn't perfect and may be buggy. Use at your own risk!
|
|
268
272
|
|
|
273
|
+
### Sidebars
|
|
274
|
+
|
|
275
|
+
When we generate API routes, we also dynamically generate and associate a sidebar with each route.
|
|
276
|
+
This cannot be overridden, but can be customized with some basic options (like categories and
|
|
277
|
+
sorting).
|
|
278
|
+
|
|
279
|
+
If you'd like to reference the generated sidebar in your `sidebars.ts`, we write the sidebar to a
|
|
280
|
+
file located at `.docusaurus/api-sidebar-<id>-<version>.js`. The `<id>` token defaults to "default"
|
|
281
|
+
and `<version>` to "current".
|
|
282
|
+
|
|
283
|
+
```ts
|
|
284
|
+
import apiSidebar from './.docusaurus/api-sidebar-default-current';
|
|
285
|
+
|
|
286
|
+
export default {
|
|
287
|
+
api: apiSidebar,
|
|
288
|
+
};
|
|
289
|
+
```
|
|
290
|
+
|
|
269
291
|
### Caveats
|
|
270
292
|
|
|
271
293
|
- Each version in `versioned_docs` (or `versions.json`) _must_ contain the generated API JSON files,
|
|
@@ -1,22 +1,27 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
const
|
|
3
|
+
const Link = require('@docusaurus/Link');
|
|
4
|
+
const useBrokenLinks = require('@docusaurus/useBrokenLinks');
|
|
5
|
+
const jsxRuntime = require('react/jsx-runtime');
|
|
4
6
|
const _interopDefault = e => e && e.__esModule ? e : {
|
|
5
7
|
default: e
|
|
6
8
|
};
|
|
7
|
-
const
|
|
9
|
+
const Link__default = /*#__PURE__*/_interopDefault(Link);
|
|
10
|
+
const useBrokenLinks__default = /*#__PURE__*/_interopDefault(useBrokenLinks);
|
|
8
11
|
function AnchorLink({
|
|
9
12
|
id
|
|
10
13
|
}) {
|
|
11
|
-
|
|
14
|
+
useBrokenLinks__default.default().collectAnchor(id);
|
|
15
|
+
return /*#__PURE__*/jsxRuntime.jsxs(Link__default.default, {
|
|
12
16
|
className: "tsd-anchor",
|
|
13
|
-
href: `#${id}
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
href: `#${id}`,
|
|
18
|
+
children: [/*#__PURE__*/jsxRuntime.jsx("span", {
|
|
19
|
+
className: "tsd-anchor-id",
|
|
20
|
+
id: id
|
|
21
|
+
}), /*#__PURE__*/jsxRuntime.jsx("i", {
|
|
22
|
+
className: "codicon codicon-symbol-numeric"
|
|
23
|
+
})]
|
|
24
|
+
});
|
|
20
25
|
}
|
|
21
26
|
exports.AnchorLink = AnchorLink;
|
|
22
27
|
//# sourceMappingURL=AnchorLink.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AnchorLink.js","sources":["../../src/components/AnchorLink.tsx"],"sourcesContent":null,"names":["
|
|
1
|
+
{"version":3,"file":"AnchorLink.js","sources":["../../src/components/AnchorLink.tsx"],"sourcesContent":null,"names":["useBrokenLinks","_jsxs","Link","_jsx"],"mappings":";;;;;;;;;;;AAIO,SAAS,UAAU,CAAC;AAC3B,EAAE,EAAE;AACJ,CAAC,EAAE;AACH,EAAEA,+BAAc,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AACrC,EAAE,oBAAoBC,eAAK,CAACC,qBAAI,EAAE;AAClC,IAAI,SAAS,EAAE,YAAY;AAC3B,IAAI,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAClB,IAAI,QAAQ,EAAE,cAAcC,cAAI,CAAC,MAAM,EAAE;AACzC,MAAM,SAAS,EAAE,eAAe;AAChC,MAAM,EAAE,EAAE,EAAE;AACZ,KAAK,CAAC,eAAeA,cAAI,CAAC,GAAG,EAAE;AAC/B,MAAM,SAAS,EAAE,gCAAgC;AACjD,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;;;"}
|
|
@@ -1,28 +1,26 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
const React = require('react');
|
|
4
3
|
const themeCommon = require('@docusaurus/theme-common');
|
|
5
4
|
const ApiItemLayout = require('./ApiItemLayout.js');
|
|
6
|
-
const
|
|
7
|
-
default: e
|
|
8
|
-
};
|
|
9
|
-
const React__default = /*#__PURE__*/_interopDefault(React);
|
|
5
|
+
const jsxRuntime = require('react/jsx-runtime');
|
|
10
6
|
const emptyToc = [];
|
|
11
7
|
function ApiChangelog({
|
|
12
8
|
changelog: Changelog,
|
|
13
9
|
route
|
|
14
10
|
}) {
|
|
15
|
-
return /*#__PURE__*/
|
|
11
|
+
return /*#__PURE__*/jsxRuntime.jsx(ApiItemLayout, {
|
|
16
12
|
heading: "Changelog",
|
|
17
|
-
pageMetadata: /*#__PURE__*/
|
|
13
|
+
pageMetadata: /*#__PURE__*/jsxRuntime.jsx(themeCommon.PageMetadata, {
|
|
18
14
|
description: Changelog.contentTitle,
|
|
19
15
|
title: "Changelog | API"
|
|
20
16
|
}),
|
|
21
17
|
route: route,
|
|
22
|
-
toc: Changelog.toc ?? emptyToc
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
18
|
+
toc: Changelog.toc ?? emptyToc,
|
|
19
|
+
children: /*#__PURE__*/jsxRuntime.jsx("section", {
|
|
20
|
+
className: "tsd-readme",
|
|
21
|
+
children: /*#__PURE__*/jsxRuntime.jsx(Changelog, {})
|
|
22
|
+
})
|
|
23
|
+
});
|
|
26
24
|
}
|
|
27
25
|
module.exports = ApiChangelog;
|
|
28
26
|
//# sourceMappingURL=ApiChangelog.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiChangelog.js","sources":["../../src/components/ApiChangelog.tsx"],"sourcesContent":null,"names":["
|
|
1
|
+
{"version":3,"file":"ApiChangelog.js","sources":["../../src/components/ApiChangelog.tsx"],"sourcesContent":null,"names":["_jsx","PageMetadata"],"mappings":";;;;;;AAGA,MAAM,QAAQ,GAAG,EAAE,CAAC;AACL,SAAS,YAAY,CAAC;AACrC,EAAE,SAAS,EAAE,SAAS;AACtB,EAAE,KAAK;AACP,CAAC,EAAE;AACH,EAAE,oBAAoBA,cAAI,CAAC,aAAa,EAAE;AAC1C,IAAI,OAAO,EAAE,WAAW;AACxB,IAAI,YAAY,eAAeA,cAAI,CAACC,wBAAY,EAAE;AAClD,MAAM,WAAW,EAAE,SAAS,CAAC,YAAY;AACzC,MAAM,KAAK,EAAE,iBAAiB;AAC9B,KAAK,CAAC;AACN,IAAI,KAAK,EAAE,KAAK;AAChB,IAAI,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,QAAQ;AAClC,IAAI,QAAQ,eAAeD,cAAI,CAAC,SAAS,EAAE;AAC3C,MAAM,SAAS,EAAE,YAAY;AAC7B,MAAM,QAAQ,eAAeA,cAAI,CAAC,SAAS,EAAE,EAAE,CAAC;AAChD,KAAK,CAAC;AACN,GAAG,CAAC,CAAC;AACL;;;;"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
const
|
|
3
|
+
const react = require('react');
|
|
4
4
|
const Link = require('@docusaurus/Link');
|
|
5
5
|
const themeCommon = require('@docusaurus/theme-common');
|
|
6
6
|
const internal = require('@docusaurus/theme-common/internal');
|
|
7
7
|
const Heading = require('@theme/Heading');
|
|
8
8
|
const links = require('../utils/links.js');
|
|
9
9
|
const VersionBanner = require('./VersionBanner.js');
|
|
10
|
+
const jsxRuntime = require('react/jsx-runtime');
|
|
10
11
|
const _interopDefault = e => e && e.__esModule ? e : {
|
|
11
12
|
default: e
|
|
12
13
|
};
|
|
13
|
-
const React__default = /*#__PURE__*/_interopDefault(React);
|
|
14
14
|
const Link__default = /*#__PURE__*/_interopDefault(Link);
|
|
15
15
|
const Heading__default = /*#__PURE__*/_interopDefault(Heading);
|
|
16
16
|
function addVersionToUrl(url, latestVersion, preferredVersion) {
|
|
@@ -31,7 +31,7 @@ function ApiIndex({
|
|
|
31
31
|
const latestVersion = internal.useDocsVersion();
|
|
32
32
|
const _themeCommon$useDocsP = themeCommon.useDocsPreferredVersion(latestVersion.pluginId),
|
|
33
33
|
preferredVersion = _themeCommon$useDocsP.preferredVersion;
|
|
34
|
-
|
|
34
|
+
react.useEffect(() => {
|
|
35
35
|
// Redirect to package when only 1
|
|
36
36
|
if (packages.length === 1) {
|
|
37
37
|
history.replace(addVersionToUrl(packages[0].entryPoints[0].reflection.permalink, latestVersion, preferredVersion));
|
|
@@ -41,40 +41,58 @@ function ApiIndex({
|
|
|
41
41
|
history.replace(addVersionToUrl(history.location.pathname, latestVersion, preferredVersion));
|
|
42
42
|
}
|
|
43
43
|
}, [packages, history, latestVersion, preferredVersion]);
|
|
44
|
-
return /*#__PURE__*/
|
|
45
|
-
className: "row"
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
44
|
+
return /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
45
|
+
className: "row",
|
|
46
|
+
children: /*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
47
|
+
className: "col apiItemCol",
|
|
48
|
+
children: [options.banner && /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
49
|
+
className: "alert alert--info margin-bottom--md",
|
|
50
|
+
role: "alert",
|
|
51
|
+
children: /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
52
|
+
dangerouslySetInnerHTML: {
|
|
53
|
+
__html: options.banner
|
|
54
|
+
}
|
|
55
|
+
})
|
|
56
|
+
}), /*#__PURE__*/jsxRuntime.jsx(VersionBanner.VersionBanner, {}), /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
57
|
+
className: "apiItemContainer",
|
|
58
|
+
children: /*#__PURE__*/jsxRuntime.jsx("article", {
|
|
59
|
+
children: /*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
60
|
+
className: "markdown",
|
|
61
|
+
children: [/*#__PURE__*/jsxRuntime.jsx("header", {
|
|
62
|
+
children: /*#__PURE__*/jsxRuntime.jsx(Heading__default.default, {
|
|
63
|
+
as: "h1",
|
|
64
|
+
children: "API"
|
|
65
|
+
})
|
|
66
|
+
}), /*#__PURE__*/jsxRuntime.jsxs("section", {
|
|
67
|
+
className: "tsd-panel",
|
|
68
|
+
children: [/*#__PURE__*/jsxRuntime.jsx("h3", {
|
|
69
|
+
className: "tsd-panel-header",
|
|
70
|
+
children: "Packages"
|
|
71
|
+
}), /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
72
|
+
className: "tsd-panel-content",
|
|
73
|
+
children: /*#__PURE__*/jsxRuntime.jsx("ul", {
|
|
74
|
+
className: "tsd-index-list",
|
|
75
|
+
children: packages.map(pkg => /*#__PURE__*/jsxRuntime.jsx("li", {
|
|
76
|
+
className: "tsd-truncate",
|
|
77
|
+
children: /*#__PURE__*/jsxRuntime.jsxs(Link__default.default, {
|
|
78
|
+
className: "tsd-kind-icon",
|
|
79
|
+
to: pkg.entryPoints[0].reflection.permalink,
|
|
80
|
+
children: [/*#__PURE__*/jsxRuntime.jsxs("span", {
|
|
81
|
+
className: "tsd-signature-symbol",
|
|
82
|
+
children: ["v", pkg.packageVersion]
|
|
83
|
+
}), ' ', /*#__PURE__*/jsxRuntime.jsx("span", {
|
|
84
|
+
children: links.removeScopes(pkg.packageName, options.scopes)
|
|
85
|
+
})]
|
|
86
|
+
})
|
|
87
|
+
}, pkg.packageName))
|
|
88
|
+
})
|
|
89
|
+
})]
|
|
90
|
+
})]
|
|
91
|
+
})
|
|
92
|
+
})
|
|
93
|
+
})]
|
|
94
|
+
})
|
|
95
|
+
});
|
|
78
96
|
}
|
|
79
97
|
module.exports = ApiIndex;
|
|
80
98
|
//# sourceMappingURL=ApiIndex.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiIndex.js","sources":["../../src/components/ApiIndex.tsx"],"sourcesContent":null,"names":["useDocsVersion","useDocsPreferredVersion","useEffect","
|
|
1
|
+
{"version":3,"file":"ApiIndex.js","sources":["../../src/components/ApiIndex.tsx"],"sourcesContent":null,"names":["useDocsVersion","useDocsPreferredVersion","useEffect","_jsx","_jsxs","VersionBanner","Heading","Link","removeScopes"],"mappings":";;;;;;;;;;;;;;;;AASA,SAAS,eAAe,CAAC,GAAG,EAAE,aAAa,EAAE,gBAAgB,EAAE;AAC/D,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,gBAAgB,IAAI,gBAAgB,CAAC,IAAI,KAAK,aAAa,CAAC,OAAO,EAAE;AACvI,IAAI,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,KAAK,SAAS,GAAG,MAAM,GAAG,gBAAgB,CAAC,IAAI,CAAC;AACzF,IAAI,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;AAC9B,MAAM,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AACjC,KAAK;AACL,IAAI,OAAO,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;AACpD,GAAG;AACH,EAAE,OAAO,GAAG,CAAC;AACb,CAAC;AACc,SAAS,QAAQ,CAAC;AACjC,EAAE,OAAO;AACT,EAAE,QAAQ;AACV,EAAE,OAAO;AACT,CAAC,EAAE;AACH,EAAE,MAAM,aAAa,GAAGA,uBAAc,EAAE,CAAC;AACzC,EAAE,MAAM;AACR,IAAI,gBAAgB;AACpB,GAAG,GAAGC,mCAAuB,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;AACtD,EAAEC,eAAS,CAAC,MAAM;AAClB;AACA,IAAI,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;AAC/B,MAAM,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACzH;AACA;AACA,KAAK,MAAM,IAAI,gBAAgB,EAAE;AACjC,MAAM,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACnG,KAAK;AACL,GAAG,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AAC3D,EAAE,oBAAoBC,cAAI,CAAC,KAAK,EAAE;AAClC,IAAI,SAAS,EAAE,KAAK;AACpB,IAAI,QAAQ,eAAeC,eAAK,CAAC,KAAK,EAAE;AACxC,MAAM,SAAS,EAAE,gBAAgB;AACjC,MAAM,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,iBAAiBD,cAAI,CAAC,KAAK,EAAE;AAC5D,QAAQ,SAAS,EAAE,qCAAqC;AACxD,QAAQ,IAAI,EAAE,OAAO;AACrB,QAAQ,QAAQ,eAAeA,cAAI,CAAC,KAAK,EAAE;AAC3C,UAAU,uBAAuB,EAAE;AACnC,YAAY,MAAM,EAAE,OAAO,CAAC,MAAM;AAClC,WAAW;AACX,SAAS,CAAC;AACV,OAAO,CAAC,eAAeA,cAAI,CAACE,2BAAa,EAAE,EAAE,CAAC,eAAeF,cAAI,CAAC,KAAK,EAAE;AACzE,QAAQ,SAAS,EAAE,kBAAkB;AACrC,QAAQ,QAAQ,eAAeA,cAAI,CAAC,SAAS,EAAE;AAC/C,UAAU,QAAQ,eAAeC,eAAK,CAAC,KAAK,EAAE;AAC9C,YAAY,SAAS,EAAE,UAAU;AACjC,YAAY,QAAQ,EAAE,cAAcD,cAAI,CAAC,QAAQ,EAAE;AACnD,cAAc,QAAQ,eAAeA,cAAI,CAACG,wBAAO,EAAE;AACnD,gBAAgB,EAAE,EAAE,IAAI;AACxB,gBAAgB,QAAQ,EAAE,KAAK;AAC/B,eAAe,CAAC;AAChB,aAAa,CAAC,eAAeF,eAAK,CAAC,SAAS,EAAE;AAC9C,cAAc,SAAS,EAAE,WAAW;AACpC,cAAc,QAAQ,EAAE,cAAcD,cAAI,CAAC,IAAI,EAAE;AACjD,gBAAgB,SAAS,EAAE,kBAAkB;AAC7C,gBAAgB,QAAQ,EAAE,UAAU;AACpC,eAAe,CAAC,eAAeA,cAAI,CAAC,KAAK,EAAE;AAC3C,gBAAgB,SAAS,EAAE,mBAAmB;AAC9C,gBAAgB,QAAQ,eAAeA,cAAI,CAAC,IAAI,EAAE;AAClD,kBAAkB,SAAS,EAAE,gBAAgB;AAC7C,kBAAkB,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,iBAAiBA,cAAI,CAAC,IAAI,EAAE;AACxE,oBAAoB,SAAS,EAAE,cAAc;AAC7C,oBAAoB,QAAQ,eAAeC,eAAK,CAACG,qBAAI,EAAE;AACvD,sBAAsB,SAAS,EAAE,eAAe;AAChD,sBAAsB,EAAE,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,SAAS;AACjE,sBAAsB,QAAQ,EAAE,cAAcH,eAAK,CAAC,MAAM,EAAE;AAC5D,wBAAwB,SAAS,EAAE,sBAAsB;AACzD,wBAAwB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,cAAc,CAAC;AAC3D,uBAAuB,CAAC,EAAE,GAAG,eAAeD,cAAI,CAAC,MAAM,EAAE;AACzD,wBAAwB,QAAQ,EAAEK,kBAAY,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC;AAC/E,uBAAuB,CAAC,CAAC;AACzB,qBAAqB,CAAC;AACtB,mBAAmB,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;AACtC,iBAAiB,CAAC;AAClB,eAAe,CAAC,CAAC;AACjB,aAAa,CAAC,CAAC;AACf,WAAW,CAAC;AACZ,SAAS,CAAC;AACV,OAAO,CAAC,CAAC;AACT,KAAK,CAAC;AACN,GAAG,CAAC,CAAC;AACL;;;;"}
|
|
@@ -1,19 +1,17 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
const
|
|
3
|
+
const react = require('react');
|
|
4
4
|
const themeCommon = require('@docusaurus/theme-common');
|
|
5
5
|
const useReflection = require('../hooks/useReflection.js');
|
|
6
6
|
const useReflectionMap = require('../hooks/useReflectionMap.js');
|
|
7
|
+
const helpers = require('../utils/helpers.js');
|
|
7
8
|
const icons = require('../utils/icons.js');
|
|
8
9
|
const ApiItemLayout = require('./ApiItemLayout.js');
|
|
9
10
|
const Comment = require('./Comment.js');
|
|
10
11
|
const Flags = require('./Flags.js');
|
|
11
12
|
const Reflection = require('./Reflection.js');
|
|
12
13
|
const TypeParametersGeneric = require('./TypeParametersGeneric.js');
|
|
13
|
-
const
|
|
14
|
-
default: e
|
|
15
|
-
};
|
|
16
|
-
const React__default = /*#__PURE__*/_interopDefault(React);
|
|
14
|
+
const jsxRuntime = require('react/jsx-runtime');
|
|
17
15
|
function extractTOC(item, map) {
|
|
18
16
|
const toc = [];
|
|
19
17
|
const mapped = new Set();
|
|
@@ -23,13 +21,14 @@ function extractTOC(item, map) {
|
|
|
23
21
|
if (mapped.has(child.name)) {
|
|
24
22
|
return;
|
|
25
23
|
}
|
|
26
|
-
const iconHtml = icons.getKindIconHtml(child.kind, child.name);
|
|
27
24
|
if (!child.permalink || child.permalink.includes('#')) {
|
|
25
|
+
const iconHtml = icons.getKindIconHtml(child.kind, child.name);
|
|
26
|
+
const value = helpers.escapeMdx(child.name) ?? '';
|
|
28
27
|
toc.push({
|
|
29
28
|
// @ts-expect-error Not typed upstream
|
|
30
29
|
children: [],
|
|
31
30
|
id: child.name,
|
|
32
|
-
value: iconHtml ? `${iconHtml} ${
|
|
31
|
+
value: iconHtml ? `${iconHtml} ${value}` : value,
|
|
33
32
|
level: 1
|
|
34
33
|
});
|
|
35
34
|
mapped.add(child.name);
|
|
@@ -42,45 +41,50 @@ function ApiItem({
|
|
|
42
41
|
readme: Readme,
|
|
43
42
|
route
|
|
44
43
|
}) {
|
|
45
|
-
const item = useReflection.
|
|
44
|
+
const item = useReflection.useRequiredReflection(route.id);
|
|
46
45
|
const reflections = useReflectionMap.useReflectionMap();
|
|
47
|
-
const toc =
|
|
46
|
+
const toc = react.useMemo(() => extractTOC(item, reflections), [item, reflections]);
|
|
48
47
|
|
|
49
48
|
// Pagination
|
|
50
49
|
const prevItem = useReflection.useReflection(item.previousId);
|
|
51
50
|
const nextItem = useReflection.useReflection(item.nextId);
|
|
52
|
-
const pagingMetadata =
|
|
51
|
+
const pagingMetadata = react.useMemo(() => ({
|
|
53
52
|
next: nextItem ? {
|
|
54
53
|
permalink: nextItem.permalink,
|
|
55
|
-
title: nextItem.name
|
|
54
|
+
title: helpers.escapeMdx(nextItem.name) ?? ''
|
|
56
55
|
} : undefined,
|
|
57
56
|
previous: prevItem ? {
|
|
58
57
|
permalink: prevItem.permalink,
|
|
59
|
-
title: prevItem.name
|
|
58
|
+
title: helpers.escapeMdx(prevItem.name) ?? ''
|
|
60
59
|
} : undefined
|
|
61
60
|
}), [nextItem, prevItem]);
|
|
62
|
-
return /*#__PURE__*/
|
|
63
|
-
heading: /*#__PURE__*/
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
61
|
+
return /*#__PURE__*/jsxRuntime.jsxs(ApiItemLayout, {
|
|
62
|
+
heading: /*#__PURE__*/jsxRuntime.jsxs(jsxRuntime.Fragment, {
|
|
63
|
+
children: [/*#__PURE__*/jsxRuntime.jsx("span", {
|
|
64
|
+
className: "tsd-header-flags",
|
|
65
|
+
children: /*#__PURE__*/jsxRuntime.jsx(Flags.Flags, {
|
|
66
|
+
flags: item.flags
|
|
67
|
+
})
|
|
68
|
+
}), helpers.escapeMdx(item.name), " ", /*#__PURE__*/jsxRuntime.jsx(TypeParametersGeneric.TypeParametersGeneric, {
|
|
69
|
+
params: item.typeParameters
|
|
70
|
+
})]
|
|
71
|
+
}),
|
|
70
72
|
module: item.module,
|
|
71
73
|
name: item.name,
|
|
72
|
-
pageMetadata: /*#__PURE__*/
|
|
73
|
-
description: item
|
|
74
|
-
title: `${item.name} | API`
|
|
74
|
+
pageMetadata: /*#__PURE__*/jsxRuntime.jsx(themeCommon.PageMetadata, {
|
|
75
|
+
description: item?.comment?.summary ? Comment.displayPartsToMarkdown(item.comment.summary) : '',
|
|
76
|
+
title: `${item?.name ? `${item.name} | ` : ''}API`
|
|
75
77
|
}),
|
|
76
78
|
pagingMetadata: pagingMetadata,
|
|
77
79
|
route: route,
|
|
78
|
-
toc: toc
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
80
|
+
toc: toc,
|
|
81
|
+
children: [Readme && /*#__PURE__*/jsxRuntime.jsx("section", {
|
|
82
|
+
className: "tsd-readme",
|
|
83
|
+
children: /*#__PURE__*/jsxRuntime.jsx(Readme, {})
|
|
84
|
+
}), /*#__PURE__*/jsxRuntime.jsx(Reflection.Reflection, {
|
|
85
|
+
reflection: item
|
|
86
|
+
})]
|
|
87
|
+
});
|
|
84
88
|
}
|
|
85
89
|
module.exports = ApiItem;
|
|
86
90
|
//# sourceMappingURL=ApiItem.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiItem.js","sources":["../../src/components/ApiItem.tsx"],"sourcesContent":null,"names":["getKindIconHtml","
|
|
1
|
+
{"version":3,"file":"ApiItem.js","sources":["../../src/components/ApiItem.tsx"],"sourcesContent":null,"names":["getKindIconHtml","escapeMdx","useRequiredReflection","useReflectionMap","useMemo","useReflection","_jsxs","_Fragment","_jsx","Flags","TypeParametersGeneric","PageMetadata","displayPartsToMarkdown","Reflection"],"mappings":";;;;;;;;;;;;;;;AAcA,SAAS,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE;AAC/B,EAAE,MAAM,GAAG,GAAG,EAAE,CAAC;AACjB,EAAE,MAAM,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;AAC3B,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI;AAChC,IAAI,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,OAAO,IAAI;AACvC,MAAM,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC;AACjC,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;AAClC,QAAQ,OAAO;AACf,OAAO;AACP,MAAM,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AAC7D,QAAQ,MAAM,QAAQ,GAAGA,qBAAe,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;AACjE,QAAQ,MAAM,KAAK,GAAGC,iBAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;AAClD,QAAQ,GAAG,CAAC,IAAI,CAAC;AACjB;AACA,UAAU,QAAQ,EAAE,EAAE;AACtB,UAAU,EAAE,EAAE,KAAK,CAAC,IAAI;AACxB,UAAU,KAAK,EAAE,QAAQ,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,GAAG,KAAK;AAC1D,UAAU,KAAK,EAAE,CAAC;AAClB,SAAS,CAAC,CAAC;AACX,QAAQ,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AAC/B,OAAO;AACP,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL,EAAE,OAAO,GAAG,CAAC;AACb,CAAC;AACc,SAAS,OAAO,CAAC;AAChC,EAAE,MAAM,EAAE,MAAM;AAChB,EAAE,KAAK;AACP,CAAC,EAAE;AACH,EAAE,MAAM,IAAI,GAAGC,mCAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC/C,EAAE,MAAM,WAAW,GAAGC,iCAAgB,EAAE,CAAC;AACzC,EAAE,MAAM,GAAG,GAAGC,aAAO,CAAC,MAAM,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;AAChF;AACA;AACA,EAAE,MAAM,QAAQ,GAAGC,2BAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAClD,EAAE,MAAM,QAAQ,GAAGA,2BAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAC9C,EAAE,MAAM,cAAc,GAAGD,aAAO,CAAC,OAAO;AACxC,IAAI,IAAI,EAAE,QAAQ,GAAG;AACrB,MAAM,SAAS,EAAE,QAAQ,CAAC,SAAS;AACnC,MAAM,KAAK,EAAEH,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;AAC3C,KAAK,GAAG,SAAS;AACjB,IAAI,QAAQ,EAAE,QAAQ,GAAG;AACzB,MAAM,SAAS,EAAE,QAAQ,CAAC,SAAS;AACnC,MAAM,KAAK,EAAEA,iBAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE;AAC3C,KAAK,GAAG,SAAS;AACjB,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAC5B,EAAE,oBAAoBK,eAAK,CAAC,aAAa,EAAE;AAC3C,IAAI,OAAO,eAAeA,eAAK,CAACC,mBAAS,EAAE;AAC3C,MAAM,QAAQ,EAAE,cAAcC,cAAI,CAAC,MAAM,EAAE;AAC3C,QAAQ,SAAS,EAAE,kBAAkB;AACrC,QAAQ,QAAQ,eAAeA,cAAI,CAACC,WAAK,EAAE;AAC3C,UAAU,KAAK,EAAE,IAAI,CAAC,KAAK;AAC3B,SAAS,CAAC;AACV,OAAO,CAAC,EAAER,iBAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,eAAeO,cAAI,CAACE,2CAAqB,EAAE;AAC9E,QAAQ,MAAM,EAAE,IAAI,CAAC,cAAc;AACnC,OAAO,CAAC,CAAC;AACT,KAAK,CAAC;AACN,IAAI,MAAM,EAAE,IAAI,CAAC,MAAM;AACvB,IAAI,IAAI,EAAE,IAAI,CAAC,IAAI;AACnB,IAAI,YAAY,eAAeF,cAAI,CAACG,wBAAY,EAAE;AAClD,MAAM,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,GAAGC,8BAAsB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;AAC7F,MAAM,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC;AACxD,KAAK,CAAC;AACN,IAAI,cAAc,EAAE,cAAc;AAClC,IAAI,KAAK,EAAE,KAAK;AAChB,IAAI,GAAG,EAAE,GAAG;AACZ,IAAI,QAAQ,EAAE,CAAC,MAAM,iBAAiBJ,cAAI,CAAC,SAAS,EAAE;AACtD,MAAM,SAAS,EAAE,YAAY;AAC7B,MAAM,QAAQ,eAAeA,cAAI,CAAC,MAAM,EAAE,EAAE,CAAC;AAC7C,KAAK,CAAC,eAAeA,cAAI,CAACK,qBAAU,EAAE;AACtC,MAAM,UAAU,EAAE,IAAI;AACtB,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;;;"}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
|
|
4
|
+
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
|
|
5
|
+
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
|
|
6
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
|
|
7
|
+
function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
|
|
4
8
|
const themeCommon = require('@docusaurus/theme-common');
|
|
5
9
|
const DocBreadcrumbs = require('@theme/DocBreadcrumbs');
|
|
6
10
|
const DocPaginator = require('@theme/DocPaginator');
|
|
@@ -11,10 +15,10 @@ const TOC = require('@theme/TOC');
|
|
|
11
15
|
const TOCCollapsible = require('@theme/TOCCollapsible');
|
|
12
16
|
const useBreadcrumbs = require('../hooks/useBreadcrumbs.js');
|
|
13
17
|
const VersionBanner = require('./VersionBanner.js');
|
|
18
|
+
const jsxRuntime = require('react/jsx-runtime');
|
|
14
19
|
const _interopDefault = e => e && e.__esModule ? e : {
|
|
15
20
|
default: e
|
|
16
21
|
};
|
|
17
|
-
const React__default = /*#__PURE__*/_interopDefault(React);
|
|
18
22
|
const DocBreadcrumbs__default = /*#__PURE__*/_interopDefault(DocBreadcrumbs);
|
|
19
23
|
const DocPaginator__default = /*#__PURE__*/_interopDefault(DocPaginator);
|
|
20
24
|
const DocVersionBadge__default = /*#__PURE__*/_interopDefault(DocVersionBadge);
|
|
@@ -24,6 +28,9 @@ const TOC__default = /*#__PURE__*/_interopDefault(TOC);
|
|
|
24
28
|
const TOCCollapsible__default = /*#__PURE__*/_interopDefault(TOCCollapsible);
|
|
25
29
|
|
|
26
30
|
// This file is based on `DocItem` upstream, but since we aren't using markdown,
|
|
31
|
+
// we had to duplicate it. Keep this file in sync as much as possible!
|
|
32
|
+
// https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/DocItem/index.tsx
|
|
33
|
+
|
|
27
34
|
function ApiItemLayout({
|
|
28
35
|
children,
|
|
29
36
|
heading,
|
|
@@ -39,31 +46,46 @@ function ApiItemLayout({
|
|
|
39
46
|
// Table of contents
|
|
40
47
|
const canRenderTOC = toc.length > 0;
|
|
41
48
|
const renderTocDesktop = canRenderTOC && (windowSize === 'desktop' || windowSize === 'ssr');
|
|
42
|
-
return /*#__PURE__*/
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
49
|
+
return /*#__PURE__*/jsxRuntime.jsxs(jsxRuntime.Fragment, {
|
|
50
|
+
children: [pageMetadata, /*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
51
|
+
className: "row",
|
|
52
|
+
children: [/*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
53
|
+
className: "col apiItemCol",
|
|
54
|
+
children: [/*#__PURE__*/jsxRuntime.jsx(VersionBanner.VersionBanner, {}), /*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
55
|
+
className: "apiItemContainer",
|
|
56
|
+
children: [/*#__PURE__*/jsxRuntime.jsxs("article", {
|
|
57
|
+
children: [breadcrumbs && /*#__PURE__*/jsxRuntime.jsx(DocBreadcrumbs__default.default, {}), /*#__PURE__*/jsxRuntime.jsx(DocVersionBadge__default.default, {}), canRenderTOC && /*#__PURE__*/jsxRuntime.jsx(TOCCollapsible__default.default, {
|
|
58
|
+
className: `${themeCommon.ThemeClassNames.docs.docTocMobile ?? ''} apiTocMobile`,
|
|
59
|
+
maxHeadingLevel: 6,
|
|
60
|
+
minHeadingLevel: 1,
|
|
61
|
+
toc: toc
|
|
62
|
+
}), /*#__PURE__*/jsxRuntime.jsxs("div", {
|
|
63
|
+
className: `${themeCommon.ThemeClassNames.docs.docMarkdown ?? ''} markdown`,
|
|
64
|
+
children: [/*#__PURE__*/jsxRuntime.jsxs("header", {
|
|
65
|
+
children: [/*#__PURE__*/jsxRuntime.jsx(Heading__default.default, {
|
|
66
|
+
as: "h1",
|
|
67
|
+
children: heading
|
|
68
|
+
}), module && /*#__PURE__*/jsxRuntime.jsx("code", {
|
|
69
|
+
className: "tsd-header-member-fullname",
|
|
70
|
+
children: `${module}.${name}`
|
|
71
|
+
})]
|
|
72
|
+
}), /*#__PURE__*/jsxRuntime.jsx(MDXContent__default.default, {
|
|
73
|
+
children: children
|
|
74
|
+
})]
|
|
75
|
+
})]
|
|
76
|
+
}), pagingMetadata && /*#__PURE__*/jsxRuntime.jsx(DocPaginator__default.default, _objectSpread({}, pagingMetadata))]
|
|
77
|
+
})]
|
|
78
|
+
}), renderTocDesktop && /*#__PURE__*/jsxRuntime.jsx("div", {
|
|
79
|
+
className: "col col--3",
|
|
80
|
+
children: /*#__PURE__*/jsxRuntime.jsx(TOC__default.default, {
|
|
81
|
+
className: themeCommon.ThemeClassNames.docs.docTocDesktop,
|
|
82
|
+
maxHeadingLevel: 6,
|
|
83
|
+
minHeadingLevel: 1,
|
|
84
|
+
toc: toc
|
|
85
|
+
})
|
|
86
|
+
})]
|
|
87
|
+
})]
|
|
88
|
+
});
|
|
67
89
|
}
|
|
68
90
|
module.exports = ApiItemLayout;
|
|
69
91
|
//# sourceMappingURL=ApiItemLayout.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiItemLayout.js","sources":["../../src/components/ApiItemLayout.tsx"],"sourcesContent":null,"names":["useWindowSize","useBreadcrumbs","
|
|
1
|
+
{"version":3,"file":"ApiItemLayout.js","sources":["../../src/components/ApiItemLayout.tsx"],"sourcesContent":null,"names":["useWindowSize","useBreadcrumbs","_jsxs","_Fragment","_jsx","VersionBanner","DocBreadcrumbs","DocVersionBadge","TOCCollapsible","ThemeClassNames","Heading","MDXContent","DocPaginator","TOC"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA;AACA;AACA;AACA;AAce,SAAS,aAAa,CAAC;AACtC,EAAE,QAAQ;AACV,EAAE,OAAO;AACT,EAAE,YAAY;AACd,EAAE,cAAc;AAChB,EAAE,GAAG;AACL,EAAE,IAAI;AACN,EAAE,MAAM;AACR,CAAC,EAAE;AACH,EAAE,MAAM,UAAU,GAAGA,yBAAa,EAAE,CAAC;AACrC,EAAE,MAAM,WAAW,GAAGC,6BAAc,EAAE,CAAC;AACvC;AACA;AACA,EAAE,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;AACtC,EAAE,MAAM,gBAAgB,GAAG,YAAY,KAAK,UAAU,KAAK,SAAS,IAAI,UAAU,KAAK,KAAK,CAAC,CAAC;AAC9F,EAAE,oBAAoBC,eAAK,CAACC,mBAAS,EAAE;AACvC,IAAI,QAAQ,EAAE,CAAC,YAAY,eAAeD,eAAK,CAAC,KAAK,EAAE;AACvD,MAAM,SAAS,EAAE,KAAK;AACtB,MAAM,QAAQ,EAAE,cAAcA,eAAK,CAAC,KAAK,EAAE;AAC3C,QAAQ,SAAS,EAAE,gBAAgB;AACnC,QAAQ,QAAQ,EAAE,cAAcE,cAAI,CAACC,2BAAa,EAAE,EAAE,CAAC,eAAeH,eAAK,CAAC,KAAK,EAAE;AACnF,UAAU,SAAS,EAAE,kBAAkB;AACvC,UAAU,QAAQ,EAAE,cAAcA,eAAK,CAAC,SAAS,EAAE;AACnD,YAAY,QAAQ,EAAE,CAAC,WAAW,iBAAiBE,cAAI,CAACE,+BAAc,EAAE,EAAE,CAAC,eAAeF,cAAI,CAACG,gCAAe,EAAE,EAAE,CAAC,EAAE,YAAY,iBAAiBH,cAAI,CAACI,+BAAc,EAAE;AACvK,cAAc,SAAS,EAAE,CAAC,EAAEC,2BAAe,CAAC,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC,aAAa,CAAC;AAClF,cAAc,eAAe,EAAE,CAAC;AAChC,cAAc,eAAe,EAAE,CAAC;AAChC,cAAc,GAAG,EAAE,GAAG;AACtB,aAAa,CAAC,eAAeP,eAAK,CAAC,KAAK,EAAE;AAC1C,cAAc,SAAS,EAAE,CAAC,EAAEO,2BAAe,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,SAAS,CAAC;AAC7E,cAAc,QAAQ,EAAE,cAAcP,eAAK,CAAC,QAAQ,EAAE;AACtD,gBAAgB,QAAQ,EAAE,cAAcE,cAAI,CAACM,wBAAO,EAAE;AACtD,kBAAkB,EAAE,EAAE,IAAI;AAC1B,kBAAkB,QAAQ,EAAE,OAAO;AACnC,iBAAiB,CAAC,EAAE,MAAM,iBAAiBN,cAAI,CAAC,MAAM,EAAE;AACxD,kBAAkB,SAAS,EAAE,4BAA4B;AACzD,kBAAkB,QAAQ,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;AAC/C,iBAAiB,CAAC,CAAC;AACnB,eAAe,CAAC,eAAeA,cAAI,CAACO,2BAAU,EAAE;AAChD,gBAAgB,QAAQ,EAAE,QAAQ;AAClC,eAAe,CAAC,CAAC;AACjB,aAAa,CAAC,CAAC;AACf,WAAW,CAAC,EAAE,cAAc,iBAAiBP,cAAI,CAACQ,6BAAY,EAAE;AAChE,YAAY,GAAG,cAAc;AAC7B,WAAW,CAAC,CAAC;AACb,SAAS,CAAC,CAAC;AACX,OAAO,CAAC,EAAE,gBAAgB,iBAAiBR,cAAI,CAAC,KAAK,EAAE;AACvD,QAAQ,SAAS,EAAE,YAAY;AAC/B,QAAQ,QAAQ,eAAeA,cAAI,CAACS,oBAAG,EAAE;AACzC,UAAU,SAAS,EAAEJ,2BAAe,CAAC,IAAI,CAAC,aAAa;AACvD,UAAU,eAAe,EAAE,CAAC;AAC5B,UAAU,eAAe,EAAE,CAAC;AAC5B,UAAU,GAAG,EAAE,GAAG;AAClB,SAAS,CAAC;AACV,OAAO,CAAC,CAAC;AACT,KAAK,CAAC,CAAC;AACP,GAAG,CAAC,CAAC;AACL;;;;"}
|