BroadcastMessages
Interfaces
BroadcastMessagesProps
Extends
VirtualScrollerItemProps
Indexable
[p: string]: any
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
MessageProps? | MessageProps | Props to forward to Message component Default empty | - |
cacheStrategy? | CacheStrategies | Caching strategies Default CacheStrategies.CACHE_FIRST | - |
className? | string | Overrides or extends the styles applied to the component. Default null | - |
disableLoader? | boolean | Disable skeleton loader Default false | - |
id? | string | Id of the BroadcastMessages Default 'broadcast_messages' | - |
onHeightChange? | () => void | Must be called whenever a list item's height changes (for example, when a user clicks an "Expand"/"Collapse" button of a list item): it re-measures the item's height and updates VirtualScroller layout. Every change in an item's height must come as a result of changing some kind of a state, be it the item's state in VirtualScroller via .onItemStateChange(), or some other state managed by the application. Call this method to re-measure the current element. | VirtualScrollerItemProps.onHeightChange |
onStateChange? | (state: any) => void | Save current state and when the component re-mount restore previous state using props. It is used to keep a copy of VirtualScroller state so that it could be quickly restored in case the VirtualScroller component gets unmounted and then re-mounted back again — for example, when the user navigates away by clicking on a list item and then navigates "Back" to the list. | VirtualScrollerItemProps.onStateChange |
subscriptionChannel? | string | Subscription channel for updates notification When receive this event the component reacts updating data Default interaction.notification_banner | - |
viewAllMessages? | boolean | View all messages initially loaded Default false | - |
Functions
BroadcastMessages()
BroadcastMessages(
inProps):JSX.Element
API documentation for the Community-JS Broadcast Messages component. Learn about the available props and the CSS API.
This component handles message broadcasts. It initially displays unseen messages. If all messages have been viewed it will show at most one message. Take a look at our demo component here
Import
import {BroadcastMessages} from '@selfcommunity/react-ui';
Component Name
The name SCBroadcastMessages can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCBroadcastMessages-root | Styles applied to the root element. |
| boxLoadMore | .SCBroadcastMessages-box-load-more | Styles applied to load more box. |
| avatarLoadMore | .SCBroadcastMessages-avatar-load-more | Styles applied to load more avatar. |
| buttonLoadMore | .SCBroadcastMessages-button-load-more | Styles applied to load more button. |
Parameters
| Parameter | Type | Description |
|---|---|---|
inProps | BroadcastMessagesProps |
Returns
JSX.Element
Source
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:113
BroadcastMessagesSkeleton()
BroadcastMessagesSkeleton(
props):JSX.Element
API documentation for the Community-JS Broadcast Messages Skeleton component. Learn about the available props and the CSS API.
Import
import {BroadcastMessagesSkeleton} from '@selfcommunity/react-ui';
Component Name
The name SCBroadcastMessages-skeleton-root can be used when providing style overrides in the theme.
CSS
| Rule Name | Global class | Description |
|---|---|---|
| root | .SCBroadcastMessages-skeleton-root | Styles applied to the root element. |
Parameters
| Parameter | Type |
|---|---|
props | any |
Returns
JSX.Element
Source
packages/react-ui/src/components/BroadcastMessages/Skeleton.tsx:108