Expose way to manually hide unread separator. (#6001)

* Expose MessageListViewModel#hideUnreadLabel to manually hide the unread label.

* Revert wrong commit.

* Add test.

* Update CHANGELOG.md.

* Rename hideUnreadLabel() to hideUnreadSeparator().

Author: VelikovPetar

CHANGELOG.md

@@ -51,6 +51,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Add `MessageListController.hideUnreadSeparator()` method to manually hide the unread separator. [#6001](https://github.com/GetStream/stream-chat-android/pull/6001)
 
 ### ⚠️ Changed
 
@@ -62,6 +63,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Add `MessageListViewModel.hideUnreadSeparator()` method to manually hide the unread separator. [#6001](https://github.com/GetStream/stream-chat-android/pull/6001)
 
 ### ⚠️ Changed
 
@@ -73,6 +75,7 @@
 ### ⬆️ Improved
 
 ### ✅ Added
+- Add `MessageListViewModel.hideUnreadSeparator()` method to manually hide the unread separator. [#6001](https://github.com/GetStream/stream-chat-android/pull/6001)
 
 ### ⚠️ Changed
 

stream-chat-android-compose/api/stream-chat-android-compose.api

@@ -5036,6 +5036,7 @@ public final class io/getstream/chat/android/compose/viewmodel/messages/MessageL
 	public final fun getShowSystemMessagesState ()Z
 	public final fun getTypingUsers ()Ljava/util/List;
 	public final fun getUser ()Lkotlinx/coroutines/flow/StateFlow;
+	public final fun hideUnreadSeparator ()V
 	public final fun isInThread ()Z
 	public final fun isOnline ()Lkotlinx/coroutines/flow/Flow;
 	public final fun isShowingOverlay ()Z

stream-chat-android-compose/src/main/java/io/getstream/chat/android/compose/viewmodel/messages/MessageListViewModel.kt

@@ -548,6 +548,13 @@ public class MessageListViewModel(
         messageListController.scrollToFirstUnreadMessage()
     }
 
+    /**
+     * Hides the unread label in the messages list (if already visible).
+     */
+    public fun hideUnreadSeparator() {
+        messageListController.hideUnreadSeparator()
+    }
+
     /**
      * Sets a handler which determines the position of a message inside a group.
      *

stream-chat-android-ui-common/api/stream-chat-android-ui-common.api

@@ -730,6 +730,7 @@ public final class io/getstream/chat/android/ui/common/feature/messages/list/Mes
 	public final fun getUnreadCount ()Lkotlinx/coroutines/flow/StateFlow;
 	public final fun getUnreadLabelState ()Lkotlinx/coroutines/flow/MutableStateFlow;
 	public final fun getUser ()Lkotlinx/coroutines/flow/StateFlow;
+	public final fun hideUnreadSeparator ()V
 	public final fun isInThread ()Z
 	public final fun isInsideSearch ()Lkotlinx/coroutines/flow/StateFlow;
 	public final fun isStartedForThread ()Z

stream-chat-android-ui-common/src/main/kotlin/io/getstream/chat/android/ui/common/feature/messages/list/MessageListController.kt

@@ -628,6 +628,13 @@ public class MessageListController(
         unreadLabelState.value = unreadLabelState.value?.copy(buttonVisibility = false)
     }
 
+    /**
+     * Hides the unread label in the messages list (if already visible).
+     */
+    public fun hideUnreadSeparator() {
+        unreadLabelState.value = null
+    }
+
     /**
      * Scrolls to the first unread message in the channel.
      */

stream-chat-android-ui-common/src/test/kotlin/io/getstream/chat/android/ui/common/feature/messages/list/MessageListControllerTests.kt

@@ -966,6 +966,41 @@ internal class MessageListControllerTests {
         }
     }
 
+    @Test
+    fun `When hideUnreadSeparator is called, unread label state is set to null`() = runTest {
+        val user = randomUser()
+        val firstMessage = randomMessage(id = "last_read_message_id", deletedAt = null, deletedForMe = false)
+        val messages = listOf(
+            firstMessage,
+            randomMessage(id = "first_unread_message_id", deletedAt = null, deletedForMe = false),
+        )
+        val channelRead = MutableStateFlow(
+            randomChannelUserRead(
+                user = user,
+                lastReadMessageId = firstMessage.id,
+                unreadMessages = 1,
+            ),
+        )
+        val messagesState = MutableStateFlow(messages)
+        val controller = Fixture()
+            .givenCurrentUser(user)
+            .givenChannelState(
+                messagesState = messagesState,
+                read = channelRead,
+            )
+            .get()
+
+        // Verify unread label is initially visible
+        val unreadLabel = controller.unreadLabelState.value
+        unreadLabel.shouldNotBeNull()
+
+        // Hide the unread label
+        controller.hideUnreadSeparator()
+
+        // Verify unread label state is now null
+        controller.unreadLabelState.value.shouldBeNull()
+    }
+
     @Test
     fun `When reactToMessage is called with skipPush set to true, sendReaction is invoked with skipPush true`() = runTest {
         val messageId = randomString()

stream-chat-android-ui-components/api/stream-chat-android-ui-components.api

@@ -4668,6 +4668,7 @@ public final class io/getstream/chat/android/ui/viewmodel/messages/MessageListVi
 	public final fun getUnreadCount ()Landroidx/lifecycle/LiveData;
 	public final fun getUnreadLabel ()Landroidx/lifecycle/LiveData;
 	public final fun getUser ()Landroidx/lifecycle/LiveData;
+	public final fun hideUnreadSeparator ()V
 	public final fun onEvent (Lio/getstream/chat/android/ui/viewmodel/messages/MessageListViewModel$Event;)V
 	public final fun pauseAudioRecordingAttachments ()V
 	public final fun scrollToBottom (ILkotlin/jvm/functions/Function0;)V

stream-chat-android-ui-components/src/main/kotlin/io/getstream/chat/android/ui/viewmodel/messages/MessageListViewModel.kt

@@ -341,6 +341,13 @@ public class MessageListViewModel(
         messageListController.scrollToFirstUnreadMessage()
     }
 
+    /**
+     * Hides the unread label in the messages list (if already visible).
+     */
+    public fun hideUnreadSeparator() {
+        messageListController.hideUnreadSeparator()
+    }
+
     /**
      * Sets the date separator handler which determines when to add date separators.
      * By default, a date separator will be added if the difference between two messages' dates is greater than 4h.