docusaurus-theme-openapi-docs 3.0.0-beta.1 → 3.0.0-beta.10

package/lib/theme/MimeTabs/index.js

@@ -1,22 +1,67 @@
+"use strict";
 /* ============================================================================
  * 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, { cloneElement, useEffect, useState, useRef } from "react";
-
-import {
-  useScrollPositionBlocker,
-  useTabs,
-} from "@docusaurus/theme-common/internal";
-import useIsBrowser from "@docusaurus/useIsBrowser";
-import { setAccept } from "@theme/ApiExplorer/Accept/slice";
-import { setContentType } from "@theme/ApiExplorer/ContentType/slice";
-import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
-import clsx from "clsx";
-
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const slice_1 = __importDefault(require("@theme/ApiExplorer/Accept/slice"));
+const slice_2 = require("@theme/ApiExplorer/ContentType/slice");
+const hooks_1 = require("@theme/ApiItem/hooks");
+const clsx_1 = __importDefault(require("clsx"));
 function TabList({
   className,
   block,
@@ -26,18 +71,21 @@ function TabList({
   schemaType,
 }) {
   const tabRefs = [];
-  const { blockElementScrollPositionUntilNextRender } =
-    useScrollPositionBlocker();
-
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
   // custom
-  const dispatch = useTypedDispatch();
+  const dispatch = (0, hooks_1.useTypedDispatch)();
   const isRequestSchema = schemaType?.toLowerCase() === "request";
-
-  const [selectedValue, setSelectedValue] = useState(selectedValueProp);
-  const contentTypeVal = useTypedSelector((state) => state.contentType.value);
-  const acceptTypeVal = useTypedSelector((state) => state.accept.value);
-
-  useEffect(() => {
+  const [selectedValue, setSelectedValue] = (0, react_1.useState)(
+    selectedValueProp
+  );
+  const contentTypeVal = (0, hooks_1.useTypedSelector)(
+    (state) => state.contentType.value
+  );
+  const acceptTypeVal = (0, hooks_1.useTypedSelector)(
+    (state) => state.accept.value
+  );
+  (0, react_1.useEffect)(() => {
     if (tabRefs.length > 1) {
       if (isRequestSchema) {
         setSelectedValue(contentTypeVal);
@@ -47,7 +95,6 @@ function TabList({
     }
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [contentTypeVal, acceptTypeVal]);
-
   const handleTabChange = (event) => {
     event.preventDefault();
     const newTab = event.currentTarget;
@@ -56,15 +103,14 @@ function TabList({
     // custom
     if (newTabValue !== selectedValue) {
       if (isRequestSchema) {
-        dispatch(setContentType(newTabValue));
+        dispatch((0, slice_2.setContentType)(newTabValue));
       } else {
-        dispatch(setAccept(newTabValue));
+        dispatch((0, slice_1.default)(newTabValue));
       }
       blockElementScrollPositionUntilNextRender(newTab);
       selectValue(newTabValue);
     }
   };
-
   const handleKeydown = (event) => {
     let focusElement = null;
     switch (event.key) {
@@ -87,135 +133,140 @@ function TabList({
     }
     focusElement?.focus();
   };
-
-  const tabItemListContainerRef = useRef(null);
-  const [showTabArrows, setShowTabArrows] = useState(false);
-
-  useEffect(() => {
+  const tabItemListContainerRef = (0, react_1.useRef)(null);
+  const [showTabArrows, setShowTabArrows] = (0, react_1.useState)(false);
+  (0, react_1.useEffect)(() => {
     const resizeObserver = new ResizeObserver((entries) => {
       for (let entry of entries) {
-        if (entry.target.offsetWidth < entry.target.scrollWidth) {
-          setShowTabArrows(true);
-        } else {
-          setShowTabArrows(false);
-        }
+        requestAnimationFrame(() => {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
+            setShowTabArrows(true);
+          } else {
+            setShowTabArrows(false);
+          }
+        });
       }
     });
-
     resizeObserver.observe(tabItemListContainerRef.current);
-
     return () => {
       resizeObserver.disconnect();
     };
   }, []);
-
   const handleRightClick = () => {
     tabItemListContainerRef.current.scrollLeft += 90;
   };
-
   const handleLeftClick = () => {
     tabItemListContainerRef.current.scrollLeft -= 90;
   };
-
-  return (
-    <div className="tabs__container">
-      <div className="openapi-tabs__mime-container">
-        {showTabArrows && (
-          <button
-            className={clsx("openapi-tabs__arrow", "left")}
-            onClick={handleLeftClick}
-          />
-        )}
-        <ul
-          ref={tabItemListContainerRef}
-          role="tablist"
-          aria-orientation="horizontal"
-          className={clsx(
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs__container" },
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-tabs__mime-container" },
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("openapi-tabs__arrow", "left"),
+          onClick: handleLeftClick,
+        }),
+      react_1.default.createElement(
+        "ul",
+        {
+          ref: tabItemListContainerRef,
+          role: "tablist",
+          "aria-orientation": "horizontal",
+          className: (0, clsx_1.default)(
             "openapi-tabs__mime-list-container",
             "tabs",
             {
               "tabs--block": block,
             },
             className
-          )}
-        >
-          {tabValues.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={(e) => handleTabChange(e)}
-                {...attributes}
-                className={clsx(
-                  "tabs__item",
-                  "openapi-tabs__mime-item",
-                  attributes?.className,
-                  {
-                    active: selectedValue === value,
-                  }
-                )}
-              >
-                {label ?? value}
-              </li>
-            );
-          })}
-        </ul>
-        {showTabArrows && (
-          <button
-            className={clsx("openapi-tabs__arrow", "right")}
-            onClick={handleRightClick}
-          />
-        )}
-      </div>
-    </div>
+          ),
+        },
+        tabValues.map(({ value, label, attributes }) => {
+          return react_1.default.createElement(
+            "li",
+            {
+              role: "tab",
+              tabIndex: selectedValue === value ? 0 : -1,
+              "aria-selected": selectedValue === value,
+              key: value,
+              ref: (tabControl) => tabRefs.push(tabControl),
+              onKeyDown: handleKeydown,
+              onFocus: handleTabChange,
+              onClick: (e) => handleTabChange(e),
+              ...attributes,
+              className: (0, clsx_1.default)(
+                "tabs__item",
+                "openapi-tabs__mime-item",
+                attributes?.className,
+                {
+                  active: selectedValue === value,
+                }
+              ),
+            },
+            label ?? value
+          );
+        })
+      ),
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("openapi-tabs__arrow", "right"),
+          onClick: handleRightClick,
+        })
+    )
   );
 }
 function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  );
   if (lazy) {
-    const selectedTabItem = children.find(
+    const selectedTabItem = childTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
       // fail-safe or fail-fast? not sure what's best here
       return null;
     }
-    return cloneElement(selectedTabItem, { className: "margin-top--md" });
+    return (0, react_1.cloneElement)(selectedTabItem, {
+      className: "margin-top--md",
+    });
   }
-  return (
-    <div className="margin-top--md">
-      {children.map((tabItem, i) =>
-        cloneElement(tabItem, {
-          key: i,
-          hidden: tabItem.props.value !== selectedValue,
-        })
-      )}
-    </div>
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md" },
+    childTabs.map((tabItem, i) =>
+      (0, react_1.cloneElement)(tabItem, {
+        key: i,
+        hidden: tabItem.props.value !== selectedValue,
+      })
+    )
   );
 }
 function TabsComponent(props) {
-  const tabs = useTabs(props);
-  return (
-    <div className="tabs-container">
-      <TabList {...props} {...tabs} />
-      <TabContent {...props} {...tabs} />
-    </div>
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs-container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
   );
 }
-export default function MimeTabs(props) {
-  const isBrowser = useIsBrowser();
-  return (
-    <TabsComponent
+function MimeTabs(props) {
+  const isBrowser = (0, useIsBrowser_1.default)();
+  return react_1.default.createElement(
+    TabsComponent,
+    // Remount tabs after hydration
+    // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+    {
       // Remount tabs after hydration
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
-      key={String(isBrowser)}
-      {...props}
-    />
+      key: String(isBrowser),
+      ...props,
+    },
+    (0, internal_1.sanitizeTabsChildren)(props.children)
   );
 }
+exports.default = MimeTabs;

package/lib/theme/OperationTabs/_OperationTabs.scss

@@ -0,0 +1,71 @@
+/**
+ * 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.
+ */
+
+.openapi-tabs__operation-container {
+  display: flex;
+  align-items: center;
+  overflow: hidden;
+}
+
+.openapi-tabs__operation-header {
+  margin-bottom: 0;
+}
+
+.openapi-tabs__operation-item {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  padding: 0.35rem 0.7rem;
+  border: 1px solid transparent;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  font-weight: var(--ifm-font-weight-bold);
+  font-size: 12px;
+  white-space: nowrap;
+  transition: 300ms;
+
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
+
+  &.active {
+    border: 1px solid var(--ifm-tabs-color-active-border);
+    color: var(--ifm-tabs-color-active);
+  }
+
+  &:last-child {
+    margin-right: 0 !important;
+  }
+}
+
+.openapi-tabs__operation-list-container {
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+
+  &::-webkit-scrollbar {
+    display: none;
+  }
+}
+
+.openapi-tabs__operation-schema-container {
+  max-width: 600px;
+}
+
+@media screen and (max-width: 500px) {
+  .operationTabsTopSection {
+    flex-direction: column;
+    align-items: flex-start;
+  }
+
+  .operationTabsContainer {
+    width: 100%;
+    margin-top: var(--ifm-spacing-vertical);
+    padding: 0;
+  }
+}

package/lib/theme/OperationTabs/index.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+import { TabProps } from "@docusaurus/theme-common/internal";
+export default function OperationTabs(props: TabProps): React.JSX.Element;

package/lib/theme/OperationTabs/index.js

@@ -0,0 +1,234 @@
+"use strict";
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+var __createBinding =
+  (this && this.__createBinding) ||
+  (Object.create
+    ? function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (
+          !desc ||
+          ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)
+        ) {
+          desc = {
+            enumerable: true,
+            get: function () {
+              return m[k];
+            },
+          };
+        }
+        Object.defineProperty(o, k2, desc);
+      }
+    : function (o, m, k, k2) {
+        if (k2 === undefined) k2 = k;
+        o[k2] = m[k];
+      });
+var __setModuleDefault =
+  (this && this.__setModuleDefault) ||
+  (Object.create
+    ? function (o, v) {
+        Object.defineProperty(o, "default", { enumerable: true, value: v });
+      }
+    : function (o, v) {
+        o["default"] = v;
+      });
+var __importStar =
+  (this && this.__importStar) ||
+  function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null)
+      for (var k in mod)
+        if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k))
+          __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+  };
+var __importDefault =
+  (this && this.__importDefault) ||
+  function (mod) {
+    return mod && mod.__esModule ? mod : { default: mod };
+  };
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importStar(require("react"));
+const internal_1 = require("@docusaurus/theme-common/internal");
+const useIsBrowser_1 = __importDefault(require("@docusaurus/useIsBrowser"));
+const clsx_1 = __importDefault(require("clsx"));
+function TabList({ className, block, selectedValue, selectValue, tabValues }) {
+  const tabRefs = [];
+  const { blockElementScrollPositionUntilNextRender } = (0,
+  internal_1.useScrollPositionBlocker)();
+  const handleTabChange = (event) => {
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex].value;
+    if (newTabValue !== selectedValue) {
+      blockElementScrollPositionUntilNextRender(newTab);
+      selectValue(newTabValue);
+    }
+  };
+  const handleKeydown = (event) => {
+    let focusElement = null;
+    switch (event.key) {
+      case "Enter": {
+        handleTabChange(event);
+        break;
+      }
+      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 = (0, react_1.useRef)(null);
+  const [showTabArrows, setShowTabArrows] = (0, react_1.useState)(false);
+  (0, react_1.useEffect)(() => {
+    const resizeObserver = new ResizeObserver((entries) => {
+      for (let entry of entries) {
+        requestAnimationFrame(() => {
+          if (entry.target.clientWidth < entry.target.scrollWidth) {
+            setShowTabArrows(true);
+          } else {
+            setShowTabArrows(false);
+          }
+        });
+      }
+    });
+    resizeObserver.observe(tabItemListContainerRef.current);
+    return () => {
+      resizeObserver.disconnect();
+    };
+  }, []);
+  const handleRightClick = () => {
+    tabItemListContainerRef.current.scrollLeft += 90;
+  };
+  const handleLeftClick = () => {
+    tabItemListContainerRef.current.scrollLeft -= 90;
+  };
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs__container" },
+    react_1.default.createElement(
+      "div",
+      { className: "openapi-tabs__operation-container" },
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("openapi-tabs__arrow", "left"),
+          onClick: handleLeftClick,
+        }),
+      react_1.default.createElement(
+        "ul",
+        {
+          ref: tabItemListContainerRef,
+          role: "tablist",
+          "aria-orientation": "horizontal",
+          className: (0, clsx_1.default)(
+            "openapi-tabs__operation-list-container",
+            "tabs",
+            {
+              "tabs--block": block,
+            },
+            className
+          ),
+        },
+        tabValues.map(({ value, label, attributes }) => {
+          return react_1.default.createElement(
+            "li",
+            {
+              // TODO extract TabListItem
+              role: "tab",
+              tabIndex: selectedValue === value ? 0 : -1,
+              "aria-selected": selectedValue === value,
+              key: value,
+              ref: (tabControl) => tabRefs.push(tabControl),
+              onKeyDown: handleKeydown,
+              onFocus: handleTabChange,
+              onClick: (e) => handleTabChange(e),
+              ...attributes,
+              className: (0, clsx_1.default)(
+                "tabs__item",
+                "openapi-tabs__operation-item",
+                attributes?.className,
+                {
+                  active: selectedValue === value,
+                }
+              ),
+            },
+            label ?? value
+          );
+        })
+      ),
+      showTabArrows &&
+        react_1.default.createElement("button", {
+          className: (0, clsx_1.default)("openapi-tabs__arrow", "right"),
+          onClick: handleRightClick,
+        })
+    )
+  );
+}
+function TabContent({ lazy, children, selectedValue }) {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  );
+  if (lazy) {
+    const selectedTabItem = childTabs.find(
+      (tabItem) => tabItem.props.value === selectedValue
+    );
+    if (!selectedTabItem) {
+      // fail-safe or fail-fast? not sure what's best here
+      return null;
+    }
+    return (0, react_1.cloneElement)(selectedTabItem, {
+      className: "margin-top--md",
+    });
+  }
+  return react_1.default.createElement(
+    "div",
+    { className: "margin-top--md" },
+    childTabs.map((tabItem, i) =>
+      (0, react_1.cloneElement)(tabItem, {
+        key: i,
+        hidden: tabItem.props.value !== selectedValue,
+      })
+    )
+  );
+}
+function TabsComponent(props) {
+  const tabs = (0, internal_1.useTabs)(props);
+  return react_1.default.createElement(
+    "div",
+    { className: "tabs-container" },
+    react_1.default.createElement(TabList, { ...props, ...tabs }),
+    react_1.default.createElement(TabContent, { ...props, ...tabs })
+  );
+}
+function OperationTabs(props) {
+  const isBrowser = (0, useIsBrowser_1.default)();
+  return react_1.default.createElement(
+    TabsComponent,
+    // Remount tabs after hydration
+    // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+    {
+      // Remount tabs after hydration
+      // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
+      key: String(isBrowser),
+      ...props,
+    },
+    (0, internal_1.sanitizeTabsChildren)(props.children)
+  );
+}
+exports.default = OperationTabs;