Angular Chat App Tutorial

The easiest way to build a Stream Chat Angular application from this tutorial is to create a new project using Angular CLI. Angular CLI builds an Angular boilerplate application that you can run locally with just a few simple commands.

Before you start: Make sure you've installed the most recent version of Angular CLI globally.

Create a new application with Angular CLI:

Note You can use other style language if you wish.

Install the necessary dependencies:

Run the following command if you are using Angular 16 or Angular 15:

Run the following command if you are using Angular 14:

Run the following command if you are using Angular 13:

Run this command if you are using Angular 12:

Stream's Angular Chat messaging SDK component library includes everything you need to build a fully functioning chat experience, supporting rich messages, reactions, image uploads, and more. This library was designed to enable you to get an application up and running quickly and efficiently while supporting customization for complex use cases.

We’ve included a few Stream Angular Chat examples to show you what’s possible:

• Basic chat components cxample
• Customizable UI components example

In the sample below, you’ll find the following basic chat components of the Angular library:

• ChannelList
• Channel
• ChannelHeader
• MessageInput
• MessageList
• Thread

To get started:

1. Import the modules

Replace the content of your AppModule with the following code:

This will import the TranslateModule and the StreamChatModule.

If you already use ngx-translate in your application, follow our translation guide to set up translation.

In an effort to keep our bundle size small in the long run our SDK uses an architecture where integrators can decide to opt-out of certain costly (in terms of bundle size) features, this decision happens at module import, in the above example we chose what type of textarea component we want to use. You can find more information about this topic in our opt-in architecture guide.

1. Init the chat application

Replace the content of your app.component.ts with the following code:

First, we connect a user to the chat client. Further information about connecting users is available in our platform documentation.

Next, we create a channel (if doesn't exist) to test with. You can read more about channel creation in our platform documentation.

Lastly, we provide a filter condition for loading channels. If you want to know more about filtering channels, our platform documentation got you covered.

We also set up the translation for the application. If you want to customize it, check out our translation guide.

1. Create the chat UI

Replace the content of the app.component.html with the following code:

1. Import CSS

Add the following code to your root stylesheet (styles.scss if you are using SCSS):

Important note If you are using CSS stylesheets, you should add the following import instead:

The SDK lets you create your own responsive layout, the code above contains a minimal setup where the channel list is displayed next to the channel component.

1. Modify tsconfig.json

Add the following option to the compilerOptions in tsconfig.json file:

We need to enable synthetic default imports becuase the stream-chat library uses them.

1. Start the application

Run the following command:

Once you have the app running, you’ll notice the following out-of-the-box features:

• User online presence
• Message status indicators (sending, received)
• User role configuration
• Message read indicators
• Message reactions
• URL previews (send a link to see it in action, for example, https://getstream.io/)
• GIFs (type /giphy in the message input)
• Threads
• File uploads and previews
• AI-powered spam and profanity moderation

Creating Your Own UI Components

If the built-in theming capabilities are not enough for you, you can create your own custom components.

In the below example, you’ll create custom ChannelPreview and Message components.

1. Create the Message component

Run the following command:

1. Implement the Message component

Replace the content of the message.component.ts with the following code:

1. Use the custom message component

Provide the customMessageTemplate to the CustomTemplatesService:

In the HTML of your AppComponent:

In the component class of your AppComponent

1. Create the ChannelPreview component

Run the following command:

1. Implement the ChannelPreview component

Replace the content of the channel-preview.component.ts with the following code:

1. Use the custom channel preview component

Provide the customChannelPreviewtemplate to the CustomTemplatesService:

In the HTML of your AppComponent

In the component class of your AppComponent

References

To learn more about the Angular SDK, check our SDK documentation and guides:

• Our documentation
• Customization guide
• Custom fields with generics
• Themeing guide