Skip to main content

CustomTemplatesService

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, specifically the AppComponent (see README for instructions on how to start the application).

Properties

attachmentActionsTemplate$

attachmentActionsTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how attachment actions are displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:274


attachmentListTemplate$

attachmentListTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentListContext>>

The template used to display attachments of a message (instead of the default attachment list)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:118


attachmentPreviewListTemplate$

attachmentPreviewListTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentPreviewListContext>>

The template used to display attachments in the message input component (instead of the default attachment preview)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:126


avatarTemplate$

avatarTemplate$: BehaviorSubject<undefined | TemplateRef<AvatarContext>>

The template used to display avatars for channels and users (instead of the default avatar)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:134


cardAttachmentTemplate$

cardAttachmentTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how a card attachment is displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:268


channelActionsTemplate$

channelActionsTemplate$: BehaviorSubject<undefined | TemplateRef<ChannelActionsContext<DefaultStreamChatGenerics>>>

The template for channel actions displayed in the channel header (by default no channel action is displayed)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:110


channelHeaderInfoTemplate$

channelHeaderInfoTemplate$: BehaviorSubject<undefined | TemplateRef<ChannelHeaderInfoContext<DefaultStreamChatGenerics>>>

The template used to display additional information about a channel under the channel name inside the channel header component

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:230


channelPreviewTemplate$

channelPreviewTemplate$: BehaviorSubject<undefined | TemplateRef<ChannelPreviewContext<DefaultStreamChatGenerics>>>

Template used to display an item in the channel list (instead of the default channal list item)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:62


commandAutocompleteItemTemplate$

commandAutocompleteItemTemplate$: BehaviorSubject<undefined | TemplateRef<CommandAutocompleteListItemContext>>

The autocomplete list item template for commands (used in the AutocompleteTextareaComponent)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:54


customAttachmentUploadTemplate$

customAttachmentUploadTemplate$: BehaviorSubject<undefined | TemplateRef<CustomAttachmentUploadContext>>

The template used for displaying file upload/attachment selector inside the message input

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:238


dateSeparatorTemplate$

dateSeparatorTemplate$: BehaviorSubject<undefined | TemplateRef<DateSeparatorContext>>

The template used to display the date separator inside the message list

Defined in

lib/custom-templates.service.ts:286


deliveredStatusTemplate$

deliveredStatusTemplate$: BehaviorSubject<undefined | TemplateRef<DeliveredStatusContext>>

The template used for displaying the delivered state of the message inside the message component

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:206


emojiPickerTemplate$

emojiPickerTemplate$: BehaviorSubject<undefined | TemplateRef<EmojiPickerContext>>

The template for emoji picker

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:86


emptyMainMessageListPlaceholder$

emptyMainMessageListPlaceholder$: BehaviorSubject<undefined | TemplateRef<void>>

The template to show if the main message list is empty

Defined in

lib/custom-templates.service.ts:298


emptyThreadMessageListPlaceholder$

emptyThreadMessageListPlaceholder$: BehaviorSubject<undefined | TemplateRef<void>>

The template to show if the thread message list is empty

Defined in

lib/custom-templates.service.ts:304


fileAttachmentTemplate$

fileAttachmentTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how a file attachment is displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:262


galleryAttachmentTemplate$

galleryAttachmentTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how image gallery is displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:256


iconTemplate$

iconTemplate$: BehaviorSubject<undefined | TemplateRef<IconContext>>

Template for displaying icons (instead of the default icon component)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:142


imageAttachmentTemplate$

imageAttachmentTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how a single image attachment is displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:244


loadingIndicatorTemplate$

loadingIndicatorTemplate$: BehaviorSubject<undefined | TemplateRef<LoadingIndicatorContext>>

Template for displaying the loading indicator (instead of the default loading indicator)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:150


mentionAutocompleteItemTemplate$

mentionAutocompleteItemTemplate$: BehaviorSubject<undefined | TemplateRef<MentionAutcompleteListItemContext>>

The autocomplete list item template for mentioning users (used in the AutocompleteTextareaComponent)

Defined in

lib/custom-templates.service.ts:46


mentionTemplate$

mentionTemplate$: BehaviorSubject<undefined | TemplateRef<MentionTemplateContext>>

The template used for displaying a mention inside a message

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:78


messageActionsBoxItemTemplate$

messageActionsBoxItemTemplate$: BehaviorSubject<undefined | TemplateRef<MessageActionBoxItemContext<DefaultStreamChatGenerics>>>

The template used for displaying an item in the message actions box

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:166


messageActionsBoxTemplate$

messageActionsBoxTemplate$: BehaviorSubject<undefined | TemplateRef<MessageActionsBoxContext>>

Template for displaying the message actions box (instead of the default message actions box)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:158


messageInputTemplate$

messageInputTemplate$: BehaviorSubject<undefined | TemplateRef<MessageInputContext>>

The message input template used when editing a message (instead of the default message input)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:70


messageReactionsTemplate$

messageReactionsTemplate$: BehaviorSubject<undefined | TemplateRef<MessageReactionsContext>>

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)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:174


messageTemplate$

messageTemplate$: BehaviorSubject<undefined | TemplateRef<MessageContext>>

The template used to display a message in the message list (instead of the default message component)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:102


modalTemplate$

modalTemplate$: BehaviorSubject<undefined | TemplateRef<ModalContext>>

The template used to display a modal window (instead of the default modal)

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:182


newMessagesIndicatorTemplate$

newMessagesIndicatorTemplate$: BehaviorSubject<undefined | TemplateRef<void>>

The template used to display the new messages indicator inside the message list

Defined in

lib/custom-templates.service.ts:292


notificationTemplate$

notificationTemplate$: BehaviorSubject<undefined | TemplateRef<NotificationContext>>

The template used to override the default notification component

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:190


readStatusTemplate$

readStatusTemplate$: BehaviorSubject<undefined | TemplateRef<ReadStatusContext>>

The template used for displaying the sent state of the message inside the message component

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:222


sendingStatusTemplate$

sendingStatusTemplate$: BehaviorSubject<undefined | TemplateRef<SendingStatusContext>>

The template used for displaying the sending state of the message inside the message component

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:214


systemMessageTemplate$

systemMessageTemplate$: BehaviorSubject<undefined | TemplateRef<SystemMessageContext>>

The template used to display system messages indise the message component

Defined in

lib/custom-templates.service.ts:280


threadHeaderTemplate$

threadHeaderTemplate$: BehaviorSubject<undefined | TemplateRef<ThreadHeaderContext>>

The template used for header of a thread

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:198


typingIndicatorTemplate$

typingIndicatorTemplate$: BehaviorSubject<undefined | TemplateRef<TypingIndicatorContext>>

The typing indicator template used in the message list

For code examples to the different customizations see our customizations example application, specifically the AppComponent (see README for instructions on how to start the application).

Defined in

lib/custom-templates.service.ts:94


videoAttachmentTemplate$

videoAttachmentTemplate$: BehaviorSubject<undefined | TemplateRef<AttachmentContext>>

The template that can be used to override how a video attachment is displayed inside the attachment list

Defined in

lib/custom-templates.service.ts:250

Did you find this page helpful?