Interface: FeedUpdatesWidgetProps
FeedUpdatesWidget.FeedUpdatesWidgetProps
Hierarchy
-
VirtualScrollerItemProps↳
FeedUpdatesWidgetProps
Indexable
▪ [p: string]: any
Other Card props
Properties
className
• Optional className: string
Overrides or extends the styles applied to the component.
Default
null
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:34
id
• Optional id: string
Id of the feed object
Default
'custom_adv'
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:28
message
• Optional message: ReactNode
Update message, rendered when no more feed item can be displayed
Default
<FormattedMessage id="ui.feedUpdatesWidget.message" defaultMessage="ui.feedUpdatesWidget.message" />
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:40
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
publicationChannel
• Optional publicationChannel: string
Publish channel for refresh notification
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:57
subscriptionChannel
• subscriptionChannel: string
Subscription channel for updates notification
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:45
subscriptionChannelUpdatesCallback
• Optional subscriptionChannelUpdatesCallback: (msg: any, data: any) => boolean
Type declaration
▸ (msg, data): boolean
Callback used to check if the message published to the channel is an update message
Parameters
| Name | Type |
|---|---|
msg | any |
data | any |
Returns
boolean
boolean
Default
(msg, data) => true
Defined in
packages/react-ui/src/components/FeedUpdatesWidget/FeedUpdatesWidget.tsx:52