CometChat UI Kit for Angular

May 8, 2026 · View on GitHub

CometChat

CometChat UI Kit for Angular

The CometChat Angular UI Kit provides a pre-built user interface kit that developers can use to quickly integrate a reliable & fully-featured chat experience into an existing or a new Angular app.

Prerequisites

  • Node.js >= 18
  • npm >= 10
  • Angular >= 17 (up to Angular 21)
  • Sign up for a CometChat account to get your app credentials: App ID, Region, and Auth Key

Repository Structure

This is a monorepo containing the UI Kit library, a sample application, a Storybook playground, and a documentation site.

├── projects/
│   ├── cometchat-uikit/     # UI Kit library (@cometchat/chat-uikit-angular)
│   └── sample-app/          # Sample Angular app demonstrating the UI Kit
├── .storybook/              # Storybook configuration & stories
└── docs/                    # Documentation site (Mintlify)

Getting Started

  1. Clone the repository:

    git clone https://github.com/cometchat/cometchat-uikit-angular.git

  2. Checkout the v5 branch:

    git checkout v5

  3. Install dependencies:

    npm install

  4. Enter your CometChat App ID, Region, and Auth Key in projects/sample-app/src/main.ts.

  5. Run the sample app:

    npm start

UI Kit Library

The core library lives in projects/cometchat-uikit/ and is published as @cometchat/chat-uikit-angular.

Build the library:

npm run build:lib

Refer to the Integration Steps to integrate the UI Kit into your own Angular app.

Sample App

The sample app in projects/sample-app/ showcases the full capabilities of the UI Kit — real-time messaging, voice & video calling, conversations, users, groups, and more.

Run the sample app:

npm start

Storybook

Storybook provides an interactive playground to explore and test individual UI Kit components in isolation.

Run Storybook locally:

npm run storybook

Build a static Storybook site:

npm run build-storybook

Documentation

The docs/ directory contains the full documentation site built with Mintlify, covering component APIs, customization guides, theming, localization, and more.

Run the docs site locally:

cd docs
npm install
npm run dev

Help and Support

For issues running the project or integrating with our UI Kits, consult our documentation or create a support ticket or seek real-time support via the CometChat Dashboard.