docusaurus-theme-openapi-docs 0.0.0-618 → 0.0.0-684

package/src/theme/SchemaItem/index.js

@@ -9,17 +9,13 @@ import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
 /* eslint-disable import/no-extraneous-dependencies*/
+import clsx from "clsx";
 import { createDescription } from "docusaurus-theme-openapi-docs/lib/markdown/createDescription";
 /* eslint-disable import/no-extraneous-dependencies*/
-import {
-  guard,
-  toString,
-} from "docusaurus-theme-openapi-docs/lib/markdown/utils";
+import { guard } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
-import styles from "./styles.module.css";
-
 function SchemaItem({
   children: collapsibleSchemaContent,
   collapsible,
@@ -28,7 +24,6 @@ function SchemaItem({
   required,
   schemaName,
   schema,
-  discriminator,
 }) {
   let deprecated;
   let schemaDescription;
@@ -43,15 +38,15 @@ function SchemaItem({
 
   const renderRequired = guard(
     Array.isArray(required) ? required.includes(name) : required,
-    () => <strong className={styles.required}> required</strong>
+    () => <span className="openapi-schema__required">required</span>
   );
 
   const renderDeprecated = guard(deprecated, () => (
-    <strong className={styles.deprecated}> deprecated</strong>
+    <span className="openapi-schema__deprecated">deprecated</span>
   ));
 
   const renderNullable = guard(nullable, () => (
-    <strong className={styles.nullable}> nullable</strong>
+    <span className="openapi-schema__nullable">nullable</span>
   ));
 
   const renderSchemaDescription = guard(schemaDescription, (description) => (
@@ -76,7 +71,7 @@ function SchemaItem({
   ));
 
   const renderQualifierMessage = guard(qualifierMessage, (message) => (
-    <div className={styles.schemaQualifierMessage}>
+    <div>
       <ReactMarkdown
         children={createDescription(message)}
         rehypePlugins={[rehypeRaw]}
@@ -84,19 +79,33 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(toString(defaultValue), (value) => (
-    <div className={styles.schemaQualifierMessage}>
-      <ReactMarkdown children={`**Default value:** \`${value}\``} />
-    </div>
-  ));
+  const renderDefaultValue = guard(
+    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
+    (value) => (
+      <div className="">
+        <ReactMarkdown children={`**Default value:** \`${value}\``} />
+      </div>
+    )
+  );
 
   const schemaContent = (
     <div>
-      <strong className={deprecated && styles.strikethrough}>{name}</strong>
-      <span className={styles.schemaName}> {schemaName}</span>
-      {renderNullable}
-      {!deprecated && renderRequired}
-      {renderDeprecated}
+      <span className="openapi-schema__container">
+        <strong
+          className={clsx("openapi-schema__property", {
+            "openapi-schema__strikethrough": deprecated,
+          })}
+        >
+          {name}
+        </strong>
+        <span className="openapi-schema__name"> {schemaName}</span>
+        {(nullable || required || deprecated) && (
+          <span className="openapi-schema__divider"></span>
+        )}
+        {renderNullable}
+        {!deprecated && renderRequired}
+        {renderDeprecated}
+      </span>
       {renderQualifierMessage}
       {renderDefaultValue}
       {renderSchemaDescription}
@@ -105,7 +114,7 @@ function SchemaItem({
   );
 
   return (
-    <div className={styles.schemaItem}>
+    <div className="openapi-schema__list-item">
       {collapsible ? collapsibleSchemaContent : schemaContent}
     </div>
   );

package/src/theme/SchemaTabs/_SchemaTabs.scss

@@ -0,0 +1,64 @@
+/**
+ * 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__schema-container {
+  margin-top: 1rem;
+}
+
+.openapi-tabs__schema-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-family: var(--ifm-font-family-monospace);
+  font-size: 10px;
+  white-space: nowrap;
+  transition: 300ms;
+
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
+
+  &.active {
+    border: 1px solid var(--ifm-color-primary);
+    color: var(--ifm-color-primary);
+  }
+
+  &:last-child {
+    margin-right: 0 !important;
+  }
+}
+
+.openapi-tabs__schema-list-container {
+  overflow-y: hidden;
+  overflow-x: scroll;
+  scroll-behavior: smooth;
+
+  &::-webkit-scrollbar {
+    display: none;
+  }
+
+  &.active {
+    background-color: var(--ifm-color-emphasis-100);
+  }
+}
+
+.openapi-tabs__schema-label {
+  white-space: nowrap;
+}
+
+.openapi-tabs__schema-tabs-container {
+  width: 100%;
+  display: flex;
+  align-items: center;
+  overflow: hidden;
+}

package/src/theme/SchemaTabs/index.js

@@ -5,141 +5,49 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, {
-  Children,
-  cloneElement,
-  isValidElement,
-  useEffect,
-  useRef,
-  useState,
-} from "react";
+import React, { cloneElement, useRef, useEffect, useState } from "react";
 
-import { duplicates } from "@docusaurus/theme-common";
+import {
+  useScrollPositionBlocker,
+  useTabs,
+} from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
+import flatten from "lodash/flatten";
 
-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);
+function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   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;
-
+    const newTabValue = tabValues[newTabIndex].value;
     if (newTabValue !== selectedValue) {
       blockElementScrollPositionUntilNextRender(newTab);
-      setSelectedValue(newTabValue);
-
-      if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
-      }
+      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];
+        focusElement = tabRefs[nextTab] ?? tabRefs[0];
         break;
       }
-
       case "ArrowLeft": {
         const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
-        focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
+        focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
         break;
       }
-
       default:
         break;
     }
-
     focusElement?.focus();
   };
 
@@ -173,95 +81,99 @@ function SchemaTabsComponent(props) {
   };
 
   return (
-    <div className="tabs__container">
-      <div className={styles.schemaTabsTopSection}>
-        <div className={styles.schemaTabsContainer}>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
-              onClick={handleLeftClick}
-            />
-          )}
-          <div
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
+    <div className="openapi-tabs__schema-tabs-container">
+      {showTabArrows && (
+        <button
+          className="openapi-tabs__arrow left"
+          onClick={handleLeftClick}
+        />
+      )}
+      <ul
+        ref={tabItemListContainerRef}
+        role="tablist"
+        aria-orientation="horizontal"
+        className={clsx(
+          "openapi-tabs__schema-list-container",
+          "tabs",
+          {
+            "tabs--block": block,
+          },
+          className
+        )}
+      >
+        {tabValues.map(({ value, label, attributes }) => (
+          <li
+            // TODO extract TabListItem
+            role="tab"
+            tabIndex={selectedValue === value ? 0 : -1}
+            aria-selected={selectedValue === value}
+            key={value}
+            ref={(tabControl) => tabRefs.push(tabControl)}
+            onKeyDown={handleKeydown}
+            onClick={handleTabChange}
+            {...attributes}
             className={clsx(
-              styles.schemaTabsListContainer,
-              "tabs",
+              "tabs__item",
+              "openapi-tabs__schema-item",
+              attributes?.className,
               {
-                "tabs--block": block,
-              },
-              className
+                active: selectedValue === value,
+              }
             )}
           >
-            {values.map(({ value, label, attributes }) => {
-              return (
-                <div
-                  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>
-                </div>
-              );
-            })}
-          </div>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowRight)}
-              onClick={handleRightClick}
-            />
-          )}
-        </div>
-      </div>
-      <hr />
-      {lazy ? (
-        cloneElement(
-          children.filter(
-            (tabItem) => tabItem.props.value === selectedValue
-          )[0] ?? // TODO: see if there's a better way to handle this
-            children.filter(
-              (tabItem) => tabItem.props.value === defaultValue
-            )[0],
-          {
-            className: styles.marginVertical,
-          }
-        )
-      ) : (
-        <div className={styles.marginVertical}>
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
+            <span className="openapi-tabs__schema-label">{label ?? value}</span>
+          </li>
+        ))}
+      </ul>
+      {showTabArrows && (
+        <button
+          className="openapi-tabs__arrow right"
+          onClick={handleRightClick}
+        />
       )}
     </div>
   );
 }
-
+function TabContent({ lazy, children, selectedValue }) {
+  // eslint-disable-next-line no-param-reassign
+  children = Array.isArray(children) ? children : [children];
+  const flattenedChildren = flatten(children);
+
+  if (lazy) {
+    const selectedTabItem = flattenedChildren.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 (
+    <div className="margin-top--md">
+      {children.map((tabItem, i) =>
+        cloneElement(tabItem, {
+          key: i,
+          hidden: tabItem.props.value !== selectedValue,
+        })
+      )}
+    </div>
+  );
+}
+function TabsComponent(props) {
+  const tabs = useTabs(props);
+  return (
+    <div className="openapi-tabs__schema-container">
+      <TabList {...props} {...tabs} />
+      <TabContent {...props} {...tabs} />
+    </div>
+  );
+}
 export default function SchemaTabs(props) {
   const isBrowser = useIsBrowser();
   return (
-    <SchemaTabsComponent // Remount tabs after hydration
+    <TabsComponent
+      // Remount tabs after hydration
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}

package/src/theme/styles.scss

@@ -0,0 +1,160 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+/* API Demo Panel */
+@use "./ApiExplorer/CodeTabs/CodeTabs";
+@use "./ApiExplorer/FloatingButton/FloatingButton";
+@use "./ApiExplorer/FormFileUpload/FormFileUpload";
+@use "./ApiExplorer/FormItem/FormItem";
+@use "./ApiExplorer/FormMultiSelect/FormMultiSelect";
+@use "./ApiExplorer/FormSelect/FormSelect";
+@use "./ApiExplorer/FormTextInput/FormTextInput";
+@use "./ApiExplorer/LiveEditor/LiveEditor";
+@use "./ApiExplorer/MethodEndpoint/MethodEndpoint";
+@use "./ApiExplorer/ParamOptions/ParamOptions";
+@use "./ApiExplorer/Request/Request";
+@use "./ApiExplorer/Response/Response";
+@use "./ApiExplorer/Server/Server";
+
+/* Api Demo Panel / ApiCodeBlock */
+@use "./ApiExplorer/ApiCodeBlock/Container/Container";
+@use "./ApiExplorer/ApiCodeBlock/Content/Content";
+@use "./ApiExplorer/ApiCodeBlock/CopyButton/CopyButton";
+@use "./ApiExplorer/ApiCodeBlock/ExitButton/ExitButton";
+@use "./ApiExplorer/ApiCodeBlock/ExpandButton/ExpandButton";
+@use "./ApiExplorer/ApiCodeBlock/Line/Line";
+@use "./ApiExplorer/ApiCodeBlock/WordWrapButton/WordWrapButton";
+
+/* Schema Styling */
+@use "./ParamsItem/ParamsItem";
+@use "./SchemaItem/SchemaItem";
+/* Tabs Styling */
+@use "./ApiTabs/ApiTabs";
+@use "./DiscriminatorTabs/DiscriminatorTabs";
+@use "./MimeTabs/MimeTabs";
+@use "./SchemaTabs/SchemaTabs";
+/* Code Samples */
+@use "./ResponseSamples/ResponseSamples";
+/* Markdown Styling */
+@use "./Markdown/Details/Details";
+
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-deprecated: var(--ifm-color-warning);
+  --openapi-nullable: var(--ifm-color-info);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-input-border: var(--ifm-color-primary);
+  --openapi-input-background: var(--openapi-card-background-color);
+  --openapi-tree-line-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color-python: #ffdb50;
+  --openapi-code-tab-border-color-bash: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-go: var(--ifm-color-info);
+  --openapi-code-tab-border-color-js: var(--ifm-color-warning);
+  --openapi-code-tab-border-color-ruby: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-csharp: #9b4f96;
+  --openapi-code-tab-border-color-nodejs: var(--ifm-color-success);
+  --openapi-code-tab-border-color-php: #6181b6;
+  --openapi-code-tab-border-color-java: #0374bd;
+  --openapi-code-tab-border-color-powershell: #00adef;
+  --openapi-code-tab-shadow-color-python: rgba(255, 219, 80, 0.25);
+  --openapi-code-tab-shadow-color-bash: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-go: rgba(84, 199, 236, 0.25);
+  --openapi-code-tab-shadow-color-js: rgba(255, 186, 0, 0.25);
+  --openapi-code-tab-shadow-color-ruby: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-csharp: rgba(155, 79, 150, 0.25);
+  --opeanpi-code-tab-shadow-color-nodejs: rgba(0, 164, 0, 0.25);
+  --openapi-code-tab-shadow-color-php: rgba(97, 129, 182, 0.25);
+  --openapi-code-tab-shadow-color-java: rgba(3, 116, 189, 0.25);
+  --opeanpi-code-tab-shadow-color-powershell: rgba(3, 116, 189, 0.25);
+  --openapi-explorer-font-size-input: 12px;
+  --openapi-explorer-font-size-code: 12px;
+  --openapi-explorer-padding-input: 0.5rem;
+  --openapi-explorer-border-color: var(--ifm-toc-border-color);
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>');
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24" fill="white"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>') !important;
+}
+
+.docs-wrapper {
+  height: 100%;
+}
+
+@media (min-width: 997px) {
+  .docItemCol {
+    max-width: 75% !important;
+  }
+
+  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+  .tocMobile {
+    display: none;
+  }
+}
+
+/* Begin OpenAPI theme styles */
+// [data-theme="dark"] {
+//   --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+// }
+
+// .theme-api-markdown div[class^="collapsibleContent"] {
+//   margin-top: 0 !important;
+//   padding-left: 2px;
+// }
+
+/* Demo panel details */
+
+// .theme-api-markdown .openapi-explorer__details > div > div > pre {
+//   border-top-left-radius: 0;
+//   border-top-right-radius: 0;
+// }
+
+/* Code block */
+
+// .theme-api-markdown code {
+//   max-width: 600px;
+//   max-height: 500px;
+//   overflow: auto;
+// }
+
+/* Version button */
+
+// .version-button div {
+//   display: block;
+// }
+
+// .version-button div > button > span::after {
+//   border-color: currentcolor transparent;
+//   border-style: solid;
+//   border-width: 0.4em 0.4em 0;
+//   content: "";
+//   margin-left: 0.3em;
+//   position: relative;
+//   transform: translateY(-50%);
+//   display: inline-block;
+//   font-size: 0.8rem;
+//   top: 1px;
+// }
+
+.openapi__logo {
+  width: 250px;
+}
+
+.openapi__heading {
+  font-size: 2rem;
+  margin-bottom: 0.5rem !important;
+}
+
+.openapi-left-panel__container {
+  border-right: thin solid var(--ifm-toc-border-color);
+}