@cometchat/chat-uikit-react 5.0.9 → 5.0.11

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;
 
@@ -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,
@@ -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;