react-ai-renderer 0.1.15 → 0.1.17

package/dist/index.d.ts

@@ -1,5 +1,28 @@
 import React from 'react';
 
+/**
+ * 骨架图配置接口
+ */
+interface SkeletonConfig {
+    /** 自定义骨架图组件 */
+    component?: React.ComponentType<SkeletonProps>;
+    /** 自定义骨架图元素 */
+    element?: React.ReactElement;
+    /** 自定义骨架图生成函数 */
+    generator?: (props: SkeletonProps) => React.ReactElement;
+    /** 是否启用自动生成 */
+    autoGenerate?: boolean;
+}
+/**
+ * 骨架图组件的属性
+ */
+interface SkeletonProps {
+    componentName: string;
+    componentData?: ComponentData$1;
+    props?: Record<string, any>;
+    style?: React.CSSProperties;
+}
+
 interface ComponentData$1 {
     type: "text" | "component";
     value: string;
@@ -20,11 +43,32 @@ interface ComponentHandler extends BaseComponentHandler {
     onRenderFinished?: (item: ComponentData$1, scope: any) => void;
     /** @deprecated 使用 onRenderProcess 替代 */
     onRender?: (item: ComponentData$1, scope: any) => void;
-    /** 自定义占位组件，可以是 React 组件、React 元素、字符串或返回 React 元素的函数 */
-    placeholder?: React.ComponentType<any> | React.ReactElement | string | ((componentName: string) => React.ReactElement);
+    /** 自定义加载组件，可以是 React 组件、React 元素、字符串、布尔值或返回 React 元素的函数 */
+    loader?: React.ComponentType<any> | React.ReactElement | string | boolean | ((componentName: string) => React.ReactElement);
+    /** 骨架图配置，用于在加载时显示骨架图。如果未提供且 loader 也未提供，将自动根据组件名称生成骨架图 */
+    skeleton?: SkeletonConfig;
     /** 组件的显示标签，用于在占位组件中显示 */
     label?: string;
 }
+/** 增强模式的组件配置 */
+interface EnhancedComponentConfig {
+    /** 组件本身 */
+    value: React.ComponentType<any>;
+    /** 组件的显示标签 */
+    label?: string;
+    /** 自定义加载组件，可以是 React 组件、React 元素、字符串、布尔值或返回 React 元素的函数 */
+    loader?: React.ComponentType<any> | React.ReactElement | string | boolean | ((componentName: string) => React.ReactElement);
+    /** 骨架图配置，用于在加载时显示骨架图。如果未提供且 loader 也未提供，将自动根据组件名称生成骨架图 */
+    skeleton?: SkeletonConfig;
+    /** 组件渲染完成后的钩子 */
+    onRenderFinished?: (item: ComponentData$1, scope: any) => void;
+    /** 组件渲染过程中的钩子 */
+    onRenderProcess?: (item: ComponentData$1, scope: any) => void;
+    /** 是否自闭合 */
+    selfClosing?: boolean;
+}
+/** 组件值类型：可以是组件本身，也可以是增强配置对象 */
+type ComponentValue = React.ComponentType<any> | EnhancedComponentConfig;
 interface ParserState {
     position: number;
     stack: ComponentData$1[];
@@ -49,8 +93,8 @@ interface ReactAIRendererProps {
     content?: string;
     /** 作用域对象，用于传递变量和函数给组件 */
     scope?: Record<string, any>;
-    /** 自定义组件映射 */
-    components?: Record<string, React.ComponentType<any>>;
+    /** 自定义组件映射，支持普通模式（组件）和增强模式（配置对象） */
+    components?: Record<string, ComponentValue>;
     /** 子元素，作为 content 的替代方案 */
     children?: string;
     /** 组件处理器数组 */
@@ -121,4 +165,4 @@ declare class MDXStreamingParser {
 
 declare function ReactAIRenderer({ content, scope, components, children, componentHandlers, useGithubStyles, mdxLayoutClassName, mdxLayoutStyle }: ReactAIRendererProps): React.JSX.Element;
 
-export { ComponentData$1 as ComponentData, ComponentHandler, MDXStreamingParser, MdxLayout, MdxLayoutProps, ParseResult, ParserState, ReactAIRendererProps, ReactMarkdownProps, Think, ThinkProps, ToolCall, ToolCallProps, ReactAIRenderer as default };
+export { ComponentData$1 as ComponentData, ComponentHandler, ComponentValue, EnhancedComponentConfig, MDXStreamingParser, MdxLayout, MdxLayoutProps, ParseResult, ParserState, ReactAIRendererProps, ReactMarkdownProps, Think, ThinkProps, ToolCall, ToolCallProps, ReactAIRenderer as default };