feat: Add possibility to deselect active channel #248

Author: szuperaz

projects/stream-chat-angular/src/lib/channel.service.spec.ts

@@ -182,6 +182,28 @@ describe('ChannelService', () => {
     expect(latestMessagesSpy).toHaveBeenCalledWith({});
   });
 
+  it('should deselect active channel', async () => {
+    await init();
+    const messagesSpy = jasmine.createSpy();
+    service.activeChannelMessages$.subscribe(messagesSpy);
+    const activeChannelSpy = jasmine.createSpy();
+    service.activeChannel$.subscribe(activeChannelSpy);
+    const messageToQuoteSpy = jasmine.createSpy();
+    service.messageToQuote$.subscribe(messageToQuoteSpy);
+    const latestMessagesSpy = jasmine.createSpy();
+    service.latestMessageDateByUserByChannels$.subscribe(latestMessagesSpy);
+    messagesSpy.calls.reset();
+    activeChannelSpy.calls.reset();
+    messageToQuoteSpy.calls.reset();
+    latestMessagesSpy.calls.reset();
+    service.deselectActiveChannel();
+
+    expect(messagesSpy).toHaveBeenCalledWith([]);
+    expect(activeChannelSpy).toHaveBeenCalledWith(undefined);
+    expect(messageToQuoteSpy).toHaveBeenCalledWith(undefined);
+    expect(latestMessagesSpy).toHaveBeenCalledWith({});
+  });
+
   it('should tell if user #hasMoreChannels$', async () => {
     await init();
     const spy = jasmine.createSpy();

projects/stream-chat-angular/src/lib/channel.service.ts

@@ -325,6 +325,22 @@ export class ChannelService {
     this.messageToQuoteSubject.next(undefined);
   }
 
+  /**
+   * Deselects the currently active (if any) channel
+   */
+  deselectActiveChannel() {
+    const activeChannel = this.activeChannelSubject.getValue();
+    if (!activeChannel) {
+      return;
+    }
+    this.activeChannelMessagesSubject.next([]);
+    this.activeChannelSubject.next(undefined);
+    this.activeParentMessageIdSubject.next(undefined);
+    this.activeThreadMessagesSubject.next([]);
+    this.latestMessageDateByUserByChannelsSubject.next({});
+    this.selectMessageToQuote(undefined);
+  }
+
   /**
    * Sets the given `message` as an active parent message. If `undefined` is provided, it will deleselect the current parent message.
    * @param message
@@ -392,7 +408,7 @@ export class ChannelService {
    * @param filters
    * @param sort
    * @param options
-   * @param shouldSetActiveChannel Decides if the firs channel in the result should be made as active channel, or no channel should be marked as active
+   * @param shouldSetActiveChannel Decides if the first channel in the result should be made as an active channel, or no channel should be marked as active
    * @returns the list of channels found by the query
    */
   async init(
@@ -422,13 +438,8 @@ export class ChannelService {
    * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./ChatClientService.mdx/#disconnectuser).
    */
   reset() {
-    this.activeChannelMessagesSubject.next([]);
-    this.activeChannelSubject.next(undefined);
-    this.activeParentMessageIdSubject.next(undefined);
-    this.activeThreadMessagesSubject.next([]);
+    this.deselectActiveChannel();
     this.channelsSubject.next(undefined);
-    this.latestMessageDateByUserByChannelsSubject.next({});
-    this.selectMessageToQuote(undefined);
   }
 
   /**