Interface: FeedObjectProps
FeedObject.FeedObjectProps
Hierarchy
-
CardProps
-
VirtualScrollerItemProps
↳
FeedObjectProps
Indexable
▪ [p: string
]: any
Other props
Properties
ActionsProps
• Optional
ActionsProps: ActionsProps
Props to spread to Actions component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:196
ActivitiesProps
• Optional
ActivitiesProps: ActivitiesProps
Props to spread to Activities component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:208
CommentComponentProps
• Optional
CommentComponentProps: CommentObjectProps
Props to spread to CommentObject component
Default
{variant: 'outlined}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:245
CommentObjectReplyComponent
• Optional
CommentObjectReplyComponent: (inProps
: CommentObjectReplyProps
) => Element
Type declaration
▸ (inProps
): Element
CommentObjectReplyComponent component Usefull to override the single CommentObjectReply render component
Parameters
Name | Type |
---|---|
inProps | CommentObjectReplyProps |
Returns
Element
Default
CommentObject
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:227
CommentObjectReplyComponentProps
• Optional
CommentObjectReplyComponentProps: CommentObjectReplyProps
Props to spread to single reply comment object
Default
{variant: 'outlined'}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:233
CommentObjectSkeletonProps
• Optional
CommentObjectSkeletonProps: any
Props to spread to CommentObject component
Default
{elevation: 0, variant: 'outlined'}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:251
ContributionActionsMenuProps
• Optional
ContributionActionsMenuProps: ContributionActionsMenuProps
Props to spread to ContributionActionsMenu component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:202
ContributorsFeedObjectProps
• Optional
ContributorsFeedObjectProps: ContributorsFeedObjectProps
Props to spread to ContributorsFeedObject component
Default
{elevation: 0}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:239
FeedObjectMediaPreviewProps
• Optional
FeedObjectMediaPreviewProps: FeedObjectMediaPreviewProps
Props to spread to MediasPreview component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:214
FeedObjectSkeletonProps
• Optional
FeedObjectSkeletonProps: FeedObjectSkeletonProps
Props to spread to ContributionActionsMenu component
Default
{elevation: 0}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:184
FollowButtonProps
• Optional
FollowButtonProps: FollowProps
Props to spread to Follow button component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:190
PollObjectProps
• Optional
PollObjectProps: PollObjectProps
Props to spread to PollObject component
Default
{}
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:220
activitiesExpanded
• Optional
activitiesExpanded: boolean
Show activities as default
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:158
activitiesExpandedType
• Optional
activitiesExpandedType: SCFeedObjectActivitiesType
Activities type shown initially. If not set, they are shown in order: RELEVANCE_ACTIVITIES, RECENT_COMMENTS If the obj has no comments/activites, or activitiesExpanded == false nothing will be shown
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:166
cacheStrategy
• Optional
cacheStrategy: CacheStrategies
Caching strategies
Default
CacheStrategies.CACHE_FIRST
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:263
className
• Optional
className: string
Overrides or extends the styles applied to the component.
Default
null
Overrides
CardProps.className
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:105
feedObject
• Optional
feedObject: SCFeedObjectType
Feed Object
Default
null
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:116
feedObjectActivities
• Optional
feedObjectActivities: any
[]
Feed Object latest activities
Default
null
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:134
feedObjectId
• Optional
feedObjectId: number
Id of feed object
Default
null
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:110
feedObjectType
• Optional
feedObjectType: DISCUSSION
| POST
| STATUS
Feed Object type
Default
'post'
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:122
hideFollowAction
• Optional
hideFollowAction: boolean
Hide follow action object
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:146
hideParticipantsPreview
• Optional
hideParticipantsPreview: boolean
Hide Participants preview
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:172
id
• Optional
id: string
Id of the feedObject
Default
feed_object_<feedObjectType>_<feedObjectId | feedObject.id>
Overrides
CardProps.id
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:99
markRead
• Optional
markRead: boolean
Mark the FeedObject as read when enter in viewport
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:128
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
onReply
• Optional
onReply: (SCCommentType
: any
) => void
Type declaration
▸ (SCCommentType
): void
Callback on reply
Parameters
Name | Type |
---|---|
SCCommentType | any |
Returns
void
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:257
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
pollVisible
• Optional
pollVisible: boolean
Show poll as default if exist
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:178
summaryExpanded
• Optional
summaryExpanded: boolean
Show all summary initially (otherwise it will be truncated)
Default
false
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:152
template
• Optional
template: SCFeedObjectTemplateType
Feed Object template type
Default
'preview'
Defined in
packages/react-ui/src/components/FeedObject/FeedObject.tsx:140