Function: useComments()
@roomful/react / useComments
Function: useComments()
Section titled “Function: useComments()”useComments<
TPresence>(options?):UseCommentsResult
Defined in: react/src/index.ts:1204
Subscribes to collaborative comment threads and returns the thread mutators.
Type Parameters
Section titled “Type Parameters”TPresence
Section titled “TPresence”TPresence extends PresenceData = PresenceData
The room presence shape.
Parameters
Section titled “Parameters”options?
Section titled “options?”CommentsOptions
Optional storage backend configuration.
Returns
Section titled “Returns”The current threads plus add/reply/resolve/reopen and filter helpers.