@talkjs/react-components 0.1.0 → 0.1.2

package/default.d.ts

@@ -6,6 +6,7 @@ import { FileBlock } from '@talkjs/core';
 import { FileToken } from '@talkjs/core';
 import { GenericFileBlock } from '@talkjs/core';
 import { ImageBlock } from '@talkjs/core';
+import { JSX as JSX } from 'react/jsx-runtime';
 import { LocationBlock } from '@talkjs/core';
 import { MessageSnapshot } from '@talkjs/core';
 import { ParticipantSnapshot } from '@talkjs/core';
@@ -535,11 +536,6 @@ export declare interface CommonChatboxProps {
      * The conversation displayed in the chatbox.
      */
     conversation: ConversationSnapshot;
-    /**
-     * A list of participants that are part of the conversation that's currently
-     * being shown.
-     */
-    participants: ParticipantSnapshot[];
     /**
      * Tells you which participants are currently typing
      */
@@ -674,10 +670,6 @@ export declare interface ConversationListItemProps {
      * The conversation that's being displayed.
      */
     conversation: ConversationSnapshot;
-    /**
-     * The list of participants that are part of the given conversation.
-     */
-    participants: ParticipantSnapshot[];
     /**
      * If `true`, this conversation is the currently selected one in the
      * conversation list.
@@ -1698,6 +1690,19 @@ declare interface TranslationStrings {
 
 export { TypingSnapshot }
 
+/**
+ * Returns a list of participants in the conversation with the given ID.
+ * It'll initially return an empty list, and re-render the calling component as data participants are loaded.
+ * It'll also cause a re-render when any of those participants change, such as when a user's name or photoUrl changes.
+ *
+ * @param conversationId ID of the conversation
+ * @param limit Maximum number of participants to subscribe to. Defaults to 10. The maximum is 100.
+ * @returns List of participant snapshots.
+ *
+ * @public
+ */
+export declare function useParticipants(conversationId: string, limit?: number): ParticipantSnapshot[];
+
 /**
  * Returns "Yesterday", "Last Monday", "Tuesday, March 31" or "Monday, March 31
  * 2014", depending on which is most appropriate.