stream-chat-angular 2.14.0 → 2.15.0

package/lib/attachment-list/attachment-list.component.d.ts

@@ -4,10 +4,19 @@ import { ImageLoadService } from '../message-list/image-load.service';
 import { DefaultAttachmentType } from '../types';
 import { ChannelService } from '../channel.service';
 import * as i0 from "@angular/core";
+/**
+ * The `AttachmentList` compontent displays the attachments of a message
+ */
 export declare class AttachmentListComponent implements OnChanges {
     private imageLoadService;
     private channelService;
+    /**
+     * The id of the message the attachments belong to
+     */
     messageId: string | undefined;
+    /**
+     * The attachments to display
+     */
     attachments: Attachment<DefaultAttachmentType>[];
     orderedAttachments: Attachment<DefaultAttachmentType>[];
     constructor(imageLoadService: ImageLoadService, channelService: ChannelService);

package/lib/attachment-preview-list/attachment-preview-list.component.d.ts

@@ -2,6 +2,9 @@ import { Observable } from 'rxjs';
 import { AttachmentService } from '../attachment.service';
 import { AttachmentUpload } from '../types';
 import * as i0 from "@angular/core";
+/**
+ * The `AttachmentPreviewList` compontent displays a preview of the attachments uploaded to a message. Users can delete attachments using the preview component, or retry upload if it failed previously.
+ */
 export declare class AttachmentPreviewListComponent {
     private attachmentService;
     attachmentUploads$: Observable<AttachmentUpload[]>;

package/lib/attachment.service.d.ts

@@ -15,7 +15,7 @@ export declare class AttachmentService {
      */
     attachmentUploadInProgressCounter$: Observable<number>;
     /**
-     * Emits the state of the uploads ([`AttachmentUpload[]`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/types.ts)), it adds a state (`success`, `error` or `uploading`) to each file the user selects for upload. It is used by the [`AttachmentPreviewList`](../components/attachment-preview-list.mdx) to display the attachment previews.
+     * Emits the state of the uploads ([`AttachmentUpload[]`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/types.ts)), it adds a state (`success`, `error` or `uploading`) to each file the user selects for upload. It is used by the [`AttachmentPreviewList`](../components/AttachmentPreviewListComponent.mdx) to display the attachment previews.
      */
     attachmentUploads$: Observable<AttachmentUpload[]>;
     private attachmentUploadInProgressCounterSubject;

package/lib/avatar/avatar.component.d.ts

@@ -1,7 +1,19 @@
 import * as i0 from "@angular/core";
+/**
+ * The `Avatar` component displays the provided image, with fallback to the first letter of the optional name input.
+ */
 export declare class AvatarComponent {
+    /**
+     * An optional name of the image, used for fallback image or image title (if `imageUrl` is provided)
+     */
     name: string | undefined;
+    /**
+     * The URL of the image to be displayed. If the image can't be displayed the first letter of the name input is displayed.
+     */
     imageUrl: string | undefined;
+    /**
+     * The size in pixels of the avatar image.
+     */
     size: number;
     isLoaded: boolean;
     isError: boolean;

package/lib/channel/channel.component.d.ts

@@ -1,6 +1,9 @@
 import { Observable, Subscription } from 'rxjs';
 import { ChannelService } from '../channel.service';
 import * as i0 from "@angular/core";
+/**
+ * The `Channel` component is a container component that displays the [`ChannelHeader`](./ChannelHeaderComponent.mdx), [`MessageList`](./MessageListComponent.mdx), [`NotificationList`](./NotificationListComponent.mdx) and [`MessageInput`](./MessageInputComponent.mdx) components. You can also provide the [`Thread`](./ThreadComponent.mdx) component to use message [threads](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+ */
 export declare class ChannelComponent {
     private channelService;
     isError$: Observable<boolean>;

package/lib/channel-header/channel-header.component.d.ts

@@ -2,6 +2,9 @@ import { Channel } from 'stream-chat';
 import { ChannelListToggleService } from '../channel-list/channel-list-toggle.service';
 import { ChannelService } from '../channel.service';
 import * as i0 from "@angular/core";
+/**
+ * The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript#watchers-vs-members) in the platform documentation. Please note that number of watchers is only displayed if the user has [`connect-events` capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript)
+ */
 export declare class ChannelHeaderComponent {
     private channelService;
     private channelListToggleService;

package/lib/channel-list/channel-list.component.d.ts

@@ -4,9 +4,15 @@ import { Channel } from 'stream-chat';
 import { ChannelService } from '../channel.service';
 import { ChannelListToggleService } from './channel-list-toggle.service';
 import * as i0 from "@angular/core";
+/**
+ * The `ChannelList` component renders the list of channels.
+ */
 export declare class ChannelListComponent implements AfterViewInit {
     private channelService;
     private channelListToggleService;
+    /**
+     * By default, the [default preview component](./ChannelPreviewComponent.mdx) is used. To change the contents of the channel list, [provide your own custom template](./ChannelPreviewComponent.mdx/#customization).
+     */
     customChannelPreviewTemplate: TemplateRef<any> | undefined;
     channels$: Observable<Channel[] | undefined>;
     isError$: Observable<boolean>;

package/lib/channel-preview/channel-preview.component.d.ts

@@ -2,9 +2,15 @@ import { NgZone, OnDestroy, OnInit } from '@angular/core';
 import { Channel } from 'stream-chat';
 import { ChannelService } from '../channel.service';
 import * as i0 from "@angular/core";
+/**
+ * The `ChannelPreview` component displays a channel preview in the channel list, it consists of the image, name and latest message of the channel.
+ */
 export declare class ChannelPreviewComponent implements OnInit, OnDestroy {
     private channelService;
     private ngZone;
+    /**
+     * The channel to be displayed
+     */
     channel: Channel | undefined;
     isActive: boolean;
     isUnread: boolean;

package/lib/channel.service.d.ts

@@ -149,7 +149,7 @@ export declare class ChannelService {
      */
     init(filters: ChannelFilters, sort?: ChannelSort, options?: ChannelOptions): Promise<void>;
     /**
-     * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./chat-client.mdx/#disconnectuser).
+     * Resets the `activeChannel$`, `channels$` and `activeChannelMessages$` Observables. Useful when disconnecting a chat user, use in combination with [`disconnectUser`](./ChatClientService.mdx/#disconnectuser).
      */
     reset(): void;
     /**

package/lib/icon/icon.component.d.ts

@@ -1,7 +1,16 @@
 import * as i0 from "@angular/core";
 export declare type Icon = 'action-icon' | 'delivered-icon' | 'reaction-icon' | 'connection-error' | 'send' | 'file-upload' | 'retry' | 'close' | 'file' | 'reply' | 'close-no-outline' | 'reply-in-thread';
+/**
+ * The `Icon` component can be used to display different icons (i. e. message delivered icon).
+ */
 export declare class IconComponent {
+    /**
+     * The icon to display, the list of [supported icons](https://github.com/GetStream/stream-chat-angular/tree/master/projects/stream-chat-angular/src/lib/icon/icon.component.ts) can be found on GitHub.
+     */
     icon: Icon | undefined;
+    /**
+     * The size of the icon (in pixels)
+     */
     size: number | undefined;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<IconComponent, never>;

package/lib/loading-indicator/loading-indicator.component.d.ts

@@ -1,6 +1,15 @@
 import * as i0 from "@angular/core";
+/**
+ * The `LoadingIndicator` component displays a spinner to indicate that an action is in progress.
+ */
 export declare class LoadingIndicatorComponent {
+    /**
+     * The size of the indicator (in pixels)
+     */
     size: number;
+    /**
+     * The color of the indicator
+     */
     color: string;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<LoadingIndicatorComponent, never>;

package/lib/message/message.component.d.ts

@@ -9,26 +9,50 @@ declare type MessagePart = {
     type: 'text' | 'mention';
     user?: UserResponse;
 };
+/**
+ * The `Message` component displays a message with additional information such as sender and date, and enables [interaction with the message (i.e. edit or react)](../concepts/message-interactions.mdx).
+ */
 export declare class MessageComponent implements OnChanges {
     private chatClientService;
     private channelService;
+    /**
+     * The input used for message edit. By default, the [default message input component](./MessageInputComponent.mdx) is used. To change the input for message edit, provide [your own custom template](./MessageInputComponent.mdx/#customization).
+     */
     messageInputTemplate: TemplateRef<any> | undefined;
+    /**
+     * The template used to display a mention in a message. It receives the mentioned user in a variable called `user` with the type [`UserResponse`](https://github.com/GetStream/stream-chat-js/blob/master/src/types.ts). You can provide your own template if you want to [add actions to mentions](../code-examples/mention-actions.mdx).
+     */
     mentionTemplate: TemplateRef<any> | undefined;
+    /**
+     * The message to be displayed
+     */
     message: StreamMessage | undefined;
+    /**
+     * The list of [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) that are enabled for the current user, the list of [supported interactions](../concepts/message-interactions.mdx) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. The [`MessageList`](./MessageListComponent.mdx) component automatically sets this based on [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+     */
     enabledMessageActions: string[];
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#caution-arereactionsenabled-deprecated
+     * If true, the message reactions are displayed. If you use the default chat UI you can also set this using the [`MessageList`](./MessageListComponent.mdx) component.
+     * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead
      */
     areReactionsEnabled: boolean | undefined;
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#canreacttomessage-deprecated
+     * If true, the user can add reactions to the message. The [`MessageList`](./MessageListComponent.mdx) component automatically sets this based on [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+     * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead
      */
     canReactToMessage: boolean | undefined;
+    /**
+     * If `true`, the message status (sending, sent, who read the message) is displayed.
+     */
     isLastSentMessage: boolean | undefined;
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#canreceivereadevents-deprecated
+     * If true, the read indicator is displayed. The [`MessageList`](./MessageListComponent.mdx) component automatically sets this based on [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+     * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead
      */
     canReceiveReadEvents: boolean | undefined;
+    /**
+     * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+     */
     mode: 'thread' | 'main';
     isEditing: boolean | undefined;
     isActionBoxOpen: boolean;

package/lib/message-actions-box/message-actions-box.component.d.ts

@@ -8,16 +8,40 @@ import * as i0 from "@angular/core";
  * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message-actions/#required-enabledactions
  */
 export declare type MessageActions = 'edit' | 'delete' | 'edit-any' | 'delete-any' | 'pin' | 'quote' | 'flag' | 'mute';
+/**
+ * The `MessageActionsBox` component displays a list of message actions (i.e edit), that can be opened or closed. You can find the [list of the supported actions](../concepts/message-interactions.mdx) in the message interaction guide.
+ */
 export declare class MessageActionsBoxComponent implements OnChanges {
     private chatClientService;
     private notificationService;
     private channelService;
+    /**
+     * The input used for message edit. By default, the [default message input component](./MessageInputComponent.mdx) is used. To change the input for message edit, provide [your own custom template](./MessageInputComponent.mdx/#customization).
+     */
     messageInputTemplate: TemplateRef<any> | undefined;
+    /**
+     * Indicates if the list should be opened or closed. Adding a UI element to open and close the list is the parent's component responsibility.
+     */
     isOpen: boolean;
+    /**
+     * Indicates if the message actions are belonging to a message that was sent by the current user or not.
+     */
     isMine: boolean;
+    /**
+     * The message the actions will be executed on
+     */
     message: StreamMessage | undefined;
+    /**
+     * The list of [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) that are enabled for the current user, the list of [supported interactions](../concepts/message-interactions.mdx) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI.
+     */
     enabledActions: string[];
+    /**
+     * The number of authorized actions (it can be less or equal than the number of enabled actions)
+     */
     readonly displayedActionsCount: EventEmitter<number>;
+    /**
+     * An event which emits `true` if the edit message modal is open, and `false` when it is closed.
+     */
     readonly isEditing: EventEmitter<boolean>;
     isEditModalOpen: boolean;
     private messageInput;

package/lib/message-input/autocomplete-textarea/autocomplete-textarea.component.d.ts

@@ -8,19 +8,46 @@ import { ChatClientService } from '../../chat-client.service';
 import { TransliterationService } from '../../transliteration.service';
 import { EmojiInputService } from '../emoji-input.service';
 import * as i0 from "@angular/core";
+/**
+ * The `AutocompleteTextarea` component is used by the [`MessageInput`](./MessageInputComponent.mdx) component to display the input HTML element where users can type their message.
+ */
 export declare class AutocompleteTextareaComponent implements TextareaInterface, OnChanges {
     private channelService;
     private chatClientService;
     private transliterationService;
     private emojiInputService;
     class: string;
+    /**
+     * The value of the input HTML element.
+     */
     value: string;
+    /**
+     * If true, users can mention other users in messages. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+     */
     areMentionsEnabled: boolean | undefined;
+    /**
+     * You can provide your own template for the autocomplete list for user mentions. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+     */
     mentionAutocompleteItemTemplate: TemplateRef<MentionAutcompleteListItemContext> | undefined;
+    /**
+     * You can provide your own template for the autocomplete list for commands. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+     */
     commandAutocompleteItemTemplate: TemplateRef<CommandAutocompleteListItemContext> | undefined;
+    /**
+     * The scope for user mentions, either members of the current channel of members of the application. You can also set this input on the [`MessageInput`](./MessageInputComponent.mdx/#inputs-and-outputs) component.
+     */
     mentionScope: 'channel' | 'application';
+    /**
+     * Emits the current value of the input element when a user types.
+     */
     readonly valueChange: EventEmitter<string>;
+    /**
+     * Emits when a user triggers a message send event (this happens when they hit the `Enter` key).
+     */
     readonly send: EventEmitter<void>;
+    /**
+     * Emits the array of users that are mentioned in the message, it is updated when a user mentions a new user or deletes a mention.
+     */
     readonly userMentions: EventEmitter<UserResponse<import("stream-chat").UR>[]>;
     private readonly autocompleteKey;
     private readonly mentionTriggerChar;

package/lib/message-input/message-input-config.service.d.ts

@@ -2,7 +2,7 @@ import { TemplateRef } from '@angular/core';
 import { CommandAutocompleteListItemContext, MentionAutcompleteListItemContext } from '../types';
 import * as i0 from "@angular/core";
 /**
- * The `MessageInputConfigService` is used to keep a consistent configuration among the different [`MessageInput`](../components/message-input.mdx) components if your UI has more than one input component.
+ * The `MessageInputConfigService` is used to keep a consistent configuration among the different [`MessageInput`](../components/MessageInputComponent.mdx) components if your UI has more than one input component.
  */
 export declare class MessageInputConfigService {
     /**

package/lib/message-input/message-input.component.d.ts

@@ -10,6 +10,9 @@ import { MessageInputConfigService } from './message-input-config.service';
 import { TextareaInterface } from './textarea.interface';
 import { EmojiInputService } from './emoji-input.service';
 import * as i0 from "@angular/core";
+/**
+ * The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
+ */
 export declare class MessageInputComponent implements OnChanges, OnDestroy, AfterViewInit {
     private channelService;
     private notificationService;
@@ -20,19 +23,51 @@ export declare class MessageInputComponent implements OnChanges, OnDestroy, Afte
     private cdRef;
     private chatClient;
     emojiInputService: EmojiInputService;
+    /**
+     * If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript). If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     isFileUploadEnabled: boolean | undefined;
+    /**
+     * If true, users can mention other users in messages. You also [need to use the `AutocompleteTextarea`](../concepts/opt-in-architecture.mdx) for this feature to work. If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     areMentionsEnabled: boolean | undefined;
+    /**
+     * The scope for user mentions, either members of the current channel of members of the application. If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     mentionScope: 'channel' | 'application' | undefined;
+    /**
+     * You can provide your own template for the autocomplete list for user mentions. You also [need to use the `AutocompleteTextarea`](../concepts/opt-in-architecture.mdx) for this feature to work. If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     mentionAutocompleteItemTemplate: TemplateRef<MentionAutcompleteListItemContext> | undefined;
+    /**
+     * You can provide your own template for the autocomplete list for commands. You also [need to use the `AutocompleteTextarea`](../concepts/opt-in-architecture.mdx) for this feature to work. If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     commandAutocompleteItemTemplate: TemplateRef<CommandAutocompleteListItemContext> | undefined;
+    /**
+     * You can add an emoji picker by [providing your own emoji picker template](../code-examples/emoji-picker.mdx)
+     */
     emojiPickerTemplate: TemplateRef<void> | undefined;
+    /**
+     * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+     */
     mode: 'thread' | 'main';
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message-input/#caution-acceptedfiletypes
+     * You can narrow the accepted file types by providing the [accepted types](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept). By default every file type is accepted.
+     * If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     * @deprecated use [application settings](https://getstream.io/chat/docs/javascript/app_setting_overview/?language=javascript#file-uploads) instead
      */
     acceptedFileTypes: string[] | undefined;
+    /**
+     * If true, users can select multiple files to upload. If no value is provided, it is set from the [`MessageInputConfigService`](../services/MessageInputConfigService.mdx).
+     */
     isMultipleFileUploadEnabled: boolean | undefined;
+    /**
+     * The message to edit
+     */
     message: StreamMessage | undefined;
+    /**
+     * Emits when a message was successfuly sent or updated
+     */
     readonly messageUpdate: EventEmitter<void>;
     isFileUploadAuthorized: boolean | undefined;
     canSendLinks: boolean | undefined;

package/lib/message-input/textarea/textarea.component.d.ts

@@ -2,11 +2,23 @@ import { EventEmitter, OnChanges, OnDestroy } from '@angular/core';
 import { EmojiInputService } from '../emoji-input.service';
 import { TextareaInterface } from '../textarea.interface';
 import * as i0 from "@angular/core";
+/**
+ * The `Textarea` component is used by the [`MessageInput`](./MessageInputComponent.mdx) component to display the input HTML element where users can type their message.
+ */
 export declare class TextareaComponent implements TextareaInterface, OnChanges, OnDestroy {
     private emojiInputService;
     class: string;
+    /**
+     * The value of the input HTML element.
+     */
     value: string;
+    /**
+     * Emits the current value of the input element when a user types.
+     */
     readonly valueChange: EventEmitter<string>;
+    /**
+     * Emits when a user triggers a message send event (this happens when they hit the `Enter` key).
+     */
     readonly send: EventEmitter<void>;
     private messageInput;
     private subscriptions;

package/lib/message-list/message-list.component.d.ts

@@ -7,24 +7,42 @@ import { GroupStyle } from './group-styles';
 import { ImageLoadService } from './image-load.service';
 import { UserResponse } from 'stream-chat';
 import * as i0 from "@angular/core";
+/**
+ * The `MessageList` component renders a scrollable list of messages.
+ */
 export declare class MessageListComponent implements AfterViewChecked, OnChanges, OnInit, OnDestroy {
     private channelService;
     private chatClientService;
     private imageLoadService;
+    /**
+     * By default, the [default message component](./MessageComponent.mdx) is used. To change the contents of the message, provide [your own custom message template](./MessageComponent.mdx/#customization).
+     */
     messageTemplate: TemplateRef<any> | undefined;
+    /**
+     * The input used for message edit. By default, the [default message input component](./MessageInputComponent.mdx) is used. To change the input for message edit, provide [your own custom template](./MessageInputComponent.mdx/#customization).
+     */
     messageInputTemplate: TemplateRef<any> | undefined;
+    /**
+     * The template used to display a mention in a message. It receives the mentioned user in a variable called `user` with the type [`UserResponse`](https://github.com/GetStream/stream-chat-js/blob/master/src/types.ts). You can provide your own template if you want to [add actions to mentions](../code-examples/mention-actions.mdx).
+     */
     mentionTemplate: TemplateRef<any> | undefined;
+    /**
+     * You can provide your own typing indicator template instead of the default one.
+     */
     typingIndicatorTemplate: TemplateRef<{
         usersTyping$: Observable<UserResponse<DefaultUserType>[]>;
     }> | undefined;
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#caution-arereactionsenabled-deprecated
+     * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead. If true, the message reactions are displayed. Users can also react to messages if they have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript).
      */
     areReactionsEnabled: boolean | undefined;
     /**
-     * @deprecated https://getstream.io/chat/docs/sdk/angular/components/message_list/#caution-enabledmessageactions-deprecated
+     * @deprecated use [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) instead. The list of [actions that are enabled](./MessageActionsBoxComponent.mdx), please note that the user also has to have the necessary [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) for actions to work. Unathorized actions won't be displayed on the UI. The `MessgaeList` component makes the necessary checks before passing the actions to the `Message` component.
      */
     enabledMessageActionsInput: string[] | undefined;
+    /**
+     * Determines if the message list should display channel messages or [thread messages](https://getstream.io/chat/docs/javascript/threads/?language=javascript).
+     */
     mode: 'main' | 'thread';
     messages$: Observable<StreamMessage[]>;
     canReactToMessage: boolean | undefined;

package/lib/message-reactions/message-reactions.component.d.ts

@@ -4,17 +4,38 @@ import { ChannelService } from '../channel.service';
 import { DefaultReactionType, DefaultUserType } from '../types';
 import * as i0 from "@angular/core";
 export declare type MessageReactionType = 'angry' | 'haha' | 'like' | 'love' | 'sad' | 'wow';
+/**
+ * The `MessageReactions` component displays the reactions of a message, the current user can add and remove reactions. You can read more about [message reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript) in the platform documentation.
+ */
 export declare class MessageReactionsComponent implements AfterViewChecked, OnChanges {
     private cdRef;
     private channelService;
+    /**
+     * The id of the message the reactions belong to
+     */
     messageId: string | undefined;
+    /**
+     * The number of reactions grouped by [reaction types](https://github.com/GetStream/stream-chat-angular/tree/master/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts)
+     */
     messageReactionCounts: {
         [key in MessageReactionType]?: number;
     };
+    /**
+     * Indicates if the selector should be opened or closed. Adding a UI element to open and close the selector is the parent's component responsibility.
+     */
     isSelectorOpen: boolean;
-    readonly isSelectorOpenChange: EventEmitter<boolean>;
+    /**
+     * List of reactions of a [message](../types/stream-message.mdx), used to display the users of a reaction type.
+     */
     latestReactions: ReactionResponse<DefaultReactionType, DefaultUserType>[];
+    /**
+     * List of the user's own reactions of a [message](../types/stream-message.mdx), used to display the users of a reaction type.
+     */
     ownReactions: ReactionResponse<DefaultReactionType, DefaultUserType>[];
+    /**
+     * Indicates if the selector should be opened or closed. Adding a UI element to open and close the selector is the parent's component responsibility.
+     */
+    readonly isSelectorOpenChange: EventEmitter<boolean>;
     tooltipPositions: {
         arrow: number;
         tooltip: number;

package/lib/modal/modal.component.d.ts

@@ -1,7 +1,16 @@
 import { EventEmitter, OnChanges, SimpleChanges } from '@angular/core';
 import * as i0 from "@angular/core";
+/**
+ * The `Modal` component displays its content in an overlay. The modal can be closed with a close button, if the user clicks outside of the modal content, or if the escape button is pressed. The modal can also be closed from outside.
+ */
 export declare class ModalComponent implements OnChanges {
+    /**
+     * If `true` the modal will be displayed, if `false` the modal will be hidden
+     */
     isOpen: boolean;
+    /**
+     * Emits `true` if the modal becomes visible, and `false` if the modal is closed.
+     */
     readonly isOpenChange: EventEmitter<boolean>;
     private content;
     constructor();

package/lib/notification/notification.component.d.ts

@@ -1,6 +1,12 @@
 import { NotificationType } from '../notification.service';
 import * as i0 from "@angular/core";
+/**
+ * The `Notification` component displays a notification within the [`NotificationList`](./NotificationListComponent.mdx)
+ */
 export declare class NotificationComponent {
+    /**
+     * The type of the notification
+     */
     type: NotificationType | undefined;
     constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<NotificationComponent, never>;

package/lib/notification-list/notification-list.component.d.ts

@@ -1,6 +1,9 @@
 import { Observable } from 'rxjs';
 import { NotificationPayload, NotificationService } from '../notification.service';
 import * as i0 from "@angular/core";
+/**
+ * The `NotificationList` component displays the list of active notifications.
+ */
 export declare class NotificationListComponent {
     private notificationService;
     notifications$: Observable<NotificationPayload[]>;

package/lib/notification.service.d.ts

@@ -7,7 +7,7 @@ export declare type NotificationPayload = {
     translateParams?: Object;
 };
 /**
- * The `NotificationService` can be used to add or remove notifications. By default the [`NotificationList`](../components/notifications.mdx) component displays the currently active notifications.
+ * The `NotificationService` can be used to add or remove notifications. By default the [`NotificationList`](../components/NotificationListComponent.mdx) component displays the currently active notifications.
  */
 export declare class NotificationService {
     /**

package/lib/thread/thread.component.d.ts

@@ -2,6 +2,9 @@ import { OnDestroy } from '@angular/core';
 import { ChannelService } from '../channel.service';
 import { StreamMessage } from '../types';
 import * as i0 from "@angular/core";
+/**
+ * The `Thread` component represents a [message thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript), it is a container component that displays a thread with a header, [`MessageList`](./MessageListComponent.mdx) and [`MessageInput`](./MessageInputComponent.mdx) components.
+ */
 export declare class ThreadComponent implements OnDestroy {
     private channelService;
     private class;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-chat-angular",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "description": "Angular components to create chat conversations or livestream style chat",
   "author": "GetStream",
   "homepage": "https://getstream.io/chat/",

package/src/assets/version.ts

@@ -1 +1 @@
-export const version = '2.14.0';
+export const version = '2.15.0';