UNPKG

@selfcommunity/react-ui

Version:

React UI Components to integrate a Community created with SelfCommunity Platform.

82 lines (73 loc) 3.04 kB
import { SCPrivateMessageType } from '@selfcommunity/types'; import { CardProps } from '@mui/material'; export interface PrivateMessageThreadProps extends CardProps { /** * Thread object or thread id * default null */ threadObj?: any; /** * Overrides or extends the styles applied to the component. * @default null */ className?: string; /** * If new message section is open * @default false */ openNewMessage?: boolean; /** * Callback fired when new message is sent * @default null */ onNewMessageSent?: (msg: any, isSingle?: boolean) => void; /** * Callback fired when new message section is closed * @default null */ onNewMessageClose?: (dispatch: any) => void; /** * Callback fired when a single message section is open * @default null */ onSingleMessageOpen?: (open: boolean) => void; /** * The Thread type */ type?: SCPrivateMessageType; /** * Any other properties */ [p: string]: any; } /** * > API documentation for the Community-JS PrivateMessage Thread component. Learn about the available props and the CSS API. * * * This component renders the conversation between two users. * Take a look at our <strong>demo</strong> component [here](/docs/sdk/community-js/react-ui/Components/Thread) #### Import ```jsx import {PrivateMessageThread} from '@selfcommunity/react-ui'; ``` #### Component Name The name `SCPrivateMessageThread` can be used when providing style overrides in the theme. #### CSS |Rule Name|Global class|Description| |---|---|---| |root|.SCPrivateMessageThread-root|Styles applied to the root element.| |subHeader|.SCPrivateMessageThread-subheader|Styles applied to thread list subheader element.| |section|.SCPrivateMessageThread-section|Styles applied to the list section| |emptyMessage|.SCPrivateMessageThread-empty-message|Styles applied to the empty message element.| |newMessageHeader|.SCPrivateMessageThread-new-message-header|Styles applied to the new message header section.| |newMessageHeaderContent|.SCPrivateMessageThread-new-message-header-content|Styles applied to the new message header content.| |newMessageHeaderIcon|.SCPrivateMessageThread-new-message-header-icon|Styles applied to the new message header icon element.| |newMessageContent|.SCPrivateMessageThread-new-message-content|Styles applied to the new message content.| |sender|.SCPrivateMessageThread-sender|Styles applied to the sender element.| |receiver|.SCPrivateMessageThread-receiver|Styles applied to the receiver element.| |autocomplete|.SCPrivateMessageThread-autocomplete|Styles applied to autocomplete element.| |autocompleteDialog|.SCPrivateMessageThread-autocomplete-dialog|Styles applied to autocomplete dialog element.| |editor|.SCPrivateMessageThread-editor|Styles applied to the editor element.| * @param inProps */ export default function PrivateMessageThread(inProps: PrivateMessageThreadProps): JSX.Element;