@conciergus/chat - v0.3.1
    Preparing search index...

    Interface ConciergusObjectStreamProps

    Properties for ConciergusObjectStream component

    interface ConciergusObjectStreamProps {
        schema?: any;
        streamUrl?: string;
        initialObject?: any;
        objectType?: string;
        className?: string;
        loadingComponent?: ReactNode;
        errorComponent?: ComponentType<{ error: Error }>;
        objectRenderer?: ComponentType<ObjectRendererProps>;
        showProgress?: boolean;
        showSchema?: boolean;
        showFieldUpdates?: boolean;
        enableAnimations?: boolean;
        compact?: boolean;
        onObjectUpdate?: (object: any, delta?: any) => void;
        onStreamStart?: () => void;
        onStreamComplete?: (finalObject: any) => void;
        onStreamError?: (error: Error) => void;
        onFieldUpdate?: (field: string, value: any) => void;
        streamPartProcessor?: (part: EnhancedStreamPart) => any;
        debounceDelay?: number;
        maxRetries?: number;
        debug?: boolean;
        ariaLabel?: string;
        ariaDescription?: string;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Additional props

    Index

    Properties

    schema? streamUrl? initialObject? objectType? className? loadingComponent? errorComponent? objectRenderer? showProgress? showSchema? showFieldUpdates? enableAnimations? compact? onObjectUpdate? onStreamStart? onStreamComplete? onStreamError? onFieldUpdate? streamPartProcessor? debounceDelay? maxRetries? debug? ariaLabel? ariaDescription?

    Properties

    schema?: any

    Object schema for validation and type inference

    streamUrl?: string

    Stream URL or endpoint for object streaming

    initialObject?: any

    Initial object data

    objectType?: string

    Object type identifier

    className?: string

    Additional CSS classes

    loadingComponent?: ReactNode

    Loading component

    errorComponent?: ComponentType<{ error: Error }>

    Error component

    objectRenderer?: ComponentType<ObjectRendererProps>

    Custom object renderer

    showProgress?: boolean

    Show streaming progress

    showSchema?: boolean

    Show object schema information

    showFieldUpdates?: boolean

    Show field updates in real-time

    enableAnimations?: boolean

    Enable smooth animations

    compact?: boolean

    Compact display mode

    onObjectUpdate?: (object: any, delta?: any) => void

    Object update handler

    onStreamStart?: () => void

    Stream start handler

    onStreamComplete?: (finalObject: any) => void

    Stream complete handler

    onStreamError?: (error: Error) => void

    Stream error handler

    onFieldUpdate?: (field: string, value: any) => void

    Field update handler

    streamPartProcessor?: (part: EnhancedStreamPart) => any

    Custom stream part processor

    debounceDelay?: number

    Debounce delay for updates (ms)

    maxRetries?: number

    Maximum retry attempts for streaming

    debug?: boolean

    Enable debug mode

    ariaLabel?: string

    Accessibility label

    ariaDescription?: string

    Accessibility description

    Settings

    Member Visibility

    On This Page

    Properties