PrivateMessageThread
Interfaces
PrivateMessageThreadProps
Extends
CardProps
Indexable
[p: string]: any
Properties
| Property | Type | Description | Overrides |
|---|---|---|---|
className? | string | Overrides or extends the styles applied to the component. Default null | CardProps.className |
onNewMessageClose? | (dispatch: any) => void | Callback fired when new message section is closed Default null | - |
onNewMessageSent? | (msg: any, isSingle?: boolean) => void | Callback fired when new message is sent Default null | - |
onSingleMessageOpen? | (open: boolean) => void | Callback fired when a single message section is open Default null | - |
openNewMessage? | boolean | If new message section is open Default false | - |
threadObj? | any | Thread object or thread id default null | - |
type? | SCPrivateMessageType | The Thread type | - |
Functions
PrivateMessageThread()
PrivateMessageThread(
inProps):JSX.Element
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 demo component here
Import
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. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | PrivateMessageThreadProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/PrivateMessageThread/PrivateMessageThread.tsx:141
PrivateMessageThreadSkeleton()
PrivateMessageThreadSkeleton(
props):JSX.Element
API documentation for the Community-JS PrivateMessage Thread Skeleton component. Learn about the available props and the CSS API.
Import
import {PrivateMessageThreadSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCPrivateMessageThread-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCPrivateMessageThread-skeleton-root | Styles applied to the root element. |
| list | .SCPrivateMessageThread-list | Styles applied to the list element. |
Parameters
| Parameter | Type |
|---|---|
props | any |
Returns
JSX.Element
Source
packages/react-ui/src/components/PrivateMessageThread/Skeleton.tsx:40