Interface: CommentsFeedObjectProps
CommentsFeedObject.CommentsFeedObjectProps
Indexable
▪ [p: string
]: any
Other props
Properties
CommentComponent
• Optional
CommentComponent: (inProps
: CommentObjectProps
) => Element
Type declaration
▸ (inProps
): Element
CommentComponent component Useful to override the single Comment render component
Parameters
Name | Type |
---|---|
inProps | CommentObjectProps |
Returns
Element
Default
CommentObject
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:80
CommentComponentProps
• Optional
CommentComponentProps: CommentObjectProps
Props to spread to CommentObject component
Default
{variant: 'outlined}
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:86
CommentObjectSkeletonProps
• Optional
CommentObjectSkeletonProps: any
Props to spread to CommentObject component
Default
{elevation: 0, variant: 'outlined'}
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:92
cacheStrategy
• Optional
cacheStrategy: CacheStrategies
Caching strategies
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:154
className
• Optional
className: string
Overrides or extends the styles applied to the component.
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:43
commentObject
• Optional
commentObject: SCCommentType
Comment object
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:73
commentObjectId
• Optional
commentObjectId: number
Id of the comment object
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:67
comments
• Optional
comments: SCCommentType
[]
additional comments to show in the header/footer useful when from a feedObject publish a comment
Default
[]
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:142
commentsOrderBy
• Optional
commentsOrderBy: SCCommentsOrderBy
comments orderBy
Default
SCCommentsOrderBy.ADDED_AT_DESC
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:124
commentsPageCount
• Optional
commentsPageCount: number
comments per page
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:118
feedObject
• Optional
feedObject: SCFeedObjectType
Feed object
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:55
feedObjectId
• Optional
feedObjectId: number
Id of feed object
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:49
feedObjectType
• Optional
feedObjectType: DISCUSSION
| POST
| STATUS
Type of feed object
Default
SCContributionType.POST
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:61
id
• Optional
id: string
Id of the CommentsObject
Default
comments_object_<feedObjectType>_<feedObjectId | feedObject.id>
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:37
infiniteScrolling
• Optional
infiniteScrolling: boolean
enable/disable infinite scrolling
Default
true
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:135
onChangePage
• Optional
onChangePage: (page
: any
) => any
Type declaration
▸ (page
): any
Callback invoked when load comments page Usefull to sync location path for SEO optimization
Parameters
Name | Type |
---|---|
page | any |
Returns
any
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:149
page
• Optional
page: number
page
Default
1
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:112
renderCommentNotFound
• Optional
renderCommentNotFound: () => Element
Type declaration
▸ (): Element
renderCommentNotFound function invoked when comment not found
Returns
Element
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:106
renderNoComments
• Optional
renderNoComments: () => Element
Type declaration
▸ (): Element
renderNoComment function invoked when no comments founds
Returns
Element
Default
null
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:99
showTitle
• Optional
showTitle: boolean
show title (number of comments)
Defined in
packages/react-ui/src/components/CommentsFeedObject/CommentsFeedObject.tsx:129