stream-chat-angular 3.0.0-beta.3 → 3.0.0-beta.4

package/assets/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.0.0-beta.3";
+export declare const version = "3.0.0-beta.4";

package/bundles/stream-chat-angular.umd.js

@@ -354,7 +354,7 @@
         return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
     }
 
-    var version = '3.0.0-beta.3';
+    var version = '3.0.0-beta.4';
 
     /**
      * The `NotificationService` can be used to add or remove notifications. By default the [`NotificationList`](../components/NotificationListComponent.mdx) component displays the currently active notifications.
@@ -2214,88 +2214,128 @@
                 }] } });
 
     /**
-     * A central location for registering your custom templates to override parts of the chat application
+     * A central location for registering your custom templates to override parts of the chat application.
+     *
+     * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
      */
     var CustomTemplatesService = /** @class */ (function () {
         function CustomTemplatesService() {
             /**
-             * The autocomplete list item template for mentioning users
+             * The autocomplete list item template for mentioning users (used in the [`AutocompleteTextareaComponent`](../components/AutocompleteTextareaComponent.mdx))
              */
             this.mentionAutocompleteItemTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The autocomplete list item template for commands
+             * The autocomplete list item template for commands (used in the [`AutocompleteTextareaComponent`](../components/AutocompleteTextareaComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.commandAutocompleteItemTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * Item in the channel list
+             * Template used to display an item in the [channel list](../components/ChannelListComponent.mdx) (instead of the default [channal list item](../components/ChannelPreviewComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.channelPreviewTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The message input template used when editing a message
+             * The message input template used when editing a message (instead of the [default message input](../components/MessageInputComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.messageInputTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used for displaying a mention inside a message
+             * The template used for displaying a [mention inside a message](../code-examples/mention-actions.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.mentionTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template for emoji picker
+             * The template for [emoji picker](../code-examples/emoji-picker.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.emojiPickerTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The typing indicator template used in the message list
+             * The typing indicator template used in the [message list](../components/MessageListComponent.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.typingIndicatorTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used to display a message in the message list
+             * The template used to display a message in the [message list](../components/MessageListComponent.mdx) (instead of the [default message component](../components/MessageComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.messageTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template for channel actions
+             * The template for channel actions displayed in the [channel header](../components/ChannelHeaderComponent.mdx) (by default no channel action is displayed)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.channelActionsTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used to display attachments of a message
+             * The template used to display attachments of a [message](../components/MessageComponent.mdx) (instead of the [default attachment list](../components/AttachmentListComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.attachmentListTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used to display attachments in the message input component
+             * The template used to display attachments in the [message input](../components/MessageInputComponent.mdx) component (instead of the [default attachment preview](../components/AttachmentPreviewListComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.attachmentPreviewListTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used to display avatars for channels and users
+             * The template used to display avatars for channels and users (instead of the [default avatar](../components/AvatarComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.avatarTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * Template for displaying icons
+             * Template for displaying icons (instead of the [default icon component](../components/IconComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.iconTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
              * Template for displaying the loading indicator (instead of the [default loading indicator](../components/LoadingIndicatorComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.loadingIndicatorTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
              * Template for displaying the message actions box (instead of the [default message actions box](../components/MessageActionsBoxComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.messageActionsBoxTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used for displaying an item in the [message actions box](../components/MessageActionsBoxComponent.mdx)]
+             * The template used for displaying an item in the [message actions box](../components/MessageActionsBoxComponent.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.messageActionsBoxItemTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used to display the reactions of a message, and the selector to add a reaction to a message (instead of the [default message reactions component](../components/MessageReactionsComponent.mdx))
+             * The template used to display the reactions of a [message](../components/MessageComponent.mdx), and the selector to add a reaction to a message (instead of the [default message reactions component](../components/MessageReactionsComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.messageReactionsTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
              * The template used to display a modal window (instead of the [default modal](../components/ModalComponent.mdx))
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.modalTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
              * The template used to override the [default notification component](../components/NotificationComponent.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.notificationTemplate$ = new rxjs.BehaviorSubject(undefined);
             /**
-             * The template used for header of thread
+             * The template used for header of a [thread](../components/ThreadComponent.mdx)
+             *
+             * For code examples to the different customizations see our [customizations example application](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example), specifically the [AppComponent](https://github.com/GetStream/stream-chat-angular/tree/master/projects/customizations-example/src/app) (see [README](https://github.com/GetStream/stream-chat-angular/blob/master/README.md#customization-examples) for instructions on how to start the application).
              */
             this.threadHeaderTemplate$ = new rxjs.BehaviorSubject(undefined);
         }