docusaurus-theme-openapi-docs 1.0.6 → 1.1.2

package/lib-next/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/lib-next/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;

package/lib-next/theme/SchemaTabs/index.js

@@ -0,0 +1,258 @@
+/* ============================================================================
+ * 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, {
+  Children,
+  cloneElement,
+  isValidElement,
+  useEffect,
+  useRef,
+  useState,
+} from "react";
+
+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) {
+  return typeof comp.props.value !== "undefined";
+}
+
+function SchemaTabsComponent(props) {
+  const {
+    lazy,
+    block,
+    defaultValue: defaultValueProp,
+    values: valuesProp,
+    groupId,
+    className,
+  } = props;
+  const children = Children.map(props.children, (child) => {
+    if (isValidElement(child) && isTabItem(child)) {
+      return child;
+    } // child.type.name will give non-sensical values in prod because of
+    // minification, but we assume it won't throw in prod.
+
+    throw new Error(
+      `Docusaurus error: Bad <Tabs> child <${
+        // @ts-expect-error: guarding against unexpected cases
+        typeof child.type === "string" ? child.type : child.type.name
+      }>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`
+    );
+  });
+  const values =
+    valuesProp ?? // We only pick keys that we recognize. MDX would inject some keys by default
+    children.map(({ props: { value, label, attributes } }) => ({
+      value,
+      label,
+      attributes,
+    }));
+  const dup = duplicates(values, (a, b) => a.value === b.value);
+
+  if (dup.length > 0) {
+    throw new Error(
+      `Docusaurus error: Duplicate values "${dup
+        .map((a) => a.value)
+        .join(", ")}" found in <Tabs>. Every value needs to be unique.`
+    );
+  } // When defaultValueProp is null, don't show a default tab
+
+  const defaultValue =
+    defaultValueProp === null
+      ? defaultValueProp
+      : defaultValueProp ??
+        children.find((child) => child.props.default)?.props.value ??
+        children[0]?.props.value;
+
+  if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
+    throw new Error(
+      `Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
+        .map((a) => a.value)
+        .join(
+          ", "
+        )}. If you intend to show no default tab, use defaultValue={null} instead.`
+    );
+  }
+
+  const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
+  const [selectedValue, setSelectedValue] = useState(defaultValue);
+  const tabRefs = [];
+  const { blockElementScrollPositionUntilNextRender } =
+    useScrollPositionBlocker();
+
+  if (groupId != null) {
+    const relevantTabGroupChoice = tabGroupChoices[groupId];
+
+    if (
+      relevantTabGroupChoice != null &&
+      relevantTabGroupChoice !== selectedValue &&
+      values.some((value) => value.value === relevantTabGroupChoice)
+    ) {
+      setSelectedValue(relevantTabGroupChoice);
+    }
+  }
+
+  const handleTabChange = (event) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = values[newTabIndex].value;
+
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      setSelectedValue(newTabValue);
+
+      if (groupId != null) {
+        setTabGroupChoices(groupId, newTabValue);
+      }
+    }
+  };
+
+  const handleKeydown = (event) => {
+    let focusElement = null;
+
+    switch (event.key) {
+      case "ArrowRight": {
+        const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
+        focusElement = tabRefs[nextTab] || tabRefs[0];
+        break;
+      }
+
+      case "ArrowLeft": {
+        const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
+        focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
+        break;
+      }
+
+      default:
+        break;
+    }
+
+    focusElement?.focus();
+  };
+
+  const tabItemListContainerRef = useRef(null);
+  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;
+  };
+
+  const handleLeftClick = () => {
+    tabItemListContainerRef.current.scrollLeft -= 90;
+  };
+
+  return (
+    <div className="tabs__container">
+      <div className={styles.schemaTabsTopSection}>
+        <div className={styles.schemaTabsContainer}>
+          {showTabArrows && (
+            <button
+              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
+              onClick={handleLeftClick}
+            />
+          )}
+          <ul
+            ref={tabItemListContainerRef}
+            role="tablist"
+            aria-orientation="horizontal"
+            className={clsx(
+              styles.schemaTabsListContainer,
+              "tabs",
+              {
+                "tabs--block": block,
+              },
+              className
+            )}
+          >
+            {values.map(({ value, label, attributes }) => {
+              return (
+                <li
+                  role="tab"
+                  tabIndex={selectedValue === value ? 0 : -1}
+                  aria-selected={selectedValue === value}
+                  key={value}
+                  ref={(tabControl) => tabRefs.push(tabControl)}
+                  onKeyDown={handleKeydown}
+                  onFocus={handleTabChange}
+                  onClick={handleTabChange}
+                  {...attributes}
+                  className={clsx(
+                    "tabs__item",
+                    styles.tabItem,
+                    attributes?.className,
+                    {
+                      [styles.schemaTabActive]: selectedValue === value,
+                    }
+                  )}
+                >
+                  <span className={styles.schemaTabLabel}>
+                    {label ?? value}
+                  </span>
+                </li>
+              );
+            })}
+          </ul>
+          {showTabArrows && (
+            <button
+              className={clsx(styles.tabArrow, styles.tabArrowRight)}
+              onClick={handleRightClick}
+            />
+          )}
+        </div>
+      </div>
+      <hr />
+      {lazy ? (
+        cloneElement(
+          children.filter(
+            (tabItem) => tabItem.props.value === selectedValue
+          )[0],
+          {
+            className: clsx("margin-vert--md", styles.schemaTabsContainer),
+          }
+        )
+      ) : (
+        <div className={clsx("margin-vert--md", styles.schemaTabsContainer)}>
+          {children.map((tabItem, i) =>
+            cloneElement(tabItem, {
+              key: i,
+              hidden: tabItem.props.value !== selectedValue,
+            })
+          )}
+        </div>
+      )}
+    </div>
+  );
+}
+
+export default function SchemaTabs(props) {
+  const isBrowser = useIsBrowser();
+  return (
+    <SchemaTabsComponent // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key={String(isBrowser)}
+      {...props}
+    />
+  );
+}

package/lib-next/theme/SchemaTabs/styles.module.css

@@ -0,0 +1,110 @@
+/**
+ * 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.
+ */
+
+.tabItem {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  height: 1.8rem;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  border: 1px solid var(--openapi-code-dim-dark);
+  border-radius: var(--ifm-global-radius);
+  color: var(--openapi-code-dim-dark);
+  font-size: 12px;
+}
+
+.tabItem:hover {
+  color: var(--ifm-color-emphasis-500) !important;
+}
+
+.tabItem:last-child {
+  margin-right: 0 !important;
+}
+
+/* Open API Schema Tabs */
+.schemaTabsTopSection {
+  margin-top: 1rem;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+}
+
+.schemaTabsTopSection + hr {
+  display: none;
+}
+
+.schemaTabsContainer {
+  display: flex;
+  align-items: center;
+  max-width: 390px;
+  padding-left: 3px;
+  overflow: hidden;
+}
+
+.schemaTabsListContainer {
+  padding: 0 0.25rem;
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+}
+
+.schemaTabsListContainer::-webkit-scrollbar {
+  display: none;
+}
+
+.tabItem.schemaTabActive {
+  border: 1px solid var(--ifm-color-primary);
+  color: var(--ifm-color-primary);
+}
+
+.schemaTabLabel {
+  white-space: nowrap;
+}
+
+.schemaTabsContainer {
+  max-width: 600px;
+}
+
+/* Tab Arrows */
+.tabArrow {
+  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;
+  filter: var(--ifm-menu-link-sublist-icon-filter);
+}
+
+.tabArrow:hover {
+  cursor: pointer;
+}
+
+.tabArrowLeft {
+  transform: rotate(270deg);
+}
+
+.tabArrowRight {
+  transform: rotate(90deg);
+}
+
+@media screen and (max-width: 500px) {
+  .schemaTabsTopSection {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .schemaTabsContainer {
+    width: 100%;
+  }
+
+  .tabItem {
+    height: 100%;
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "1.0.6",
+  "version": "1.1.2",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -31,8 +31,8 @@
     "format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.21",
-    "@docusaurus/types": "2.0.0-beta.21",
+    "@docusaurus/module-type-aliases": "2.0.0-rc.1",
+    "@docusaurus/types": "2.0.0-rc.1",
     "@types/concurrently": "^6.3.0",
     "@types/crypto-js": "^4.1.0",
     "@types/fs-extra": "^9.0.13",
@@ -42,7 +42,7 @@
     "concurrently": "^5.2.0"
   },
   "dependencies": {
-    "@docusaurus/theme-common": "2.0.0-beta.21",
+    "@docusaurus/theme-common": "2.0.0-rc.1",
     "@mdx-js/react": "^1.6.21",
     "@paloaltonetworks/postman-code-generators": "1.1.5-hotfix.5",
     "@paloaltonetworks/postman-collection": "^4.1.0",
@@ -50,7 +50,7 @@
     "buffer": "^6.0.3",
     "clsx": "^1.1.1",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "^1.0.6",
+    "docusaurus-plugin-openapi-docs": "^1.1.2",
     "immer": "^9.0.7",
     "lodash": "^4.17.20",
     "process": "^0.11.10",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "ff7622e334e96e7f39b0daf5ef2cb17bfa832834"
+  "gitHead": "0c66efff6ff553647265abdc27d4ca847c6d8045"
 }

package/src/theme/ApiDemoPanel/CodeTabs/index.tsx

@@ -12,11 +12,7 @@ import React, {
   type ReactElement,
 } from "react";
 
-import {
-  useScrollPositionBlocker,
-  duplicates,
-  useTabGroupChoice,
-} from "@docusaurus/theme-common";
+import { duplicates } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import type { Props as TabItemProps } from "@theme/TabItem";
 import clsx from "clsx";
@@ -24,6 +20,11 @@ import clsx from "clsx";
 import { languageSet } from "../Curl";
 import styles from "./styles.module.css";
 
+const {
+  useScrollPositionBlocker,
+  useTabGroupChoice,
+} = require("@docusaurus/theme-common/internal");
+
 // A very rough duck type, but good enough to guard against mistakes while
 // allowing customization
 function isTabItem(

package/src/theme/ApiDemoPanel/FloatingButton/index.tsx

@@ -17,8 +17,12 @@ interface Props {
 
 function FloatingButton({ label, onClick, children }: Props) {
   return (
-    <div className={styles.floatingButton}>
-      {label && <button onClick={onClick}>{label}</button>}
+    <div tabIndex={0} className={styles.floatingButton}>
+      {label && (
+        <button tabIndex={0} onClick={onClick}>
+          {label}
+        </button>
+      )}
       {children}
     </div>
   );

package/src/theme/ApiDemoPanel/FloatingButton/styles.module.css

@@ -9,7 +9,6 @@
   border-radius: var(--ifm-global-radius);
   color: var(--ifm-color-white);
   cursor: pointer;
-  outline: none;
   padding: 0.4rem 0.5rem;
   opacity: 0;
   visibility: hidden;
@@ -20,7 +19,9 @@
   right: calc(var(--ifm-pre-padding) / 2);
 }
 
-.floatingButton:hover button {
+.floatingButton:hover button,
+.floatingButton:focus-visible button,
+.floatingButton button:focus-visible {
   visibility: visible;
   opacity: 1;
 }

package/src/theme/ApiDemoPanel/LiveEditor/index.tsx

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React from "react";
+import React, { useState } from "react";
 
 import { usePrismTheme } from "@docusaurus/theme-common";
 import useIsBrowser from "@docusaurus/useIsBrowser";
@@ -16,14 +16,26 @@ import styles from "./styles.module.css";
 
 function Live({ onEdit }: any) {
   const isBrowser = useIsBrowser();
+  const [editorDisabled, setEditorDisabled] = useState(false);
+
+  // TODO: Temporary solution for disabling tab key
+  const handleKeydown = (event: React.KeyboardEvent) => {
+    if (event.key === "Tab") {
+      event.preventDefault();
+      setEditorDisabled(true);
+    }
+  };
+
   return (
-    <>
+    <div onClick={() => setEditorDisabled(false)}>
       <LiveEditor
         key={String(isBrowser)}
         className={styles.playgroundEditor}
         onChange={onEdit}
+        disabled={editorDisabled}
+        onKeyDown={handleKeydown}
       />
-    </>
+    </div>
   );
 }
 

package/src/theme/ApiDemoPanel/LiveEditor/styles.module.css

@@ -3,7 +3,8 @@
   margin-bottom: var(--ifm-leading);
   border-radius: var(--ifm-global-radius);
   box-shadow: var(--ifm-global-shadow-lw);
-  overflow: hidden;
+  overflow: auto;
+  max-height: 500px;
 }
 
 .playgroundHeader {

package/src/theme/ApiDemoPanel/ParamOptions/styles.module.css

@@ -41,10 +41,6 @@
   display: block;
 }
 
-.showMoreButton:focus {
-  outline: 0;
-}
-
 .showMoreButton:hover {
   /* text-decoration: underline; */
   /* background-color: red; */

package/src/theme/ApiDemoPanel/Server/index.tsx

@@ -26,7 +26,7 @@ function Server() {
     return null;
   }
 
-  if (options.length <= 1 && value?.variables === undefined) {
+  if (options.length < 1 && value?.variables === undefined) {
     return null;
   }
 
@@ -62,10 +62,11 @@ function Server() {
       <button
         className={styles.showMoreButton}
         onClick={() => setIsEditing(false)}
+        tabIndex={0}
       >
         Hide
       </button>
-      <FormItem label="Endpoint">
+      <FormItem label="Base URL">
         <FormSelect
           options={options.map((s) => s.url)}
           onChange={(e) => dispatch(setServer(e.target.value))}

package/src/theme/ApiDemoPanel/Server/styles.module.css

@@ -28,10 +28,6 @@
   display: block;
 }
 
-.showMoreButton:focus {
-  outline: 0;
-}
-
 .showMoreButton:hover {
   /* text-decoration: underline; */
   /* background-color: red; */

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

@@ -0,0 +1,57 @@
+/* ============================================================================
+ * 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 type { Props } from "@theme/DocItem/Content";
+import Heading from "@theme/Heading";
+import MDXContent from "@theme/MDXContent";
+import clsx from "clsx";
+
+/**
+ 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
+
+ We render a "synthetic title" if:
+ - user doesn't ask to hide it with front matter
+ - the markdown content does not already contain a top-level h1 heading
+*/
+function useSyntheticTitle(): string | null {
+  const { metadata, frontMatter, contentTitle } = useDoc();
+  const shouldRender =
+    !frontMatter.hide_title && typeof contentTitle === "undefined";
+  if (!shouldRender) {
+    return null;
+  }
+  return metadata.title;
+}
+
+export default function DocItemContent({ children }: Props): JSX.Element {
+  const syntheticTitle = useSyntheticTitle();
+
+  return (
+    <div
+      className={clsx(
+        ThemeClassNames.docs.docMarkdown,
+        "theme-api-markdown",
+        "markdown"
+      )}
+    >
+      {syntheticTitle && (
+        <header>
+          <Heading as="h1">{syntheticTitle}</Heading>
+        </header>
+      )}
+      <MDXContent>{children}</MDXContent>
+    </div>
+  );
+}