docusaurus-theme-openapi-docs 3.0.0-beta.2 → 3.0.0-beta.4

package/src/theme/SchemaTabs/{index.js → index.tsx}

@@ -5,31 +5,55 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import React, { cloneElement, useRef, useEffect, useState } from "react";
+import React, {
+  cloneElement,
+  useRef,
+  useEffect,
+  useState,
+  ReactElement,
+} from "react";
 
 import {
+  sanitizeTabsChildren,
+  TabProps,
   useScrollPositionBlocker,
   useTabs,
 } from "@docusaurus/theme-common/internal";
+import { TabItemProps } from "@docusaurus/theme-common/lib/utils/tabsUtils";
 import useIsBrowser from "@docusaurus/useIsBrowser";
 import clsx from "clsx";
 import flatten from "lodash/flatten";
 
-function TabList({ className, block, selectedValue, selectValue, tabValues }) {
-  const tabRefs = [];
+function TabList({
+  className,
+  block,
+  selectedValue,
+  selectValue,
+  tabValues,
+}: TabProps & ReturnType<typeof useTabs>) {
+  const tabRefs: (HTMLLIElement | null)[] = [];
   const { blockElementScrollPositionUntilNextRender } =
     useScrollPositionBlocker();
-  const handleTabChange = (event) => {
+
+  const handleTabChange = (
+    event:
+      | React.FocusEvent<HTMLLIElement>
+      | React.MouseEvent<HTMLLIElement>
+      | React.KeyboardEvent<HTMLLIElement>
+  ) => {
     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;
+
+  const handleKeydown = (event: React.KeyboardEvent<HTMLLIElement>) => {
+    let focusElement: HTMLLIElement | null = null;
+
     switch (event.key) {
       case "Enter": {
         handleTabChange(event);
@@ -37,27 +61,28 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
       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();
   };
 
-  const tabItemListContainerRef = useRef(null);
-  const [showTabArrows, setShowTabArrows] = useState(false);
+  const tabItemListContainerRef = useRef<HTMLUListElement>(null);
+  const [showTabArrows, setShowTabArrows] = useState<boolean>(false);
 
   useEffect(() => {
     const resizeObserver = new ResizeObserver((entries) => {
       for (let entry of entries) {
-        if (entry.target.offsetWidth < entry.target.scrollWidth) {
+        if (entry.target.clientWidth < entry.target.scrollWidth) {
           setShowTabArrows(true);
         } else {
           setShowTabArrows(false);
@@ -65,7 +90,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
       }
     });
 
-    resizeObserver.observe(tabItemListContainerRef.current);
+    resizeObserver.observe(tabItemListContainerRef.current!);
 
     return () => {
       resizeObserver.disconnect();
@@ -73,11 +98,11 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
   }, []);
 
   const handleRightClick = () => {
-    tabItemListContainerRef.current.scrollLeft += 90;
+    tabItemListContainerRef.current!.scrollLeft += 90;
   };
 
   const handleLeftClick = () => {
-    tabItemListContainerRef.current.scrollLeft -= 90;
+    tabItemListContainerRef.current!.scrollLeft -= 90;
   };
 
   return (
@@ -115,7 +140,7 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
             className={clsx(
               "tabs__item",
               "openapi-tabs__schema-item",
-              attributes?.className,
+              attributes?.className as string,
               {
                 active: selectedValue === value,
               }
@@ -134,13 +159,17 @@ function TabList({ className, block, selectedValue, selectValue, tabValues }) {
     </div>
   );
 }
-function TabContent({ lazy, children, selectedValue }) {
-  // eslint-disable-next-line no-param-reassign
-  children = Array.isArray(children) ? children : [children];
-  const flattenedChildren = flatten(children);
-
+function TabContent({
+  lazy,
+  children,
+  selectedValue,
+}: TabProps & ReturnType<typeof useTabs>) {
+  const childTabs = (Array.isArray(children) ? children : [children]).filter(
+    Boolean
+  ) as ReactElement<TabItemProps>[];
+  const flattenedChildTabs = flatten(childTabs);
   if (lazy) {
-    const selectedTabItem = flattenedChildren.find(
+    const selectedTabItem = flattenedChildTabs.find(
       (tabItem) => tabItem.props.value === selectedValue
     );
     if (!selectedTabItem) {
@@ -151,7 +180,7 @@ function TabContent({ lazy, children, selectedValue }) {
   }
   return (
     <div className="margin-top--md">
-      {children.map((tabItem, i) =>
+      {childTabs.map((tabItem, i) =>
         cloneElement(tabItem, {
           key: i,
           hidden: tabItem.props.value !== selectedValue,
@@ -160,7 +189,7 @@ function TabContent({ lazy, children, selectedValue }) {
     </div>
   );
 }
-function TabsComponent(props) {
+function TabsComponent(props: TabProps): React.JSX.Element {
   const tabs = useTabs(props);
   return (
     <div className="openapi-tabs__schema-container">
@@ -169,7 +198,7 @@ function TabsComponent(props) {
     </div>
   );
 }
-export default function SchemaTabs(props) {
+export default function SchemaTabs(props: TabProps): React.JSX.Element {
   const isBrowser = useIsBrowser();
   return (
     <TabsComponent
@@ -177,6 +206,8 @@ export default function SchemaTabs(props) {
       // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
       key={String(isBrowser)}
       {...props}
-    />
+    >
+      {sanitizeTabsChildren(props.children)}
+    </TabsComponent>
   );
 }

package/src/theme-classic.d.ts

@@ -8,6 +8,73 @@
 /// <reference types="@docusaurus/theme-classic" />
 
 declare module "@docusaurus/theme-common/internal" {
-  function useDoc(): any;
-  export const { useDoc };
+  import { CSSProperties, ReactNode, RefObject } from "react";
+
+  import type { PropDocContent } from "@docusaurus/plugin-content-docs";
+  import { MagicCommentConfig } from "@docusaurus/theme-common/lib/utils/codeBlockUtils";
+  import {
+    TabsProps as ITabsProps,
+    TabValue,
+  } from "@docusaurus/theme-common/lib/utils/tabsUtils";
+  import { Props as ICodeBlockProps } from "@theme/CodeBlock";
+  import { Props as ICopyButtonProps } from "@theme/CodeBlock/CopyButton";
+  import { Props as ILineProps } from "@theme/CodeBlock/Line";
+  import { PrismTheme } from "prism-react-renderer";
+
+  export interface TabProps extends ITabsProps {}
+
+  export interface CopyButtonProps extends ICopyButtonProps {}
+  export interface LineProps extends ILineProps {}
+  export interface CodeBlockProps extends ICodeBlockProps {}
+
+  export function useDoc();
+
+  export function usePrismTheme(): PrismTheme;
+
+  export function sanitizeTabsChildren(children: TabProps["children"]);
+
+  export function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties;
+
+  export function parseCodeBlockTitle(metastring?: string): string;
+
+  export function parseLanguage(className: string): string | undefined;
+
+  export function containsLineNumbers(metastring?: string): boolean;
+
+  export function useScrollPositionBlocker(): {
+    blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
+  };
+
+  export function DocProvider({
+    children,
+    content,
+  }: {
+    children: ReactNode;
+    content: PropDocContent;
+  });
+
+  export function useTabs(props: TabProps): {
+    selectedValue: string;
+    selectValue: (value: string) => void;
+    tabValues: readonly TabValue[];
+  };
+
+  export function parseLines(
+    content: string,
+    options: {
+      metastring: string | undefined;
+      language: string | undefined;
+      magicComments: MagicCommentConfig[];
+    }
+  ): {
+    lineClassNames: { [lineIndex: number]: string[] };
+    code: string;
+  };
+
+  export function useCodeWordWrap(): {
+    readonly codeBlockRef: RefObject<HTMLPreElement>;
+    readonly isEnabled: boolean;
+    readonly isCodeScrollable: boolean;
+    readonly toggle: () => void;
+  };
 }

package/src/theme-openapi.d.ts

@@ -7,6 +7,8 @@
 
 /// <reference types="docusaurus-plugin-openapi-docs" />
 
+/* eslint-disable @typescript-eslint/no-use-before-define */
+
 declare module "@docusaurus/plugin-content-docs-types" {
   // Makes all properties visible when hovering over the type
   type Expand<T extends Record<string, unknown>> = { [P in keyof T]: T[P] };

package/tsconfig.json

@@ -7,7 +7,10 @@
     "target": "ESNext",
     "noEmit": false,
     "outDir": "lib",
-    "jsx": "react"
+    "jsx": "react",
+    "paths": {
+      "@theme/*": ["./src/theme/*"]
+    }
   },
   "include": ["src"]
 }