@cometchat/chat-uikit-react 5.0.9 → 5.0.10

package/dist/index.d.ts

@@ -300,16 +300,64 @@ declare enum MentionsVisibility {
 }
 
 interface MentionsProps {
+    /**
+     * Determines the type of list to display - either users or group members.
+     * @defaultValue `UserMemberListType.users`
+     */
     userMemberListType?: UserMemberListType;
+    /**
+     * Callback function invoked when a user or group member item is clicked.
+     * @param user - The clicked user (CometChat.User) or group member (CometChat.GroupMember)
+     * @returns void
+     */
     onItemClick?: (user: CometChat.User | CometChat.GroupMember) => void;
+    /**
+     * A custom view to render each user or group member item in the list.
+     *
+     * @param item - An instance of CometChat.User or CometChat.GroupMember to be rendered
+     * @returns A JSX element representing the custom item view
+     */
     itemView?: (item?: CometChat.User | CometChat.GroupMember) => JSX.Element;
+    /**
+     * The search keyword used to filter users or group members.
+     */
     searchKeyword?: string;
+    /**
+     * The group instance for which to display group members.
+     */
     group?: CometChat.Group;
+    /**
+     * A custom view to render the subtitle for each user or group member item.
+     * @param item - An instance of CometChat.User or CometChat.GroupMember
+     * @returns A JSX element representing the custom subtitle view
+     */
     subtitleView?: (item?: CometChat.User | CometChat.GroupMember) => JSX.Element;
+    /**
+     * A request builder to fetch users with custom parameters.
+     */
     usersRequestBuilder?: CometChat.UsersRequestBuilder;
+    /**
+     * Callback function invoked when the list is empty (no users or group members found).
+     *
+     * @returns void
+     */
     onEmpty?: () => void;
+    /**
+     * A request builder to fetch group members with custom parameters.
+     */
     groupMemberRequestBuilder?: CometChat.GroupMembersRequestBuilder;
+    /**
+     * Callback function invoked when an error occurs while fetching users or group members.
+     *
+     * @returns void
+     */
     onError?: () => void;
+    /**
+     * Controls the visibility of the scrollbar in the list.
+     *
+     * @defaultValue `false`
+     */
+    showScrollbar?: boolean;
 }
 declare function CometChatUserMemberWrapper(props: MentionsProps): react_jsx_runtime.JSX.Element;
 
@@ -6835,7 +6883,7 @@ declare class MessagesDataSource implements DataSource {
     }): Array<string>;
     getStickerButton(id: ComposerId, user?: CometChat.User, group?: CometChat.Group): JSX.Element | undefined;
     getId(): string;
-    getTextMessageContentView(message: CometChat.TextMessage, _alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): JSX.Element | Element;
+    getTextMessageContentView(message: CometChat.TextMessage, _alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): Element | JSX.Element;
     getAudioMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
     getFileMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
     getImageMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
@@ -7581,13 +7629,13 @@ declare abstract class DataSourceDecorator implements DataSource {
     getVideoMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     getAudioMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     getFileMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
-    getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipts?: boolean, datePattern?: DatePatterns): JSX.Element | Element | null;
-    getBottomView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment): JSX.Element | Element | null;
-    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: Object | undefined): JSX.Element | Element;
-    getImageMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getVideoMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getAudioMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getFileMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
+    getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipts?: boolean, datePattern?: DatePatterns): Element | JSX.Element | null;
+    getBottomView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment): Element | JSX.Element | null;
+    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: Object | undefined): Element | JSX.Element;
+    getImageMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getVideoMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getAudioMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getFileMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
     getTextMessageTemplate(additionalConfigurations?: Object | undefined): CometChatMessageTemplate;
     getImageMessageTemplate(): CometChatMessageTemplate;
     getVideoMessageTemplate(): CometChatMessageTemplate;
@@ -7603,28 +7651,28 @@ declare abstract class DataSourceDecorator implements DataSource {
     getAllMessageCategories(additionalConfigurations?: Object | undefined): string[];
     getStickerButton(id: ComposerId, user?: CometChat.User, group?: CometChat.Group): JSX.Element | undefined;
     getId(): string;
-    getDeleteMessageBubble(messageObject: CometChat.BaseMessage, text?: string, alignment?: MessageBubbleAlignment): JSX.Element | Element;
-    getGroupActionBubble(message: CometChat.BaseMessage): JSX.Element | Element;
-    getTextMessageBubble(messageText: string, message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: Object | undefined): JSX.Element | Element;
-    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function, alignment?: MessageBubbleAlignment): JSX.Element | Element;
-    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function, alignment?: MessageBubbleAlignment): JSX.Element | Element;
-    getAudioMessageBubble(audioUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): JSX.Element | Element;
-    getFileMessageBubble(fileUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): JSX.Element | Element;
+    getDeleteMessageBubble(messageObject: CometChat.BaseMessage, text?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getGroupActionBubble(message: CometChat.BaseMessage): Element | JSX.Element;
+    getTextMessageBubble(messageText: string, message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: Object | undefined): Element | JSX.Element;
+    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getAudioMessageBubble(audioUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getFileMessageBubble(fileUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
     getLastConversationMessage(conversation: CometChat.Conversation, loggedInUser: CometChat.User, additionalConfigurations?: additionalParams): string;
     getAuxiliaryHeaderMenu(user?: CometChat.User, group?: CometChat.Group, additionalConfigurations?: any): Element[] | JSX.Element[];
     getAllTextFormatters(formatterParams: additionalParams): CometChatTextFormatter[];
     getMentionsTextFormatter(params?: Object): CometChatMentionsFormatter;
     getUrlTextFormatter(params?: Object): CometChatUrlsFormatter;
     getMentionsFormattedText(message: CometChat.TextMessage, subtitle: string, additionalConfigurations: Object): string;
-    getFormMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getSchedulerMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getCardMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
+    getFormMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getSchedulerMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getCardMessageContentView(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
     getFormMessageTemplate(): CometChatMessageTemplate;
     getSchedulerMessageTemplate(): CometChatMessageTemplate;
     getCardMessageTemplate(): CometChatMessageTemplate;
-    getFormMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getSchedulerMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
-    getCardMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
+    getFormMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getSchedulerMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getCardMessageBubble(message: CometChat.InteractiveMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
 }
 
 interface ListProps<T> {
@@ -7741,6 +7789,11 @@ interface ListProps<T> {
    * @defaultValue `""`
    */
     title?: string;
+    /**
+     * Controls the visibility of the scrollbar in the list.
+     * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 /**
  * Renders a list component that can display a title, search bar,
@@ -8147,7 +8200,7 @@ declare class LinkPreviewExtensionDecorator extends DataSourceDecorator {
      * @param {any} [additionalConfigurations] - Additional configurations for formatting.
      * @returns {JSX.Element} The JSX element representing the message content view.
      */
-    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): react_jsx_runtime.JSX.Element | Element;
+    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): Element | React__default.JSX.Element;
     /**
      * Retrieves the style for the link preview wrapper.
      * @returns {object} The style object for the link preview wrapper.
@@ -8241,7 +8294,7 @@ declare class MessageTranslationExtensionDecorator extends DataSourceDecorator {
      * @param {any} [additionalConfigurations] - Optional additional configurations for the content view.
      * @returns {JSX.Element} The content view for the text message.
      */
-    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): react_jsx_runtime.JSX.Element | Element;
+    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): Element | React.JSX.Element;
     /**
      * Checks if an option with the specified ID already exists in the options list.
      *
@@ -8584,7 +8637,7 @@ declare class ThumbnailGenerationExtensionDecorator extends DataSourceDecorator
     * @param {ImageBubbleStyle} [style] - Optional style for the image bubble.
     * @returns {React.ReactNode} The rendered image message bubble.
     */
-    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function): React.JSX.Element | Element;
+    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function): Element | React.JSX.Element;
     /**
      * Provides the video message bubble with support for thumbnail generation.
      * It checks for a thumbnail URL in the message metadata and uses it if available.
@@ -8595,7 +8648,7 @@ declare class ThumbnailGenerationExtensionDecorator extends DataSourceDecorator
      * @param {Function} [onClick] - Optional click event handler.
      * @returns {React.ReactNode} The rendered video message bubble.
      */
-    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function): React.JSX.Element | Element;
+    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function): Element | React.JSX.Element;
 }
 
 declare class CallingExtensionDecorator extends DataSourceDecorator {
@@ -8839,6 +8892,11 @@ interface CallLogsProps {
      * @returns A JSX element to be rendered as the trailing view.
      */
     trailingView?: (call: any) => JSX.Element;
+    /**
+     * Controls the visibility of the scrollbar in the list.
+     * @defaultValue `false`
+     */
+    showScrollbar?: boolean;
 }
 declare const CometChatCallLogs: (props: CallLogsProps) => react_jsx_runtime.JSX.Element;
 
@@ -8990,6 +9048,11 @@ interface ConversationsProps {
      * @returns A JSX element to be rendered as the trailing view.
      */
     trailingView?: (conversation: CometChat.Conversation) => JSX.Element;
+    /**
+     * Controls the visibility of the scrollbar in the list.
+     * @defaultValue `false`
+     */
+    showScrollbar?: boolean;
 }
 /**
  * Renders a scrollable list of conversations that has been created in a CometChat app
@@ -9150,6 +9213,11 @@ interface GroupMembersProps {
      * @returns A JSX element to be rendered as the trailing view.
      */
     trailingView?: (groupMember: CometChat.GroupMember) => JSX.Element;
+    /**
+     * Controls the visibility of the scrollbar in the list.
+     * @defaultValue `false`
+     */
+    showScrollbar?: boolean;
 }
 declare function CometChatGroupMembers(props: GroupMembersProps): react_jsx_runtime.JSX.Element;
 
@@ -9273,6 +9341,11 @@ interface GroupsProps {
      * @returns A JSX element to be rendered as the trailing view.
      */
     trailingView?: (group: CometChat.Group) => JSX.Element;
+    /**
+    * Controls the visibility of the scrollbar in the list.
+    * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 /**
  * Renders a scrollable list of groups that has been created in a CometChat app
@@ -9449,6 +9522,11 @@ interface MessageComposerProps {
      * A custom header section displayed at the top of the message composer, often used for media previews or additional information.
      */
     headerView?: JSX.Element;
+    /**
+    * Controls the visibility of the scrollbar in the list.
+    * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 /**
  * Renders a message composer to send messages to a user or group of a CometChat App
@@ -9753,6 +9831,11 @@ interface MessageListProps {
      * A custom footer view component for the message list.
      */
     footerView?: JSX.Element;
+    /**
+      * Controls the visibility of the scrollbar in the list.
+      * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 declare const CometChatMessageList: (props: MessageListProps) => react_jsx_runtime.JSX.Element;
 
@@ -9909,6 +9992,12 @@ interface UsersProps {
      * @returns A JSX element to be rendered as the trailing view.
      */
     trailingView?: (user: CometChat.User) => JSX.Element;
+    /**
+     * Controls the visibility of the scrollbar in the list list.
+     *
+     * @defaultValue `false`
+     */
+    showScrollbar?: boolean;
 }
 /**
  * Renders a scrollable list of users that has been created in a CometChat app
@@ -9936,6 +10025,11 @@ interface MessageInformationProps {
     * Array of text formatters for custom styling or formatting of message text bubbles.
     */
     textFormatters?: CometChatTextFormatter[];
+    /**
+    * Controls the visibility of the scrollbar in the list.
+    * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 declare const CometChatMessageInformation: (props: MessageInformationProps) => react_jsx_runtime.JSX.Element;
 
@@ -11360,6 +11454,11 @@ interface ThreadedMessagePreviewProps {
     * Array of text formatters for custom styling or formatting of message text bubbles.
     */
     textFormatters?: CometChatTextFormatter[];
+    /**
+    * Controls the visibility of the scrollbar in the list.
+    * @defaultValue `false`
+    */
+    showScrollbar?: boolean;
 }
 declare const CometChatThreadedMessagePreview: (props: ThreadedMessagePreviewProps) => react_jsx_runtime.JSX.Element;