@redocly/theme 0.59.0-rc.1 → 0.59.0

package/src/markdoc/components/Tabs/Tabs.tsx

@@ -1,5 +1,6 @@
-import React, { useState, useEffect } from 'react';
-import styled from 'styled-components';
+import React, { useState, useEffect, useLayoutEffect, useRef, useCallback } from 'react';
+import { useInRouterContext } from 'react-router-dom';
+import styled, { css } from 'styled-components';
 
 import type { JSX } from 'react';
 
@@ -26,6 +27,26 @@ type TabsProps = {
   className?: string;
   size: TabsSize;
   initialTab?: string;
+  forceReady?: boolean;
+};
+
+type UseActiveTabFn = (
+  initialTab: string,
+  tabsId: string | undefined,
+  childrenArray: React.ReactElement<TabItemProps>[],
+) => {
+  activeTab: string;
+  setActiveTab: (tab: string) => void;
+};
+
+type TabsViewProps = Omit<TabsProps, 'children'> & {
+  childrenArray: React.ReactElement<TabItemProps>[];
+  initialTab: string;
+  isReady: boolean;
+  labelsHash: string;
+  useActiveTab: UseActiveTabFn;
+  containerRef: React.RefObject<HTMLUListElement | null>;
+  onReadyChange: (ready: boolean) => void;
 };
 
 export function Tabs({
@@ -34,25 +55,72 @@ export function Tabs({
   className,
   size,
   initialTab: propInitialTab,
+  forceReady = false,
 }: TabsProps): JSX.Element {
-  const [childrenArray, setChildrenArray] = useState<React.ReactElement<TabItemProps>[]>(
-    React.Children.toArray(children) as React.ReactElement<TabItemProps>[],
-  );
+  const childrenArray = React.Children.toArray(children) as React.ReactElement<TabItemProps>[];
+  const [isReady, setIsReady] = useState(false);
+  const containerRef = useRef<HTMLUListElement | null>(null);
 
   const initialTab = propInitialTab ?? childrenArray[0]?.props.label ?? '';
-  const { activeTab, setActiveTab } = useActiveTab({ tabsId: id, initialTab });
+  const labelsHash = childrenArray.map((c) => c.props.label).join('|');
 
-  useEffect(() => {
-    setChildrenArray(React.Children.toArray(children) as React.ReactElement<TabItemProps>[]);
-  }, [children]);
+  const handleReadyChange = useCallback((ready: boolean) => {
+    setIsReady(ready);
+  }, []);
+
+  // Reset isReady when children change (new page/tabs)
+  // Use useLayoutEffect to run synchronously before paint
+  useLayoutEffect(() => {
+    setIsReady(false);
+  }, [labelsHash]);
+
+  const inRouter = useInRouterContext();
+
+  return (
+    <TabsView
+      id={id}
+      className={className}
+      size={size}
+      childrenArray={childrenArray}
+      initialTab={initialTab}
+      useActiveTab={inRouter ? useActiveTabWithRouter : useActiveTabWithoutRouter}
+      isReady={isReady || forceReady}
+      labelsHash={labelsHash}
+      containerRef={containerRef}
+      onReadyChange={handleReadyChange}
+    />
+  );
+}
+
+function TabsView({
+  id,
+  className,
+  size,
+  childrenArray,
+  useActiveTab,
+  initialTab,
+  isReady,
+  labelsHash,
+  containerRef,
+  onReadyChange,
+}: TabsViewProps): JSX.Element {
+  const { activeTab, setActiveTab } = useActiveTab(initialTab, id, childrenArray);
 
   return (
-    <TabsContainer data-component-name="Markdoc/Tabs/Tabs" className={className} key={id}>
+    <TabsContainer
+      data-component-name="Markdoc/Tabs/Tabs"
+      className={className}
+      key={id}
+      $isReady={isReady}
+    >
       <TabList
+        key={labelsHash}
         size={size}
         childrenArray={childrenArray}
         activeTab={activeTab}
         onTabChange={setActiveTab}
+        containerRef={containerRef}
+        onReadyChange={onReadyChange}
       />
       {childrenArray.map((child, index) => {
         const { label } = child.props;
@@ -72,7 +140,56 @@ export function Tabs({
     </TabsContainer>
   );
 }
-const TabsContainer = styled.div`
+
+/**
+ * Validates that the active tab exists in children and resets to initial tab if not found.
+ * Ensures tab state remains consistent when tab structure changes.
+ */
+function useValidateActiveTab(
+  activeTab: string,
+  setActiveTab: (tab: string) => void,
+  childrenArray: React.ReactElement<TabItemProps>[],
+  initialTab: string,
+) {
+  useEffect(() => {
+    const availableLabels = childrenArray.map((child) => child.props.label);
+    if (activeTab && !availableLabels.includes(activeTab) && availableLabels.length > 0) {
+      setActiveTab(initialTab);
+    }
+  }, [childrenArray, activeTab, initialTab, setActiveTab]);
+}
+
+const useActiveTabWithRouter = (
+  initialTab: string,
+  tabsId: string | undefined,
+  childrenArray: React.ReactElement<TabItemProps>[],
+) => {
+  const { activeTab, setActiveTab } = useActiveTab({ initialTab, tabsId });
+
+  useValidateActiveTab(activeTab, setActiveTab, childrenArray, initialTab);
+
+  return {
+    activeTab,
+    setActiveTab,
+  };
+};
+
+const useActiveTabWithoutRouter = (
+  initialTab: string,
+  _tabsId: string | undefined,
+  childrenArray: React.ReactElement<TabItemProps>[],
+) => {
+  const [activeTab, setActiveTab] = useState(initialTab);
+
+  useValidateActiveTab(activeTab, setActiveTab, childrenArray, initialTab);
+
+  return {
+    activeTab,
+    setActiveTab,
+  };
+};
+
+const TabsContainer = styled.div<{ $isReady: boolean }>`
   position: relative;
   color: var(--md-tabs-container-text-color);
   font-size: var(--md-tabs-container-font-size);
@@ -88,6 +205,14 @@ const TabsContainer = styled.div`
     margin: 0;
     padding: 0;
   }
+
+  ${({ $isReady }) =>
+    !$isReady &&
+    css`
+      opacity: 0;
+      pointer-events: none;
+      overflow: hidden;
+    `}
 `;
 
 export const TabContent = styled.div`

package/src/markdoc/components/default.ts

@@ -20,3 +20,4 @@ export * from '@redocly/theme/markdoc/components/CodeWalkthrough/CodeToggle';
 export * from '@redocly/theme/markdoc/components/CodeWalkthrough/CodeContainer';
 export * from '@redocly/theme/markdoc/components/CodeGroup/CodeGroup';
 export * from '@redocly/theme/markdoc/components/Icon/Icon';
+export * from '@redocly/theme/markdoc/components/ConnectMCP/ConnectMCP';

package/src/markdoc/default.ts

@@ -25,6 +25,7 @@ import { input } from '@redocly/theme/markdoc/tags/input';
 import { toggle } from '@redocly/theme/markdoc/tags/code-toggle';
 import { codeGroup } from '@redocly/theme/markdoc/tags/code-group';
 import { icon } from '@redocly/theme/markdoc/tags/icon';
+import { connectMcp } from '@redocly/theme/markdoc/tags/connect-mcp';
 
 export const tags = {
   [admonition.tagName]: admonition.schema,
@@ -45,4 +46,5 @@ export const tags = {
   [input.tagName]: input.schema,
   [codeGroup.tagName]: codeGroup.schema,
   [icon.tagName]: icon.schema,
+  [connectMcp.tagName]: connectMcp.schema,
 };

package/src/markdoc/tags/card.ts

@@ -54,7 +54,6 @@ export const card: MarkdocSchemaWrapper = {
       },
       to: { type: String, resolver: 'link' },
     },
-    children: ['paragraph', 'tag', 'list'],
   },
   tagName: 'card',
 };

package/src/markdoc/tags/connect-mcp.ts

@@ -0,0 +1,25 @@
+import type { MarkdocSchemaWrapper } from '@redocly/theme/markdoc/tags/types';
+
+export const connectMcp: MarkdocSchemaWrapper = {
+  schema: {
+    render: 'ConnectMCP',
+    attributes: {
+      placement: {
+        type: String,
+        default: 'bottom',
+        matches: ['top', 'bottom'],
+      },
+      alignment: {
+        type: String,
+        default: 'start',
+        matches: ['start', 'end'],
+      },
+      options: {
+        type: Array,
+        default: ['cursor', 'vscode', 'copy'],
+      },
+    },
+    selfClosing: true,
+  },
+  tagName: 'connect-mcp',
+};

package/lib/components/OpenApiDocs/hooks/AdditionalOverviewInfo.d.ts

@@ -1 +0,0 @@
-export declare const AdditionalOverviewInfo: any;

package/lib/components/OpenApiDocs/hooks/AdditionalOverviewInfo.js

@@ -1,11 +0,0 @@
-"use strict";
-// interface AdditionalOverviewInfoProps {
-//   info: any;
-// }
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdditionalOverviewInfo = void 0;
-// export function AdditionalOverviewInfo(_props: AdditionalOverviewInfoProps) {
-//   return null;
-// }
-exports.AdditionalOverviewInfo = null;
-//# sourceMappingURL=AdditionalOverviewInfo.js.map

package/lib/components/OpenApiDocs/hooks/AfterOpenApiDescription.d.ts

@@ -1 +0,0 @@
-export declare const AfterOpenApiDescription: any;

package/lib/components/OpenApiDocs/hooks/AfterOpenApiDescription.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AfterOpenApiDescription = void 0;
-exports.AfterOpenApiDescription = null;
-//# sourceMappingURL=AfterOpenApiDescription.js.map

package/lib/ext/process-scorecard.d.ts

@@ -1,5 +0,0 @@
-import type { CatalogItem } from '../index.js';
-export declare function useProcessScorecard(): {
-    processScorecard: <T = any>(scorecard: T, api: CatalogItem) => T;
-    processInfo: <T>(info: T) => T;
-};

package/lib/ext/process-scorecard.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useProcessScorecard = useProcessScorecard;
-const react_1 = require("react");
-function useProcessScorecard() {
-    return {
-        processScorecard: (0, react_1.useCallback)((scorecard) => scorecard, []),
-        processInfo: (0, react_1.useCallback)((info) => info, []),
-    };
-}
-//# sourceMappingURL=process-scorecard.js.map

package/src/components/OpenApiDocs/hooks/AdditionalOverviewInfo.tsx

@@ -1,9 +0,0 @@
-// interface AdditionalOverviewInfoProps {
-//   info: any;
-// }
-
-// export function AdditionalOverviewInfo(_props: AdditionalOverviewInfoProps) {
-//   return null;
-// }
-
-export const AdditionalOverviewInfo: any = null;

package/src/components/OpenApiDocs/hooks/AfterOpenApiDescription.tsx

@@ -1 +0,0 @@
-export const AfterOpenApiDescription: any = null;

package/src/ext/process-scorecard.ts

@@ -1,13 +0,0 @@
-import { useCallback } from 'react';
-
-import type { CatalogItem } from '@redocly/theme';
-
-export function useProcessScorecard(): {
-  processScorecard: <T = any>(scorecard: T, api: CatalogItem) => T;
-  processInfo: <T>(info: T) => T;
-} {
-  return {
-    processScorecard: useCallback((scorecard) => scorecard, []),
-    processInfo: useCallback((info) => info, []),
-  };
-}