@yuntijs/ui/es/ChatItem/type.d.ts

☁️ Yunti UI - an open-source UI component library for building Cloud Native web apps

import type { AlertProps, AvatarProps, DivProps } from '@lobehub/ui';
import type { MetaData } from '@lobehub/ui/chat';
import type { ReactNode } from 'react';
import type { EditableMessageProps } from "../EditableMessage";
export interface ChatItemProps {
    /**
     * @description Actions to be displayed in the chat item
     */
    actions?: ReactNode;
    /**
     * @description Metadata for the avatar
     */
    avatar: MetaData;
    avatarAddon?: ReactNode;
    avatarProps?: AvatarProps;
    /**
     * @description Custom CSS class name for the chat item
     */
    className?: string;
    /**
     * @description Whether the chat item is in editing mode
     */
    editing?: boolean;
    /**
     * @description Props for Error render
     */
    error?: AlertProps;
    errorMessage?: ReactNode;
    fontSize?: number;
    /**
     * @description Whether the chat item is in loading state
     */
    loading?: boolean;
    /**
     * @description The message content of the chat item
     */
    message?: ReactNode;
    messageExtra?: ReactNode;
    affixation?: ReactNode;
    onAvatarClick?: () => void;
    /**
     * @description Callback when the message content changes
     * @param value - The new message content
     */
    onChange?: (value: string) => void;
    onDoubleClick?: DivProps['onDoubleClick'];
    /**
     * @description Callback when the editing mode changes
     * @param editing - The new editing mode
     */
    onEditingChange?: (editing: boolean) => void;
    /**
     * @description The placement of the chat item
     * @default 'left'
     */
    placement?: 'left' | 'right';
    /**
     * @description Whether the chat item is primary
     */
    primary?: boolean;
    renderMessage?: (content: ReactNode) => ReactNode;
    /**
     * @description Whether to show the title of the chat item
     */
    showTitle?: boolean;
    text?: EditableMessageProps['text'];
    /**
     * @description The timestamp of the chat item
     */
    time?: number;
    /**
     * @description The variant of the chat item
     * @default 'bubble'
     */
    variant?: 'bubble' | 'docs';
    /**
     * @description The markdownProps of the chat item
     */
    markdownProps?: EditableMessageProps['markdownProps'];
    /**
     * @description The markdownClassname of the chat item
     */
    markdownClassname?: string;
    /**
     * @description Whether this message is latest
     */
    isLatest?: boolean;
    /**
     * @description Hide avatar
     */
    hideAvatar?: boolean;
}