docusaurus-theme-openapi-docs 1.0.6 → 1.1.2

package/src/theme/ApiItem/Footer/index.tsx

@@ -0,0 +1,101 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+import { ThemeClassNames } from "@docusaurus/theme-common";
+import {
+  useDoc,
+  type DocContextValue,
+  // @ts-ignore
+} from "@docusaurus/theme-common/internal";
+import EditThisPage from "@theme/EditThisPage";
+import LastUpdated from "@theme/LastUpdated";
+import TagsListInline, {
+  type Props as TagsListInlineProps,
+} from "@theme/TagsListInline";
+import clsx from "clsx";
+
+import styles from "./styles.module.css";
+
+function TagsRow(props: TagsListInlineProps) {
+  return (
+    <div
+      className={clsx(
+        ThemeClassNames.docs.docFooterTagsRow,
+        "row margin-bottom--sm"
+      )}
+    >
+      <div className="col">
+        <TagsListInline {...props} />
+      </div>
+    </div>
+  );
+}
+
+type EditMetaRowProps = Pick<
+  DocContextValue["metadata"],
+  "editUrl" | "lastUpdatedAt" | "lastUpdatedBy" | "formattedLastUpdatedAt"
+>;
+function EditMetaRow({
+  editUrl,
+  lastUpdatedAt,
+  lastUpdatedBy,
+  formattedLastUpdatedAt,
+}: EditMetaRowProps) {
+  return (
+    <div className={clsx(ThemeClassNames.docs.docFooterEditMetaRow, "row")}>
+      <div className="col">{editUrl && <EditThisPage editUrl={editUrl} />}</div>
+
+      <div className={clsx("col", styles.lastUpdated)}>
+        {(lastUpdatedAt || lastUpdatedBy) && (
+          <LastUpdated
+            lastUpdatedAt={lastUpdatedAt}
+            formattedLastUpdatedAt={formattedLastUpdatedAt}
+            lastUpdatedBy={lastUpdatedBy}
+          />
+        )}
+      </div>
+    </div>
+  );
+}
+
+export default function DocItemFooter(): JSX.Element | null {
+  const { metadata } = useDoc();
+  const {
+    editUrl,
+    lastUpdatedAt,
+    formattedLastUpdatedAt,
+    lastUpdatedBy,
+    tags,
+  } = metadata;
+
+  const canDisplayTagsRow = tags.length > 0;
+  const canDisplayEditMetaRow = !!(editUrl || lastUpdatedAt || lastUpdatedBy);
+
+  const canDisplayFooter = canDisplayTagsRow || canDisplayEditMetaRow;
+
+  if (!canDisplayFooter) {
+    return null;
+  }
+
+  return (
+    <footer
+      className={clsx(ThemeClassNames.docs.docFooter, "docusaurus-mt-lg")}
+    >
+      {canDisplayTagsRow && <TagsRow tags={tags} />}
+      {canDisplayEditMetaRow && (
+        <EditMetaRow
+          editUrl={editUrl}
+          lastUpdatedAt={lastUpdatedAt}
+          lastUpdatedBy={lastUpdatedBy}
+          formattedLastUpdatedAt={formattedLastUpdatedAt}
+        />
+      )}
+    </footer>
+  );
+}

package/src/theme/ApiItem/Footer/styles.module.css

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+.lastUpdated {
+  margin-top: 0.2rem;
+  font-style: italic;
+  font-size: smaller;
+}
+
+@media (min-width: 997px) {
+  .lastUpdated {
+    text-align: right;
+  }
+}

package/src/theme/ApiItem/Layout/index.tsx

@@ -0,0 +1,78 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+import { useWindowSize } from "@docusaurus/theme-common";
+// @ts-ignore
+import { useDoc } from "@docusaurus/theme-common/internal";
+import DocBreadcrumbs from "@theme/DocBreadcrumbs";
+import type { Props } from "@theme/DocItem/Layout";
+import DocVersionBadge from "@theme/DocVersionBadge";
+import DocVersionBanner from "@theme/DocVersionBanner";
+import clsx from "clsx";
+
+import DocItemContent from "../Content";
+import DocItemFooter from "../Footer";
+import DocItemPaginator from "../Paginator";
+import DocItemTOCDesktop from "../TOC/Desktop";
+import DocItemTOCMobile from "../TOC/Mobile";
+import styles from "./styles.module.css";
+
+/**
+ * Decide if the toc should be rendered, on mobile or desktop viewports
+ */
+function useDocTOC() {
+  const { frontMatter, toc } = useDoc();
+  const windowSize = useWindowSize();
+
+  const hidden = frontMatter.hide_table_of_contents;
+  const canRender = !hidden && toc.length > 0;
+
+  const mobile = canRender ? <DocItemTOCMobile /> : undefined;
+
+  const desktop =
+    canRender && (windowSize === "desktop" || windowSize === "ssr") ? (
+      <DocItemTOCDesktop />
+    ) : undefined;
+
+  return {
+    hidden,
+    mobile,
+    desktop,
+  };
+}
+
+export default function DocItemLayout({ children }: Props): JSX.Element {
+  const docTOC = useDocTOC();
+  const {
+    frontMatter: { api },
+  } = useDoc();
+
+  return (
+    <div className="row">
+      <div className={clsx("col", !docTOC.hidden && styles.docItemCol)}>
+        <DocVersionBanner />
+        <div className={styles.docItemContainer}>
+          <article>
+            <DocBreadcrumbs />
+            <DocVersionBadge />
+            {docTOC.mobile}
+            <DocItemContent>{children}</DocItemContent>
+            <div className={clsx("col", api ? "col--7" : "col--12")}>
+              <DocItemFooter />
+            </div>
+          </article>
+          <div className={clsx("col", api ? "col--7" : "col--12")}>
+            <DocItemPaginator />
+          </div>
+        </div>
+      </div>
+      {docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
+    </div>
+  );
+}

package/src/theme/ApiItem/{styles.module.css → Layout/styles.module.css}

@@ -1,3 +1,10 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
 :root {
   --openapi-required: var(--ifm-color-danger);
   --openapi-code-blue: var(--ifm-color-info);
@@ -6,6 +13,21 @@
   --openapi-code-green: var(--ifm-color-success);
 }
 
+:global(.docs-wrapper) {
+  height: 100%;
+}
+
+.docItemContainer header + *,
+.docItemContainer article > *:first-child {
+  margin-top: 0;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+}
+
 .apiItemContainer article > *:first-child,
 .apiItemContainer header + * {
   margin-top: 0;
@@ -70,10 +92,6 @@
   padding-top: 5px;
 }
 
-:global(.theme-api-markdown details li:last-child) {
-  border-left: none;
-}
-
 :global(.theme-api-markdown details p) {
   margin-bottom: 0;
 }
@@ -147,6 +165,11 @@
   border-bottom-color: var(--ifm-color-success);
 }
 
+:global(.language-python) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--go::after) {
   content: "";
   width: 32px;
@@ -165,6 +188,11 @@
   border-bottom-color: var(--ifm-color-info);
 }
 
+:global(.language-go) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--javascript::after) {
   content: "";
   width: 32px;
@@ -183,6 +211,11 @@
   border-bottom-color: var(--ifm-color-warning);
 }
 
+:global(.language-javascript) {
+  max-height: 500px;
+  overflow: auto;
+}
+
 :global(.code__tab--bash::after) {
   content: "";
   width: 32px;
@@ -200,3 +233,8 @@
 :global(.code__tab--bash.tabs__item--active) {
   border-bottom-color: var(--ifm-color-danger);
 }
+
+:global(.language-bash) {
+  max-height: 500px;
+  overflow: auto;
+}

package/src/theme/ApiItem/Metadata/index.tsx

@@ -0,0 +1,24 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+import { PageMetadata } from "@docusaurus/theme-common";
+// @ts-ignore
+import { useDoc } from "@docusaurus/theme-common/internal";
+
+export default function DocItemMetadata(): JSX.Element {
+  const { metadata, frontMatter, assets } = useDoc();
+  return (
+    <PageMetadata
+      title={metadata.title}
+      description={metadata.description}
+      keywords={frontMatter.keywords}
+      image={assets.image ?? frontMatter.image}
+    />
+  );
+}

package/src/theme/ApiItem/Paginator/index.tsx

@@ -0,0 +1,21 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+// @ts-ignore
+import { useDoc } from "@docusaurus/theme-common/internal";
+import DocPaginator from "@theme/DocPaginator";
+
+/**
+ * This extra component is needed, because <DocPaginator> should remain generic.
+ * DocPaginator is used in non-docs contexts too: generated-index pages...
+ */
+export default function DocItemPaginator(): JSX.Element {
+  const { metadata } = useDoc();
+  return <DocPaginator previous={metadata.previous} next={metadata.next} />;
+}

package/src/theme/ApiItem/TOC/Desktop/index.tsx

@@ -0,0 +1,25 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+import { ThemeClassNames } from "@docusaurus/theme-common";
+// @ts-ignore
+import { useDoc } from "@docusaurus/theme-common/internal";
+import TOC from "@theme/TOC";
+
+export default function DocItemTOCDesktop(): JSX.Element {
+  const { toc, frontMatter } = useDoc();
+  return (
+    <TOC
+      toc={toc}
+      minHeadingLevel={frontMatter.toc_min_heading_level}
+      maxHeadingLevel={frontMatter.toc_max_heading_level}
+      className={ThemeClassNames.docs.docTocDesktop}
+    />
+  );
+}

package/src/theme/ApiItem/TOC/Mobile/index.tsx

@@ -0,0 +1,28 @@
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+import React from "react";
+
+import { ThemeClassNames } from "@docusaurus/theme-common";
+// @ts-ignore
+import { useDoc } from "@docusaurus/theme-common/internal";
+import TOCCollapsible from "@theme/TOCCollapsible";
+import clsx from "clsx";
+
+import styles from "./styles.module.css";
+
+export default function DocItemTOCMobile(): JSX.Element {
+  const { toc, frontMatter } = useDoc();
+  return (
+    <TOCCollapsible
+      toc={toc}
+      minHeadingLevel={frontMatter.toc_min_heading_level}
+      maxHeadingLevel={frontMatter.toc_max_heading_level}
+      className={clsx(ThemeClassNames.docs.docTocMobile, styles.tocMobile)}
+    />
+  );
+}

package/src/theme/ApiItem/TOC/Mobile/styles.module.css

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+@media (min-width: 997px) {
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+@media print {
+  .tocMobile {
+    display: none;
+  }
+}

package/src/theme/ApiItem/index.tsx

@@ -8,27 +8,16 @@
 import React from "react";
 
 import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
-import {
-  PageMetadata,
-  HtmlClassNameProvider,
-  ThemeClassNames,
-  useWindowSize,
-} from "@docusaurus/theme-common";
-import DocBreadcrumbs from "@theme/DocBreadcrumbs";
+import { HtmlClassNameProvider } from "@docusaurus/theme-common";
 import type { Props } from "@theme/DocItem";
-import DocItemFooter from "@theme/DocItemFooter";
-import DocPaginator from "@theme/DocPaginator";
-import DocVersionBadge from "@theme/DocVersionBadge";
-import DocVersionBanner from "@theme/DocVersionBanner";
-import Heading from "@theme/Heading";
-import MDXContent from "@theme/MDXContent";
-import TOC from "@theme/TOC";
-import TOCCollapsible from "@theme/TOCCollapsible";
 import clsx from "clsx";
 import type { ApiItem as ApiItemType } from "docusaurus-plugin-openapi-docs/lib/types";
 
 import { DocFrontMatter } from "../../types";
-import styles from "./styles.module.css";
+import DocItemLayout from "./Layout";
+import DocItemMetadata from "./Metadata";
+
+const { DocProvider } = require("@docusaurus/theme-common/internal");
 
 let ApiDemoPanel = (_: { item: any; infoPath: any }) => (
   <div style={{ marginTop: "3.5em" }} />
@@ -41,125 +30,37 @@ interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 
-function DocItemMetadata(props: Props): JSX.Element {
-  const { content: DocContent } = props;
-  const { metadata, frontMatter, assets } = DocContent;
-  const { keywords } = frontMatter;
-  const { description, title } = metadata;
-  const image = assets.image ?? frontMatter.image;
-
-  return <PageMetadata {...{ title, description, keywords, image }} />;
-}
-
-function DocItemContent(props: Props): JSX.Element {
-  const { content: DocContent } = props;
-  const { metadata, frontMatter } = DocContent;
-  const {
-    info_path: infoPath,
-    hide_title: hideTitle,
-    hide_table_of_contents: hideTableOfContents,
-    toc_min_heading_level: tocMinHeadingLevel,
-    toc_max_heading_level: tocMaxHeadingLevel,
-  } = frontMatter as DocFrontMatter;
-  const { title } = metadata;
-
-  const { api } = frontMatter as ApiFrontMatter;
-
-  // We only add a title if:
-  // - user doesn't ask to hide it with front matter
-  // - the markdown content does not already contain a top-level h1 heading
-  const shouldAddTitle =
-    !hideTitle && typeof DocContent.contentTitle === "undefined";
-
-  const windowSize = useWindowSize();
-
-  const canRenderTOC =
-    !hideTableOfContents && DocContent.toc && DocContent.toc.length > 0;
-
-  const renderTocDesktop =
-    canRenderTOC && (windowSize === "desktop" || windowSize === "ssr");
-
-  return (
-    <div className="row">
-      <div className={clsx("col", !hideTableOfContents && styles.docItemCol)}>
-        <DocVersionBanner />
-        <div className={styles.docItemContainer}>
-          <article>
-            <DocBreadcrumbs />
-            <DocVersionBadge />
+export default function DocItem(props: Props): JSX.Element {
+  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
 
-            {canRenderTOC && (
-              <TOCCollapsible
-                toc={DocContent.toc}
-                minHeadingLevel={tocMinHeadingLevel}
-                maxHeadingLevel={tocMaxHeadingLevel}
-                className={clsx(
-                  ThemeClassNames.docs.docTocMobile,
-                  styles.tocMobile
-                )}
-              />
-            )}
+  const DocContent = () => {
+    const MDXComponent = props.content;
+    const { frontMatter } = MDXComponent;
+    const { info_path: infoPath } = frontMatter as DocFrontMatter;
+    const { api } = frontMatter as ApiFrontMatter;
 
-            <div
-              className={clsx(
-                ThemeClassNames.docs.docMarkdown,
-                "theme-api-markdown",
-                "markdown"
-              )}
-            >
-              {/*
-                Title can be declared inside md content or declared through
-                front matter and added manually. To make both cases consistent,
-                the added title is added under the same div.markdown block
-                See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
-                */}
-              {shouldAddTitle && (
-                <header>
-                  <Heading as="h1">{title}</Heading>
-                </header>
-              )}
-              <MDXContent>
-                <div className="row">
-                  <div className={clsx("col", api ? "col--7" : "col--12")}>
-                    <DocContent />
-                  </div>
-                  {api && (
-                    <div className="col col--5">
-                      <ApiDemoPanel item={api} infoPath={infoPath} />
-                    </div>
-                  )}
-                </div>
-              </MDXContent>
-            </div>
-            <div className={clsx("col", api ? "col--7" : "col--12")}>
-              <DocItemFooter {...props} />
-            </div>
-          </article>
-          <div className={clsx("col", api ? "col--7" : "col--12")}>
-            <DocPaginator previous={metadata.previous} next={metadata.next} />
-          </div>
+    return (
+      <div className="row">
+        <div className={clsx("col", api ? "col--7" : "col--12")}>
+          <MDXComponent />
         </div>
+        {api && (
+          <div className="col col--5">
+            <ApiDemoPanel item={api} infoPath={infoPath} />
+          </div>
+        )}
       </div>
-      {renderTocDesktop && (
-        <div className="col col--3">
-          <TOC
-            toc={DocContent.toc}
-            minHeadingLevel={tocMinHeadingLevel}
-            maxHeadingLevel={tocMaxHeadingLevel}
-            className={ThemeClassNames.docs.docTocDesktop}
-          />
-        </div>
-      )}
-    </div>
-  );
-}
+    );
+  };
 
-export default function DocItem(props: Props): JSX.Element {
-  const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
   return (
-    <HtmlClassNameProvider className={docHtmlClassName}>
-      <DocItemMetadata {...props} />
-      <DocItemContent {...props} />
-    </HtmlClassNameProvider>
+    <DocProvider content={props.content}>
+      <HtmlClassNameProvider className={docHtmlClassName}>
+        <DocItemMetadata />
+        <DocItemLayout>
+          <DocContent />
+        </DocItemLayout>
+      </HtmlClassNameProvider>
+    </DocProvider>
   );
 }

package/src/theme/ApiTabs/index.js

@@ -9,20 +9,22 @@ import React, {
   Children,
   cloneElement,
   isValidElement,
+  useEffect,
   useRef,
   useState,
 } from "react";
 
-import {
-  duplicates,
-  useScrollPositionBlocker,
-  useTabGroupChoice,
-} from "@docusaurus/theme-common";
+import { duplicates } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
 
 import styles from "./styles.module.css"; // A very rough duck type, but good enough to guard against mistakes while
 
+const {
+  useScrollPositionBlocker,
+  useTabGroupChoice,
+} = require("@docusaurus/theme-common/internal");
+
 // allowing customization
 
 function isTabItem(comp) {
@@ -142,7 +144,16 @@ function ApiTabsComponent(props) {
   };
 
   const tabItemListContainerRef = useRef(null);
-  const showTabArrows = values.length >= 5;
+  const [showTabArrows, setShowTabArrows] = useState(false);
+
+  useEffect(() => {
+    const tabOffsetWidth = tabItemListContainerRef.current.offsetWidth;
+    const tabScrollWidth = tabItemListContainerRef.current.scrollWidth;
+
+    if (tabOffsetWidth < tabScrollWidth) {
+      setShowTabArrows(true);
+    }
+  }, []);
 
   const handleRightClick = () => {
     tabItemListContainerRef.current.scrollLeft += 90;

package/src/theme/ApiTabs/styles.module.css

@@ -87,7 +87,6 @@
   content: "";
   height: 1.25rem;
   width: 1.25rem;
-  padding: 0 0.75rem;
   border: none;
   min-width: 1.25rem;
   background: var(--ifm-menu-link-sublist-icon) 50% / 2rem 2rem;