Skip to main content

useParticipants

Introduction

The useParticipants hook is used to fetch the chatroom participant list. You can use this to implement a custom UI for the participant list component.

PropertyTypeDescription
participantsListMember[]List of chatroom participants.
loadMoreParticipantsbooleanIndicates if more participants can be loaded.
getMembersZeroArgVoidReturnsFunction to fetch the list of participants.
navigateBackToChatroomZeroArgVoidReturnsFunction to navigate back to the chatroom.
searchKeywordstringSearch keyword used to filter participants.
setSearchKeywordDispatch<string>Function to update the search keyword.
totalParticipantCountnumberTotal number of participants in the chatroom.

Reference

For reference checkout this file