Skip to main content

Interface: CommentsObjectProps

CommentsObject.CommentsObjectProps

Indexable​

▪ [p: string]: any

Other props

Properties​

CommentComponent​

• Optional CommentComponent: (inProps: CommentObjectProps) => Element

Type declaration​

▸ (inProps): Element

CommentComponent component Usefull to override the single Comment render component

Parameters​
NameType
inPropsCommentObjectProps
Returns​

Element

Default

CommentObject

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:82

CommentComponentProps​

• Optional CommentComponentProps: CommentObjectProps

Props to spread to single comment object

Default

{variant: 'outlined'}

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:88

CommentObjectSkeletonProps​

• Optional CommentObjectSkeletonProps: any

Props to spread to single comment object skeleton

Default

{elevation: 0, WidgetProps: {variant: 'outlined'}},

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:100

CommentsObjectSkeletonProps​

• Optional CommentsObjectSkeletonProps: any

Props to spread to CommentsObjectSkeleton

Default

{}

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:94

PaginationLinkProps​

• Optional PaginationLinkProps: Record<string, any>

Props to spread to the pagination Link component

Default

{}

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:194

cacheStrategy​

• Optional cacheStrategy: CacheStrategies

Caching strategies

Default

CacheStrategies.CACHE_FIRST

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:219

className​

• Optional className: string

Overrides or extends the styles applied to the component.

Default

null

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:57

comments​

• Optional comments: SCCommentType[]

Comments to show

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:105

• Optional disablePaginationLinks: boolean

Add/remove pagination links on top/bottom of items

Default

false

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:170

endComments​

• Optional endComments: SCCommentType[]

Add/show other comments at the end of the component Useful when there is a new comment (reply feed object)

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:206

feedObject​

• Optional feedObject: SCFeedObjectType

Feed object

Default

null

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:69

feedObjectId​

• Optional feedObjectId: number

Id of feed object

Default

null

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:63

feedObjectType​

• Optional feedObjectType: DISCUSSION | POST | STATUS

Type of feed object

Default

SCContributionType.POST

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:75

handleNext​

• Optional handleNext: () => void

Type declaration​

▸ (): void

Handle load next comments callback

Returns​

void

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:122

handlePrevious​

• Optional handlePrevious: () => void

Type declaration​

▸ (): void

Handle load previous comments callback

Returns​

void

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:139

• Optional hidePaginationLinks: boolean

Show/hide pagination links

Default

true

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:176

id​

• Optional id: string

Id of the CommentsObject

Default

comments_object_<feedObjectType>_<feedObjectId | feedObject.id>

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:51

inPlaceLoadMoreContents​

• Optional inPlaceLoadMoreContents: boolean

Load more contents in place rather than opening a new page

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:182

infiniteScrolling​

• Optional infiniteScrolling: boolean

Enable/disable infinite scrolling If there is comments in startCommments/endComments infiniteScrolling will be disabled

Default

true

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:213

isLoadingNext​

• Optional isLoadingNext: boolean

Is loading next comments If exist load next button is replaced by comment skeleton

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:117

isLoadingPrevious​

• Optional isLoadingPrevious: boolean

Is loading previous comments If exist load previous button is replaced by comment skeleton

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:134

next​

• Optional next: string

Next url If exist show load next button

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:111

nextPage​

• Optional nextPage: number

Next page

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:164

page​

• Optional page: number

Current page

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:154

paginationLinksPageQueryParam​

• Optional paginationLinksPageQueryParam: string

Page query parameter name

Default

'page'

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:188

previous​

• Optional previous: string

Previous url If exist show load previous button

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:128

previousPage​

• Optional previousPage: number

Previous page

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:159

startComments​

• Optional startComments: SCCommentType[]

Add/show other comments at the head of the component Useful when there is a new comment (reply feed object)

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:200

totalComments​

• Optional totalComments: number

Total number of comments

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:149

totalLoadedComments​

• Optional totalLoadedComments: number

Number of comments loaded

Defined in​

packages/react-ui/src/components/CommentsObject/CommentsObject.tsx:144