apiuikit 1.6.1 → 1.8.0

package/dist/components/Tabs.d.ts

@@ -1,4 +1,4 @@
-import { ComponentType } from 'react';
+import { ComponentType, ReactNode } from 'react';
 export type Tab = {
     id: string;
     name: string;
@@ -12,8 +12,27 @@ interface TabsProps {
     onChange?: (id: string) => void;
     ariaLabel?: string;
     selectLabel?: string;
+    /** Scopes the tab and panel DOM ids when more than one tab list can appear on a page. */
+    idPrefix?: string;
     /** When set, the mobile `<select>` includes an empty option for no selection. */
     placeholder?: string;
+    /**
+     * `"segmented"` renders a compact, content-width pill toggle (small text,
+     * tight padding, active tab picked out with a light background) instead of
+     * the default full-width strip — for a control that switches *which panel
+     * you're looking at* rather than one that reads as a section of the page's
+     * own navigation. Omit to keep the existing icon/no-icon inference.
+     */
+    variant?: "segmented";
 }
-export default function Tabs({ tabs, current, onChange, ariaLabel, selectLabel, placeholder, }: TabsProps): import("react").JSX.Element | null;
+export default function Tabs({ tabs, current, onChange, ariaLabel, selectLabel, idPrefix, placeholder, variant, }: TabsProps): import("react").JSX.Element | null;
+interface TabPanelsProps {
+    tabs: Tab[];
+    current: string;
+    idPrefix?: string;
+    renderPanel: (tab: Tab, active: boolean) => ReactNode;
+}
+/** Renders one linked ARIA panel per tab. The caller decides which panels
+ * have mounted content, allowing visited panels to remain stateful. */
+export declare function TabPanels({ tabs, current, idPrefix, renderPanel }: TabPanelsProps): import("react").JSX.Element;
 export {};

package/dist/containers/AsyncAPI/AsyncAPI.d.ts

@@ -2,11 +2,14 @@ import { ConfigInterface } from '../../config';
 import { AsyncAPIDocumentData } from '../../types/schema';
 import { ErrorBoundaryFallbackRenderer } from '../../components/ErrorBoundary';
 import { ErrorInfo, ReactNode } from 'react';
+import { ApiuikitPlugin } from '../../plugins/types';
 export interface IAsyncAPIProps {
     /** A pre-resolved AsyncAPI 3.0 document object, or one that still contains `$ref`s. */
     asyncapi: AsyncAPIDocumentData;
     /** UI configuration: theme, which sections to show, sidebar options, and more. */
     config?: ConfigInterface;
+    /** Third-party plugins (e.g. a "try it out" panel) to render into this document's extension slots. */
+    plugins?: ApiuikitPlugin[];
     /** Promise that `asyncapi` is already fully dereferenced upstream. Verified rather than trusted: `$ref`s left in place are still resolved either way, with a console warning that the promise was false. */
     kind?: "resolved";
     /** Custom UI shown if rendering this document throws. Defaults to a built-in fallback. */

package/dist/containers/AsyncAPI/AsyncAPIDocumentProvider.d.ts

@@ -1,12 +1,15 @@
 import { ReactNode } from 'react';
 import { ConfigInterface } from '../../config';
 import { AsyncAPIDocumentData } from '../../types/schema';
+import { ApiuikitPlugin } from '../../plugins/types';
 export interface AsyncAPIDocumentProviderProps {
     document: AsyncAPIDocumentData;
     config?: ConfigInterface;
+    /** Third-party plugins to register on this document's context. */
+    plugins?: ApiuikitPlugin[];
     /** Extra classes merged onto the root surface. */
     className?: string;
     children: ReactNode;
 }
-export declare function AsyncAPIDocumentProvider({ document: asyncapi, config, className, children, }: AsyncAPIDocumentProviderProps): import("react").JSX.Element;
+export declare function AsyncAPIDocumentProvider({ document: asyncapi, config, plugins, className, children, }: AsyncAPIDocumentProviderProps): import("react").JSX.Element;
 export default AsyncAPIDocumentProvider;

package/dist/containers/AsyncAPI/AsyncAPIRenderer.d.ts

@@ -1,11 +1,14 @@
 import { ConfigInterface } from '../../config/config';
 import { ErrorBoundaryFallbackRenderer } from '../../components/ErrorBoundary';
 import { ErrorInfo, ReactNode } from 'react';
+import { ApiuikitPlugin } from '../../plugins/types';
 interface AsyncAPIRendererProps {
     /** Raw AsyncAPI document as a YAML or JSON string, parsed and validated internally via `@asyncapi/parser`. */
     raw: string;
     /** UI configuration: theme, which sections to show, sidebar options, and more. */
     config?: ConfigInterface;
+    /** Third-party plugins (e.g. a "try it out" panel) to render into this document's extension slots. */
+    plugins?: ApiuikitPlugin[];
     /** Called with the parser's diagnostics (errors/warnings) after each parse attempt. */
     onDiagnostics?: (diagnostics: unknown[]) => void;
     /** Custom UI shown if rendering the parsed document throws. Defaults to a built-in fallback. */
@@ -19,5 +22,5 @@ interface AsyncAPIRendererProps {
  * document as text rather than a pre-parsed object, e.g. user-entered or
  * loaded from a file at runtime.
  */
-export declare function AsyncAPIRenderer({ raw, config, onDiagnostics, errorFallback, onError }: AsyncAPIRendererProps): import("react").JSX.Element | null;
+export declare function AsyncAPIRenderer({ raw, config, plugins, onDiagnostics, errorFallback, onError }: AsyncAPIRendererProps): import("react").JSX.Element | null;
 export {};

package/dist/containers/AsyncAPI/Layout.d.ts

@@ -1,7 +1,9 @@
 import { ConfigInterface } from '../../config';
+import { ApiuikitPlugin } from '../../plugins/types';
 import { AsyncAPIDocumentData } from '../../types/schema';
 export interface LayoutProps {
     asyncapi: AsyncAPIDocumentData;
     config: ConfigInterface;
+    plugins?: ApiuikitPlugin[];
 }
-export default function Layout({ asyncapi, config }: LayoutProps): import("react").JSX.Element;
+export default function Layout({ asyncapi, config, plugins }: LayoutProps): import("react").JSX.Element;

package/dist/containers/OpenAPI/Layout.d.ts

@@ -1,7 +1,9 @@
 import { ConfigInterface } from '../../config';
+import { ApiuikitPlugin } from '../../plugins/types';
 import { OpenAPIDocumentData } from '../../types/openapi';
 export interface OpenAPILayoutProps {
     openapi: OpenAPIDocumentData;
     config: ConfigInterface;
+    plugins?: ApiuikitPlugin[];
 }
-export default function Layout({ openapi, config }: OpenAPILayoutProps): import("react").JSX.Element;
+export default function Layout({ openapi, config, plugins }: OpenAPILayoutProps): import("react").JSX.Element;

package/dist/containers/OpenAPI/OpenAPI.d.ts

@@ -2,11 +2,14 @@ import { ConfigInterface } from '../../config';
 import { OpenAPIDocumentData } from '../../types/openapi';
 import { ErrorBoundaryFallbackRenderer } from '../../components/ErrorBoundary';
 import { ErrorInfo, ReactNode } from 'react';
+import { ApiuikitPlugin } from '../../plugins/types';
 export interface IOpenAPIProps {
     /** A pre-resolved OpenAPI 3.0/3.1 document object, or one that still contains `$ref`s. */
     openapi: OpenAPIDocumentData;
     /** UI configuration: theme, which sections to show, sidebar options, and more. */
     config?: ConfigInterface;
+    /** Third-party plugins (e.g. a "try it out" panel) to render into this document's extension slots. */
+    plugins?: ApiuikitPlugin[];
     /** Promise that `openapi` is already fully dereferenced upstream. Verified rather than trusted: `$ref`s left in place are still resolved either way, with a console warning that the promise was false. */
     kind?: "resolved";
     /** Custom UI shown if rendering this document throws. Defaults to a built-in fallback. */

package/dist/containers/OpenAPI/OpenAPIDocumentProvider.d.ts

@@ -1,13 +1,16 @@
 import { ReactNode } from 'react';
 import { ConfigInterface } from '../../config';
 import { OpenAPIDocumentData } from '../../types/openapi';
+import { ApiuikitPlugin } from '../../plugins/types';
 export interface OpenAPIDocumentProviderProps {
     document: OpenAPIDocumentData;
     config?: ConfigInterface;
+    /** Third-party plugins to register on this document's context. */
+    plugins?: ApiuikitPlugin[];
     /** Extra classes merged onto the root surface. */
     className?: string;
     children: ReactNode;
 }
 /** Mirrors AsyncAPIDocumentProvider, sharing the same DocumentContext shape. */
-export declare function OpenAPIDocumentProvider({ document: openapi, config, className, children, }: OpenAPIDocumentProviderProps): import("react").JSX.Element;
+export declare function OpenAPIDocumentProvider({ document: openapi, config, plugins, className, children, }: OpenAPIDocumentProviderProps): import("react").JSX.Element;
 export default OpenAPIDocumentProvider;

package/dist/containers/OpenAPI/OpenAPIRenderer.d.ts

@@ -1,11 +1,14 @@
 import { ConfigInterface } from '../../config/config';
 import { ErrorBoundaryFallbackRenderer } from '../../components/ErrorBoundary';
 import { ErrorInfo, ReactNode } from 'react';
+import { ApiuikitPlugin } from '../../plugins/types';
 interface OpenAPIRendererProps {
     /** Raw OpenAPI document as a YAML or JSON string, parsed and validated internally via `@readme/openapi-parser`. */
     raw: string;
     /** UI configuration: theme, which sections to show, sidebar options, and more. */
     config?: ConfigInterface;
+    /** Third-party plugins (e.g. a "try it out" panel) to render into this document's extension slots. */
+    plugins?: ApiuikitPlugin[];
     /** Called with the parser's diagnostics (errors/warnings) after each parse attempt. */
     onDiagnostics?: (diagnostics: unknown[]) => void;
     /** Custom UI shown if rendering the parsed document throws. Defaults to a built-in fallback. */
@@ -19,5 +22,5 @@ interface OpenAPIRendererProps {
  * have a document as text rather than a pre-parsed object, e.g. user-entered
  * or loaded from a file at runtime.
  */
-export declare function OpenAPIRenderer({ raw, config, onDiagnostics, errorFallback, onError }: OpenAPIRendererProps): import("react").JSX.Element | null;
+export declare function OpenAPIRenderer({ raw, config, plugins, onDiagnostics, errorFallback, onError }: OpenAPIRendererProps): import("react").JSX.Element | null;
 export {};

package/dist/contexts/useSpec.d.ts

@@ -1,6 +1,8 @@
 import { AsyncAPIDocumentData } from '../types/schema';
 import { OpenAPIDocumentData } from '../types/openapi';
-import { MarkdownUrlResolver, SidePanelContainment } from '../config/config';
+import { ConfigInterface, MarkdownUrlResolver, SidePanelContainment } from '../config/config';
+import { ApiuikitPlugin } from '../plugins/types';
+import { PluginSlotRegistry } from '../plugins/registry';
 /** Which spec produced the ambient document. The discriminant of DocumentContextValue. */
 export type SpecType = "asyncapi" | "openapi";
 interface DocumentContextBase {
@@ -25,6 +27,12 @@ interface DocumentContextBase {
     showCodeSamples: boolean;
     /** Resolves the hosted URL serving a target as Markdown, if the consumer serves one (config.markdown.url). */
     markdownUrl?: MarkdownUrlResolver;
+    /** Third-party plugins registered on the nearest `<AsyncAPI>`/`<OpenAPI>` (or provider), consumed via `PluginSlot`. Undefined is equivalent to none registered. */
+    plugins?: ApiuikitPlugin[];
+    /** Pre-indexed plugin fills used internally by slot hosts. */
+    pluginSlotRegistry?: PluginSlotRegistry;
+    /** The host's as-given `config` prop, unmerged with defaults. For plugins; prefer the derived fields above for apiuikit's own UI. Theme colors: use the CSS custom properties on the document root (see Plugins docs), not `config.theme`. */
+    config?: ConfigInterface;
 }
 export interface AsyncAPIDocumentContextValue extends DocumentContextBase {
     specType: "asyncapi";
@@ -44,6 +52,12 @@ export interface OpenAPIDocumentContextValue extends DocumentContextBase {
 export type DocumentContextValue = AsyncAPIDocumentContextValue | OpenAPIDocumentContextValue;
 export declare const DocumentContext: import('react').Context<DocumentContextValue | null>;
 export declare const useDocumentContext: () => DocumentContextValue;
+/** Returns an AsyncAPI context and fails fast when rendered under the wrong
+ * document provider. */
+export declare const useAsyncAPIDocumentContext: () => AsyncAPIDocumentContextValue;
+/** Returns an OpenAPI context and fails fast when rendered under the wrong
+ * document provider. */
+export declare const useOpenAPIDocumentContext: () => OpenAPIDocumentContextValue;
 export declare const AsyncAPIDocumentContext: import('react').Context<DocumentContextValue | null>;
 export declare const useAsyncAPIDocument: () => DocumentContextValue;
 export {};

package/dist/hooks/useDocumentProviderValue.d.ts

@@ -1,6 +1,7 @@
 import { ConfigInterface } from '../config';
 import { MarkdownUrlResolver, SidePanelContainment } from '../config/config';
 import { SpecType } from '../contexts';
+import { ApiuikitPlugin } from '../plugins/types';
 /**
  * Builds the shared DocumentContext value (deref resolver, portal/root refs,
  * theme-derived settings) plus the CSS custom properties for the theme,
@@ -10,7 +11,7 @@ import { SpecType } from '../contexts';
  * `specType` and document type, and thus lands as the right member of the
  * DocumentContextValue union.
  */
-export declare function useDocumentProviderValue<S extends SpecType, D extends object>(specType: S, document: D, config?: ConfigInterface): {
+export declare function useDocumentProviderValue<S extends SpecType, D extends object>(specType: S, document: D, config?: ConfigInterface, plugins?: ApiuikitPlugin[]): {
     contextValue: {
         specType: S;
         document: D;
@@ -25,6 +26,9 @@ export declare function useDocumentProviderValue<S extends SpecType, D extends o
         showExtensions: boolean;
         showCodeSamples: boolean;
         markdownUrl: MarkdownUrlResolver | undefined;
+        plugins: ApiuikitPlugin[];
+        pluginSlotRegistry: import('../plugins/registry').PluginSlotRegistry;
+        config: ConfigInterface;
     };
     themeVars: Record<string, string>;
     setPortalHost: import('react').Dispatch<import('react').SetStateAction<HTMLDivElement | null>>;