Interface: BroadcastMessagesProps
BroadcastMessages.BroadcastMessagesProps
Hierarchy
-
VirtualScrollerItemProps↳
BroadcastMessagesProps
Indexable
▪ [p: string]: any
Any other properties
Properties
MessageProps
• Optional MessageProps: MessageProps
Props to forward to Message component
Default
empty
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:53
cacheStrategy
• Optional cacheStrategy: CacheStrategies
Caching strategies
Default
CacheStrategies.CACHE_FIRST
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:66
className
• Optional className: string
Overrides or extends the styles applied to the component.
Default
null
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:47
disableLoader
• Optional disableLoader: boolean
Disable skeleton loader
Default
false
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:72
id
• Optional id: string
Id of the BroadcastMessages
Default
'broadcast_messages'
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:41
onHeightChange
• Optional onHeightChange: () => void
Type declaration
▸ (): 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.
Returns
void
Inherited from
VirtualScrollerItemProps.onHeightChange
Defined in
packages/react-ui/src/types/virtualScroller.ts:28
onStateChange
• Optional onStateChange: (state: any) => void
Type declaration
▸ (state): 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.
Parameters
| Name | Type |
|---|---|
state | any |
Returns
void
Inherited from
VirtualScrollerItemProps.onStateChange
Defined in
packages/react-ui/src/types/virtualScroller.ts:17
subscriptionChannel
• Optional subscriptionChannel: string
Subscription channel for updates notification When receive this event the component reacts updating data
Default
interaction.notification_banner
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:60
viewAllMessages
• Optional viewAllMessages: boolean
View all messages initially loaded
Default
false
Defined in
packages/react-ui/src/components/BroadcastMessages/BroadcastMessages.tsx:78