docusaurus-theme-openapi-docs 2.0.0-beta.2 → 2.0.0-beta.3

package/src/theme/ParamsItem/index.js

@@ -37,7 +37,7 @@ function ParamsItem({
   ));
 
   const renderSchemaRequired = guard(required, () => (
-    <strong className="openapi-schema__required"> required</strong>
+    <span className="openapi-schema__required">required</span>
   ));
 
   const renderSchema = guard(getQualifierMessage(schema), (message) => (
@@ -117,16 +117,19 @@ function ParamsItem({
   });
 
   return (
-    <li className="openapi-params__list-item">
-      <strong>{name}</strong>
-      {renderSchemaName}
-      {renderSchemaRequired}
+    <div className="openapi-params__list-item">
+      <span className="openapi-schema__container">
+        <strong className="openapi-schema__property">{name}</strong>
+        {renderSchemaName}
+        {required && <span className="openapi-schema__divider"></span>}
+        {renderSchemaRequired}
+      </span>
       {renderSchema}
       {renderDefaultValue}
       {renderDescription}
       {renderExample}
       {renderExamples}
-    </li>
+    </div>
   );
 }
 

package/src/theme/SchemaItem/_SchemaItem.scss

@@ -1,3 +1,11 @@
+.openapi-schema__container {
+  &:hover {
+    .openapi-schema__property {
+      color: var(--ifm-color-primary);
+    }
+  }
+}
+
 .openapi-schema__list-item {
   list-style: none;
   position: relative;
@@ -21,33 +29,60 @@
   }
 }
 
-.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;
+  padding-left: 0.3rem;
 }
 
 .openapi-schema__required {
-  font-size: var(--ifm-code-font-size);
+  display: inline-flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
   color: var(--openapi-required);
+  margin-left: 1%;
+  background-color: transparent;
 }
 
 .openapi-schema__deprecated {
-  font-size: var(--ifm-code-font-size);
+  display: flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
   color: var(--openapi-deprecated);
+  margin-left: 1%;
+  background-color: transparent;
 }
 
 .openapi-schema__nullable {
-  font-size: var(--ifm-code-font-size);
+  display: flex;
+  align-items: center;
+  font-size: 10.5px;
+  font-weight: bold;
+  text-transform: uppercase;
   color: var(--openapi-nullable);
+  margin-left: 1%;
+  background-color: transparent;
 }
 
 .openapi-schema__strikethrough {
   text-decoration: line-through;
 }
+
+.openapi-schema__property {
+  margin-top: 1.25px;
+  font-family: var(--ifm-font-family-monospace);
+  transition: 300ms;
+}
+
+.openapi-schema__divider {
+  flex-grow: 1;
+  border-bottom: thin solid var(--ifm-toc-border-color);
+  margin: 10px;
+}
+
+.openapi-schema__container {
+  display: flex;
+}

package/src/theme/SchemaItem/index.js

@@ -9,6 +9,7 @@ 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 } from "docusaurus-theme-openapi-docs/lib/markdown/utils";
@@ -37,15 +38,15 @@ function SchemaItem({
 
   const renderRequired = guard(
     Array.isArray(required) ? required.includes(name) : required,
-    () => <strong className="openapi-schema__required"> required</strong>
+    () => <span className="openapi-schema__required">required</span>
   );
 
   const renderDeprecated = guard(deprecated, () => (
-    <strong className="openapi-schema__deprecated"> deprecated</strong>
+    <span className="openapi-schema__deprecated">deprecated</span>
   ));
 
   const renderNullable = guard(nullable, () => (
-    <strong className="openapi-schema__nullable"> nullable</strong>
+    <span className="openapi-schema__nullable">nullable</span>
   ));
 
   const renderSchemaDescription = guard(schemaDescription, (description) => (
@@ -89,23 +90,33 @@ function SchemaItem({
 
   const schemaContent = (
     <div>
-      <strong className={deprecated && "openapi-schema__strikethrough"}>
-        {name}
-      </strong>
-      <span className="openapi-schema__name"> {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}
+      {collapsibleSchemaContent ?? collapsibleSchemaContent}
     </div>
   );
 
   return (
-    <li className="openapi-schema__list-item">
+    <div className="openapi-schema__list-item">
       {collapsible ? collapsibleSchemaContent : schemaContent}
-    </li>
+    </div>
   );
 }
 

package/src/theme/SchemaTabs/_SchemaTabs.scss

@@ -5,30 +5,37 @@
  * 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;
-  height: 1.8rem;
+  padding: 0.35rem 0.7rem;
+  border: 1px solid transparent;
   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;
-}
+  font-weight: var(--ifm-font-weight-bold);
+  font-family: var(--ifm-font-family-monospace);
+  font-size: 10px;
+  white-space: nowrap;
+  transition: 300ms;
 
-.openapi-tabs__schema-item:not(.active) {
-  opacity: 0.65;
-}
+  &:hover {
+    background-color: transparent;
+    border: 1px solid var(--ifm-toc-border-color);
+  }
 
-.openapi-tabs__schema-item:hover {
-  opacity: 1;
-  background-color: var(--ifm-color-emphasis-100);
-}
+  &.active {
+    border: 1px solid var(--ifm-color-primary);
+    color: var(--ifm-color-primary);
+  }
 
-.openapi-tabs__schema-item:last-child {
-  margin-right: 0 !important;
+  &:last-child {
+    margin-right: 0 !important;
+  }
 }
 
 .openapi-tabs__schema-list-container {
@@ -49,9 +56,8 @@
   white-space: nowrap;
 }
 
-.openapi-tabs__schema-container {
+.openapi-tabs__schema-tabs-container {
   width: 100%;
-  margin-top: 1rem;
   display: flex;
   align-items: center;
   overflow: hidden;

package/src/theme/SchemaTabs/index.js

@@ -81,60 +81,56 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   };
 
   return (
-    <div className="tabs__container">
-      <div className="openapi-tabs__schema-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(
-                "tabs__item",
-                "openapi-tabs__schema-item",
-                attributes?.className,
-                {
-                  active: selectedValue === value,
-                }
-              )}
-            >
-              <span className="openapi-tabs__schema-label">
-                {label ?? value}
-              </span>
-            </li>
-          ))}
-        </ul>
-        {showTabArrows && (
-          <button
-            className="openapi-tabs__arrow right"
-            onClick={handleRightClick}
-          />
+    <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
         )}
-      </div>
+      >
+        {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(
+              "tabs__item",
+              "openapi-tabs__schema-item",
+              attributes?.className,
+              {
+                active: selectedValue === value,
+              }
+            )}
+          >
+            <span className="openapi-tabs__schema-label">{label ?? value}</span>
+          </li>
+        ))}
+      </ul>
+      {showTabArrows && (
+        <button
+          className="openapi-tabs__arrow right"
+          onClick={handleRightClick}
+        />
+      )}
     </div>
   );
 }
@@ -167,7 +163,7 @@ function TabContent({ lazy, children, selectedValue }) {
 function TabsComponent(props) {
   const tabs = useTabs(props);
   return (
-    <div className="tabs-container">
+    <div className="openapi-tabs__schema-container">
       <TabList {...props} {...tabs} />
       <TabContent {...props} {...tabs} />
     </div>

package/src/theme/styles.scss

@@ -18,6 +18,16 @@
 @use "./ApiDemoPanel/Request/Request";
 @use "./ApiDemoPanel/Response/Response";
 @use "./ApiDemoPanel/Server/Server";
+
+/* Api Demo Panel / ApiCodeBlock */
+@use "./ApiDemoPanel/ApiCodeBlock/Container/Container";
+@use "./ApiDemoPanel/ApiCodeBlock/Content/Content";
+@use "./ApiDemoPanel/ApiCodeBlock/CopyButton/CopyButton";
+@use "./ApiDemoPanel/ApiCodeBlock/ExitButton/ExitButton";
+@use "./ApiDemoPanel/ApiCodeBlock/ExpandButton/ExpandButton";
+@use "./ApiDemoPanel/ApiCodeBlock/Line/Line";
+@use "./ApiDemoPanel/ApiCodeBlock/WordWrapButton/WordWrapButton";
+
 /* Schema Styling */
 @use "./ParamsItem/ParamsItem";
 @use "./SchemaItem/SchemaItem";
@@ -44,10 +54,37 @@
   --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-demo-font-size-input: 12px;
+  --openapi-demo-font-size-code: 12px;
+  --openapi-demo-padding-input: 0.5rem;
+  --openapi-demo-border-color: var(--ifm-toc-border-color);
+  --openapi-demo-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-demo-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 {
@@ -114,10 +151,10 @@
 }
 
 .openapi__heading {
-  font-size: var(--ifm-h1-font-size);
+  font-size: 2rem;
+  margin-bottom: 0.5rem !important;
 }
 
-.openapi-demo__code-block code {
-  max-height: 500px;
-  overflow: auto;
+.openapi-left-panel__container {
+  border-right: thin solid var(--ifm-toc-border-color);
 }

package/src/theme-openapi.d.ts

@@ -190,8 +190,41 @@ declare module "@theme/ApiDemoPanel/ParamOptions" {
   export default function ParamOptions(props: ParamProps): JSX.Element;
 }
 
+declare module "@theme/ApiDemoPanel/ParamOptions/ParamFormItems/ParamMultiSelectFormItem" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamMultiSelectFormItem(
+    props: ParamProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions/ParamFormItems/ParamArrayFormItem" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamArrayFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions/ParamFormItems/ParamSelectFormItem" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamSelectFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions/ParamFormItems/ParamBooleanFormItem" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamBooleanFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiDemoPanel/ParamOptions/ParamFormItems/ParamTextFormItem" {
+  import { ParamProps } from "@theme/ApiDemoPanel/ParamOptions";
+
+  export default function ParamTextFormItem(props: ParamProps): JSX.Element;
+}
+
 declare module "@theme/ApiDemoPanel/ParamOptions/slice" {
   export type { Param };
+  export const setParam;
   export default params as Reducer<State, AnyAction>;
 }
 
@@ -209,7 +242,13 @@ declare module "@theme/ApiDemoPanel/Request" {
 }
 
 declare module "@theme/ApiDemoPanel/Response" {
-  export default function Response(): JSX.Element;
+  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+
+  export interface ResponseProps {
+    item: NonNullable<ApiItem>;
+  }
+
+  export default function Response(props: ResponseProps): JSX.Element;
 }
 
 declare module "@theme/ApiDemoPanel/Response/slice" {
@@ -225,6 +264,10 @@ declare module "@theme/ApiDemoPanel/Server" {
   export default function Server(): JSX.Element;
 }
 
+declare module "@theme/ApiDemoPanel/ApiCodeBlock" {
+  export default function ApiCodeBlock(): JSX.Element;
+}
+
 declare module "@theme/ApiDemoPanel/Server/slice" {
   export default server as Reducer<State, AnyAction>;
 }

package/tsconfig.json

@@ -1,9 +1,12 @@
 {
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
-    "lib": ["DOM", "ES2019"],
-    "module": "esnext",
-    "noEmit": true,
+    "lib": ["ESNext", "DOM"],
+    "rootDir": "src",
+    "module": "CommonJS",
+    "target": "ESNext",
+    "noEmit": false,
+    "outDir": "lib",
     "jsx": "react"
   },
   "include": ["src"]

package/lib/postman-code-generators.d.ts

@@ -1,9 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
-declare module "@paloaltonetworks/postman-code-generators";

package/lib/react-magic-dropzone.d.ts

@@ -1,9 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
-declare module "react-magic-dropzone";