docusaurus-plugin-typedoc-api
Version:
Docusaurus plugin that provides source code API documentation powered by TypeDoc.
95 lines (90 loc) • 5.57 kB
JavaScript
'use strict';
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; }
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; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
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); }
const themeCommon = require('@docusaurus/theme-common');
const DocBreadcrumbs = require('@theme/DocBreadcrumbs');
const DocPaginator = require('@theme/DocPaginator');
const DocVersionBadge = require('@theme/DocVersionBadge');
const Heading = require('@theme/Heading');
const MDXContent = require('@theme/MDXContent');
const TOC = require('@theme/TOC');
const TOCCollapsible = require('@theme/TOCCollapsible');
const useBreadcrumbs = require('../hooks/useBreadcrumbs.js');
const ApiOptionsLayout = require('./ApiOptionsLayout.js');
const Footer = require('./Footer.js');
const VersionBanner = require('./VersionBanner.js');
const jsxRuntime = require('react/jsx-runtime');
const _interopDefault = e => e && e.__esModule ? e : {
default: e
};
const DocBreadcrumbs__default = /*#__PURE__*/_interopDefault(DocBreadcrumbs);
const DocPaginator__default = /*#__PURE__*/_interopDefault(DocPaginator);
const DocVersionBadge__default = /*#__PURE__*/_interopDefault(DocVersionBadge);
const Heading__default = /*#__PURE__*/_interopDefault(Heading);
const MDXContent__default = /*#__PURE__*/_interopDefault(MDXContent);
const TOC__default = /*#__PURE__*/_interopDefault(TOC);
const TOCCollapsible__default = /*#__PURE__*/_interopDefault(TOCCollapsible);
// This file is based on `DocItem` upstream, but since we aren't using markdown,
// we had to duplicate it. Keep this file in sync as much as possible!
// https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-classic/src/theme/DocItem/index.tsx
function ApiItemLayout({
children,
heading,
pageMetadata,
pagingMetadata,
toc
}) {
const windowSize = themeCommon.useWindowSize();
const breadcrumbs = useBreadcrumbs.useBreadcrumbs();
// Table of contents
const canRenderTOC = toc.length > 0;
const renderTocDesktop = canRenderTOC && (windowSize === 'desktop' || windowSize === 'ssr');
return /*#__PURE__*/jsxRuntime.jsxs(jsxRuntime.Fragment, {
children: [pageMetadata, /*#__PURE__*/jsxRuntime.jsxs("div", {
className: "row",
children: [/*#__PURE__*/jsxRuntime.jsxs("div", {
className: "col apiItemCol",
children: [/*#__PURE__*/jsxRuntime.jsx(VersionBanner.VersionBanner, {}), /*#__PURE__*/jsxRuntime.jsxs("div", {
className: "apiItemContainer",
children: [/*#__PURE__*/jsxRuntime.jsxs("article", {
children: [breadcrumbs && /*#__PURE__*/jsxRuntime.jsx(DocBreadcrumbs__default.default, {}), /*#__PURE__*/jsxRuntime.jsx(DocVersionBadge__default.default, {}), canRenderTOC && /*#__PURE__*/jsxRuntime.jsxs(jsxRuntime.Fragment, {
children: [!renderTocDesktop && /*#__PURE__*/jsxRuntime.jsx(ApiOptionsLayout, {
className: "tsd-api-options-mobile"
}), /*#__PURE__*/jsxRuntime.jsx(TOCCollapsible__default.default, {
className: `${themeCommon.ThemeClassNames.docs.docTocMobile ?? ''} apiTocMobile`,
maxHeadingLevel: 6,
minHeadingLevel: 1,
toc: toc
})]
}), /*#__PURE__*/jsxRuntime.jsxs("div", {
className: `${themeCommon.ThemeClassNames.docs.docMarkdown ?? ''} markdown`,
children: [/*#__PURE__*/jsxRuntime.jsx("header", {
children: /*#__PURE__*/jsxRuntime.jsx(Heading__default.default, {
as: "h1",
children: heading
})
}), /*#__PURE__*/jsxRuntime.jsx(MDXContent__default.default, {
children: children
})]
}), /*#__PURE__*/jsxRuntime.jsx(Footer.Footer, {})]
}), pagingMetadata && /*#__PURE__*/jsxRuntime.jsx(DocPaginator__default.default, _objectSpread({}, pagingMetadata))]
})]
}), renderTocDesktop && /*#__PURE__*/jsxRuntime.jsxs("div", {
className: "col col--3",
children: [/*#__PURE__*/jsxRuntime.jsx(ApiOptionsLayout, {
className: "tsd-api-options"
}), /*#__PURE__*/jsxRuntime.jsx(TOC__default.default, {
className: themeCommon.ThemeClassNames.docs.docTocDesktop,
maxHeadingLevel: 6,
minHeadingLevel: 1,
toc: toc
})]
})]
})]
});
}
module.exports = ApiItemLayout;
//# sourceMappingURL=ApiItemLayout.js.map