docusaurus-theme-openapi-docs 1.6.1 → 2.0.0-beta.0

package/lib/theme/MimeTabs/index.js

@@ -5,133 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, {
-  Children,
-  cloneElement,
-  isValidElement,
-  useEffect,
-  useRef,
-  useState,
-} from "react";
+import React, { cloneElement, useEffect, useState, useRef } from "react";
 
-import { duplicates } from "@docusaurus/theme-common";
+import {
+  useScrollPositionBlocker,
+  useTabs,
+} from "@docusaurus/theme-common/internal";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import { setAccept } from "@theme/ApiDemoPanel/Accept/slice";
 import { setContentType } from "@theme/ApiDemoPanel/ContentType/slice";
 import { useTypedDispatch, useTypedSelector } from "@theme/ApiItem/hooks";
 import clsx from "clsx";
 
-import styles from "./styles.module.css";
-
-const {
-  useScrollPositionBlocker,
-  useTabGroupChoice,
-} = require("@docusaurus/theme-common/internal");
-
-function isTabItem(comp) {
-  return typeof comp.props.value !== "undefined";
-}
-
-function MimeTabsComponent(props) {
-  const {
-    lazy,
-    block,
-    defaultValue: defaultValueProp,
-    values: valuesProp,
-    groupId,
-    className,
-    schemaType,
-  } = 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: selectedValueProp,
+  selectValue,
+  tabValues,
+  schemaType,
+}) {
   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);
-    }
-  }
-
+  // custom
   const dispatch = useTypedDispatch();
   const isRequestSchema = schemaType?.toLowerCase() === "request";
 
-  const handleTabChange = (event) => {
-    event.preventDefault();
-    const newTab = event.currentTarget;
-    const newTabIndex = tabRefs.indexOf(newTab);
-    const newTabValue = values[newTabIndex].value;
-
-    if (newTabValue !== selectedValue) {
-      if (isRequestSchema) {
-        dispatch(setContentType(newTabValue));
-      } else {
-        dispatch(setAccept(newTabValue));
-      }
-
-      blockElementScrollPositionUntilNextRender(newTab);
-      setSelectedValue(newTabValue);
-
-      if (groupId != null) {
-        setTabGroupChoices(groupId, newTabValue);
-      }
-    }
-  };
-
+  const [selectedValue, setSelectedValue] = useState(selectedValueProp);
   const contentTypeVal = useTypedSelector((state) => state.contentType.value);
   const acceptTypeVal = useTypedSelector((state) => state.accept.value);
 
@@ -146,26 +48,43 @@ function MimeTabsComponent(props) {
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [contentTypeVal, acceptTypeVal]);
 
+  const handleTabChange = (event) => {
+    event.preventDefault();
+    const newTab = event.currentTarget;
+    const newTabIndex = tabRefs.indexOf(newTab);
+    const newTabValue = tabValues[newTabIndex].value;
+    // custom
+    if (newTabValue !== selectedValue) {
+      if (isRequestSchema) {
+        dispatch(setContentType(newTabValue));
+      } else {
+        dispatch(setAccept(newTabValue));
+      }
+      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];
+        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,12 +92,21 @@ function MimeTabsComponent(props) {
   const [showTabArrows, setShowTabArrows] = useState(false);
 
   useEffect(() => {
-    const tabOffsetWidth = tabItemListContainerRef.current.offsetWidth;
-    const tabScrollWidth = tabItemListContainerRef.current.scrollWidth;
+    const resizeObserver = new ResizeObserver((entries) => {
+      for (let entry of entries) {
+        if (entry.target.offsetWidth < entry.target.scrollWidth) {
+          setShowTabArrows(true);
+        } else {
+          setShowTabArrows(false);
+        }
+      }
+    });
 
-    if (tabOffsetWidth < tabScrollWidth) {
-      setShowTabArrows(true);
-    }
+    resizeObserver.observe(tabItemListContainerRef.current);
+
+    return () => {
+      resizeObserver.disconnect();
+    };
   }, []);
 
   const handleRightClick = () => {
@@ -191,93 +119,100 @@ function MimeTabsComponent(props) {
 
   return (
     <div className="tabs__container">
-      <div className={styles.mimeTabsTopSection}>
-        {/* <strong>MIME Type</strong> */}
-        <div className={styles.mimeTabsContainer}>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowLeft)}
-              onClick={handleLeftClick}
-            />
-          )}
-          <ul
-            ref={tabItemListContainerRef}
-            role="tablist"
-            aria-orientation="horizontal"
-            className={clsx(
-              styles.mimeTabsListContainer,
-              "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={(e) => handleTabChange(e)}
-                  {...attributes}
-                  className={clsx(
-                    "tabs__item",
-                    styles.tabItem,
-                    attributes?.className,
-                    {
-                      [styles.mimeTabActive]: selectedValue === value,
-                    }
-                  )}
-                >
-                  {/* <div
-                    className={clsx(styles.mimeTabDot, mimeTabDotStyle)}
-                  /> */}
-                  {label ?? value}
-                </li>
-              );
-            })}
-          </ul>
-          {showTabArrows && (
-            <button
-              className={clsx(styles.tabArrow, styles.tabArrowRight)}
-              onClick={handleRightClick}
-            />
+      <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(
+            "openapi-tabs__mime-list-container",
+            "tabs",
+            {
+              "tabs--block": block,
+            },
+            className
           )}
-        </div>
+        >
+          {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>
-      {/* <hr /> */}
-      {lazy ? (
-        cloneElement(
-          children.filter(
-            (tabItem) => tabItem.props.value === selectedValue
-          )[0],
-          {
-            className: clsx("margin-vert--md", styles.mimeSchemaContainer),
-          }
-        )
-      ) : (
-        <div className={clsx("margin-vert--md", styles.mimeSchemaContainer)}>
-          {children.map((tabItem, i) =>
-            cloneElement(tabItem, {
-              key: i,
-              hidden: tabItem.props.value !== selectedValue,
-            })
-          )}
-        </div>
+    </div>
+  );
+}
+function TabContent({ lazy, children, selectedValue }) {
+  // eslint-disable-next-line no-param-reassign
+  children = Array.isArray(children) ? children : [children];
+  if (lazy) {
+    const selectedTabItem = children.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="tabs-container">
+      <TabList {...props} {...tabs} />
+      <TabContent {...props} {...tabs} />
+    </div>
+  );
+}
 export default function MimeTabs(props) {
   const isBrowser = useIsBrowser();
   return (
-    <MimeTabsComponent // Remount tabs after hydration
+    <TabsComponent
+      // Remount tabs after hydration
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}

package/lib/theme/ParamsItem/_ParamsItem.scss

@@ -0,0 +1,39 @@
+.openapi-params__list-item {
+  margin: 0 0 0 1rem !important;
+  position: relative;
+  padding-left: 1rem;
+  border-left: thin solid var(--ifm-color-gray-500) !important;
+  margin-top: unset !important;
+
+  // Horizonal line styling for param attributes
+  &::before {
+    position: absolute;
+    top: 10px;
+    left: 0;
+    width: 0.7rem;
+    /* width of horizontal line */
+    height: 0.5rem;
+    /* vertical position of line */
+    vertical-align: top;
+    border-bottom: thin solid var(--ifm-color-gray-500);
+    content: "";
+    display: inline-block;
+  }
+}
+
+.openapi-params__list-item:hover {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.openapi-params__list-item:focus {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.openapi-schema__type {
+  opacity: 0.6;
+}
+
+.openapi-schema__required {
+  font-size: var(--ifm-code-font-size);
+  color: var(--openapi-required);
+}

package/lib/theme/ParamsItem/index.js

@@ -25,8 +25,6 @@ import {
 import ReactMarkdown from "react-markdown";
 import rehypeRaw from "rehype-raw";
 
-import styles from "./styles.module.css";
-
 function ParamsItem({
   param: { description, example, examples, name, required, schema },
 }) {
@@ -35,11 +33,11 @@ function ParamsItem({
   }
 
   const renderSchemaName = guard(schema, (schema) => (
-    <span className={styles.schemaName}> {getSchemaName(schema)}</span>
+    <span className="openapi-schema__type"> {getSchemaName(schema)}</span>
   ));
 
   const renderSchemaRequired = guard(required, () => (
-    <strong className={styles.paramsRequired}> required</strong>
+    <strong className="openapi-schema__required"> required</strong>
   ));
 
   const renderSchema = guard(getQualifierMessage(schema), (message) => (
@@ -119,7 +117,7 @@ function ParamsItem({
   });
 
   return (
-    <li className={styles.paramsItem}>
+    <li className="openapi-params__list-item">
       <strong>{name}</strong>
       {renderSchemaName}
       {renderSchemaRequired}

package/lib/theme/ResponseSamples/_ResponseSamples.scss

@@ -0,0 +1,3 @@
+.openapi-code__response-samples-container {
+  margin-top: 2rem;
+}

package/lib/theme/ResponseSamples/index.js

@@ -9,15 +9,10 @@ import React from "react";
 
 import CodeBlock from "@theme/CodeBlock";
 
-import styles from "./styles.module.css";
-
 function ResponseSamples({ responseExample, language }) {
   return (
-    <div className={styles.responseSamplesContainer}>
-      <CodeBlock
-        language={language ? language : "json"}
-        className={styles.responseSamplesCodeBlock}
-      >
+    <div className="openapi-code__response-samples-container">
+      <CodeBlock language={language ? language : "json"}>
         {responseExample}
       </CodeBlock>
     </div>

package/lib/theme/SchemaItem/_SchemaItem.scss

@@ -0,0 +1,53 @@
+.openapi-schema__list-item {
+  list-style: none;
+  position: relative;
+  margin: 0 !important;
+  padding: 5px 0 5px 1rem;
+  border-left: thin solid var(--ifm-color-gray-500) !important;
+
+  // Horizontal line styling for schema properties
+  &::before {
+    position: absolute;
+    top: 10px;
+    left: 0;
+    width: 0.7rem;
+    /* width of horizontal line */
+    height: 0.5rem;
+    /* vertical position of line */
+    vertical-align: top;
+    border-bottom: thin solid var(--ifm-color-gray-500);
+    content: "";
+    display: inline-block;
+  }
+}
+
+.openapi-schema__list-item:hover {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.openapi-schema__list-item:focus {
+  background-color: var(--ifm-menu-color-background-active);
+}
+
+.openapi-schema__name {
+  opacity: 0.6;
+}
+
+.openapi-schema__required {
+  font-size: var(--ifm-code-font-size);
+  color: var(--openapi-required);
+}
+
+.openapi-schema__deprecated {
+  font-size: var(--ifm-code-font-size);
+  color: var(--openapi-deprecated);
+}
+
+.openapi-schema__nullable {
+  font-size: var(--ifm-code-font-size);
+  color: var(--openapi-nullable);
+}
+
+.openapi-schema__strikethrough {
+  text-decoration: line-through;
+}

package/lib/theme/SchemaItem/index.js

@@ -11,15 +11,10 @@ import CodeBlock from "@theme/CodeBlock";
 /* eslint-disable import/no-extraneous-dependencies*/
 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,
@@ -42,15 +37,15 @@ function SchemaItem({
 
   const renderRequired = guard(
     Array.isArray(required) ? required.includes(name) : required,
-    () => <strong className={styles.required}> required</strong>
+    () => <strong className="openapi-schema__required"> required</strong>
   );
 
   const renderDeprecated = guard(deprecated, () => (
-    <strong className={styles.deprecated}> deprecated</strong>
+    <strong className="openapi-schema__deprecated"> deprecated</strong>
   ));
 
   const renderNullable = guard(nullable, () => (
-    <strong className={styles.nullable}> nullable</strong>
+    <strong className="openapi-schema__nullable"> nullable</strong>
   ));
 
   const renderSchemaDescription = guard(schemaDescription, (description) => (
@@ -75,7 +70,7 @@ function SchemaItem({
   ));
 
   const renderQualifierMessage = guard(qualifierMessage, (message) => (
-    <div className={styles.schemaQualifierMessage}>
+    <div>
       <ReactMarkdown
         children={createDescription(message)}
         rehypePlugins={[rehypeRaw]}
@@ -83,16 +78,21 @@ 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>
+      <strong className={deprecated && "openapi-schema__strikethrough"}>
+        {name}
+      </strong>
+      <span className="openapi-schema__name"> {schemaName}</span>
       {renderNullable}
       {!deprecated && renderRequired}
       {renderDeprecated}
@@ -103,7 +103,7 @@ function SchemaItem({
   );
 
   return (
-    <li className={styles.schemaItem}>
+    <li className="openapi-schema__list-item">
       {collapsible ? collapsibleSchemaContent : schemaContent}
     </li>
   );

package/lib/theme/SchemaTabs/_SchemaTabs.scss

@@ -0,0 +1,58 @@
+/**
+ * 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-item {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  height: 1.8rem;
+  margin-top: 0 !important;
+  margin-right: 0.5rem;
+  border: 1px solid var(--ifm-color-primary);
+  border-radius: var(--ifm-global-radius);
+  color: var(--ifm-color-primary);
+  font-size: 12px;
+}
+
+.openapi-tabs__schema-item:not(.active) {
+  opacity: 0.65;
+}
+
+.openapi-tabs__schema-item:hover {
+  opacity: 1;
+  background-color: var(--ifm-color-emphasis-100);
+}
+
+.openapi-tabs__schema-item: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-container {
+  width: 100%;
+  margin-top: 1rem;
+  display: flex;
+  align-items: center;
+  overflow: hidden;
+}