mediasfu-angular 2.2.1 → 2.2.3

package/README.md

@@ -1,3 +1,9 @@
+# MediaSFU Angular SDK · [mediasfu-angular on npm](https://www.npmjs.com/package/mediasfu-angular)
+
+**mediasfu-angular** is the Angular 17/18/19 WebRTC SDK for video conferencing, webinars, live streaming, broadcast, screen sharing, whiteboard, chat, recording, live subtitles, translation, and AI agent rooms — powered by MediaSFU Cloud or your self-hosted MediaSFU Open server. Install with `npm install mediasfu-angular`.
+
+---
+
 <p align="center">
   <img src="https://www.mediasfu.com/logo192.png" width="100" alt="MediaSFU Logo">
 </p>
@@ -37,50 +43,123 @@
 
 ---
 
-## 🚨 **BREAKING: AI Phone Agents at $0.10 per 1,000 minutes**
+# MediaSFU Angular SDK
 
-📞 **Call our live AI demos right now:**
-- 🇺🇸 **+1 (785) 369-1724** - Mixed Support Demo  
-- 🇬🇧 **+44 7445 146575** - AI Conversation Demo  
-- 🇨🇦 **+1 (587) 407-1990** - Technical Support Demo  
-- 🇨🇦 **+1 (647) 558-6650** - Friendly AI Chat Demo  
+**Prebuilt Angular SDK for WebRTC video conferencing, webinars, livestreams, chat, screen sharing, recording, breakout rooms, whiteboards, polls, live subtitles, and translation.**
 
-**Traditional providers charge $0.05 per minute. We charge $0.10 per 1,000 minutes. That's 500x cheaper.**
+MediaSFU Angular is an Angular video conferencing SDK with prebuilt room components for meetings, webinars, livestream-style broadcasts, and chat-first rooms. It gives you production-ready room UI plus the lower-level helpers needed to move from a full prebuilt experience to a deeply customized Angular app without rewriting the media stack.
 
-✅ **Deploy AI phone agents in 30 minutes**  
-✅ **Works with ANY SIP provider** (Twilio, Telnyx, Zadarma, etc.)  
-✅ **Seamless AI-to-human handoffs**  
-✅ **Real-time call analytics & transcription**  
+## Quick Start: First Working Room
 
-📖 **[Complete SIP/PSTN Documentation →](https://mediasfu.com/telephony)**
+```bash
+npm install mediasfu-angular
+```
 
----
+```typescript
+credentials = {
+  apiUserName: 'your-user',
+  apiKey: 'your-key',
+};
+```
 
-MediaSFU offers a cutting-edge streaming experience that empowers users to customize their recordings and engage their audience with high-quality streams. Whether you're a content creator, educator, or business professional, MediaSFU provides the tools you need to elevate your streaming game.
+```html
+<app-mediasfu-generic
+  [credentials]="credentials"
+  [connectMediaSFU]="true"
+></app-mediasfu-generic>
+```
 
-<div style="text-align: center;">
+That is the fastest path to a working Angular video conferencing room. Once the secure create/join path works, layer in branding, overrides, or a fully custom shell.
 
-<img src="https://mediasfu.com/images/header_1.jpg" alt="Preview Page" title="Preview Page" style="max-height: 600px;">
+## Pick the Right Angular Room Component
 
-</div>
+Use this table to match each Angular room component to the product shape you are building.
 
----
+| Component | Best for | What users get | When to choose it |
+| --- | --- | --- | --- |
+| `app-mediasfu-generic` | General meetings, team calls, product defaults | Balanced room layout with the broadest starter path | Start here if you are unsure which room type fits best. |
+| `app-mediasfu-webinar` | Host-led presentations, audience participation, stage-centric events | Webinar-style room flow with participant management and moderation surfaces | Choose this when one or a few presenters lead a larger audience. |
+| `app-mediasfu-broadcast` | Livestream-style shows, creator dashboards, host-first production flows | Broadcast-oriented shell with invite/share and host control emphasis | Choose this when the host workflow matters more than equal participant presence. |
+| `app-mediasfu-chat` | Text-first support rooms, low-bandwidth collaboration, chat-centric experiences | Message-forward room UI with the same create/join/runtime foundation | Choose this when conversation is the product and audio/video are secondary. |
+| `app-mediasfu-conference` | Collaborative multi-speaker events, panels, classes, workshops | Multi-participant conference layout with richer shared-presence expectations | Choose this when many participants are expected to be visibly active. |
+
+## Least Confusing Start Path
+
+1. Start with `app-mediasfu-generic` and validate one successful create/join flow.
+2. Decide backend mode early: MediaSFU Cloud or self-hosted MediaSFU Open.
+3. Move to `app-mediasfu-webinar`, `app-mediasfu-broadcast`, or `app-mediasfu-chat` only after the base room flow is working.
+4. Use `uiOverrides`, custom cards, and `customMainComponent` before going fully headless.
+5. Switch to `returnUI="false"` only when you already know which MediaSFU runtime helpers your product needs.
+
+## Common Angular Product Shapes
+
+Use MediaSFU Angular when you need one of these product patterns:
+
+- Angular video meeting UI with secure create/join flow.
+- Angular webinar UI with host, audience, and moderation surfaces.
+- Angular broadcast UI for livestream or creator-style host workflows.
+- Angular chat room UI with MediaSFU room orchestration behind it.
+- Angular collaboration rooms with recording, screen share, whiteboard, polls, captions, and translation in one SDK.
+
+## Why teams use MediaSFU Angular
 
-# MediaSFU Angular Module Documentation
+- **Start fast** with prebuilt room components such as `MediasfuGeneric`, `MediasfuConference`, `MediasfuWebinar`, `MediasfuBroadcast`, and `MediasfuChat`.
+- **Customize progressively** with `uiOverrides`, custom cards, custom layouts, and shared room helper state.
+- **Go headless when needed** by setting `returnUI="false"` and wiring MediaSFU runtime helpers into your own Angular workspace.
+- **Ship collaboration features together**: voice, video, screen share, recording, whiteboard, breakout rooms, chat, polls, and translation in one SDK.
 
-## Unlock the Power of MediaSFU Community Edition  
+## Choose Your Path
 
-**MediaSFU Community Edition is free and open-source**—perfect for developers who want to run their own media server without upfront costs. With robust features and simple setup, you can launch your media solution in minutes. **Ready to scale?** Upgrade seamlessly to **MediaSFU Cloud** for enterprise-grade performance and global scalability.  
+- **Beginner**: install the package, render a prebuilt room, and connect to MediaSFU Cloud or your self-hosted server.
+- **Intermediate**: override cards, modals, and layout surfaces while keeping MediaSFU's room orchestration and transports.
+- **Advanced**: run the runtime headless, consume `sourceParameters`, and build a fully custom Angular UI on top of the same media/session core.
 
-**[Get started now on GitHub!](https://github.com/MediaSFU/MediaSFUOpen)** 
+## Important: Backend Required
 
-### ✅ Angular SDK Setup Guide  
-Coming soon! Watch this space for our comprehensive video tutorial on setting up the Angular SDK.
+MediaSFU Angular is a frontend SDK. You still need a MediaSFU-compatible backend for signaling, media routing, and room lifecycle.
+
+| Option | Best for | Link |
+| --- | --- | --- |
+| **MediaSFU Cloud** | Managed production deployments, faster onboarding, less infrastructure work | [MediaSFU Cloud docs](https://www.mediasfu.com/documentation#rooms) |
+| **MediaSFU Open** | Self-hosting, local control, private infrastructure | [MediaSFU Open](https://github.com/MediaSFU/MediaSFUOpen) |
+
+## Start Here
+
+- Want the fastest path to a running room? Jump to [Quick Start](#quick-start-5-minutes).
+- Want copy-paste recipes for different integration levels? Use the [Usage Cookbook](#usage-cookbook) section just below.
+- Want to understand the Angular surface area first? Read [Quick Reference: Component Props & UI Overrides](#quick-reference-component-props--ui-overrides).
+- Want architecture and customization depth? Continue with the [Angular SDK Guide](#angular-sdk-guide).
+- Want self-hosted deployment context? Review [MediaSFU Open](https://github.com/MediaSFU/MediaSFUOpen) alongside this SDK guide.
+
+## Usage Cookbook
+
+Need recipe-style Angular guidance instead of reading the full guide front to back? Use this quick picker:
+
+| Goal | Recommended setup |
+| --- | --- |
+| Ship the bundled room fast | Render `app-mediasfu-generic` with `credentials` and `connectMediaSFU="true"`. |
+| Use MediaSFU Open | Keep the same component and pass `localLink` to your self-hosted server. |
+| Run the runtime headless | Set `returnUI="false"`, pass `noUIPreJoinOptions`, and capture helpers through `updateSourceParameters`. |
+| Replace the main room shell | Keep MediaSFU's transports and room lifecycle, but pass `customMainComponent`. |
+| Override selected surfaces | Keep the default shell and layer `uiOverrides`, `customVideoCard`, `customAudioCard`, `customMiniCard`, and `containerStyle`. |
+
+Source-repo readers can also use the standalone `USAGE_COOKBOOK.md` file for copy-paste examples.
 
 ---
 
-## Table of Contents
+# Angular SDK Guide
+
+MediaSFU Community Edition remains available if you want to self-host the backend and keep full infrastructure control. If you want managed infrastructure, use MediaSFU Cloud with the same Angular SDK surface.
+
+---
 
+## Table of Contents
+- [Why teams use MediaSFU Angular](#why-teams-use-mediasfu-angular)
+- [Choose Your Path](#choose-your-path)
+- [Important: Backend Required](#important-backend-required)
+- [Start Here](#start-here)
+- [Usage Cookbook](#usage-cookbook)
+- [Quick Reference: Component Props & UI Overrides](#quick-reference-component-props--ui-overrides)
 - [Features](#features)
 - [Getting Started](#getting-started)
 - [📘 Angular SDK Guide](#angular-sdk-guide)
@@ -94,6 +173,341 @@ Coming soon! Watch this space for our comprehensive video tutorial on setting up
 - [Troubleshooting](#troubleshooting)
 - [Contributing](#contributing)
 
+
+---
+
+## Quick Reference: Component Props & UI Overrides
+
+> **New:** UI override parity now extends across Webinar and Chat layouts, unifying customization for every MediaSFU interface.
+
+Every primary MediaSFU UI export—`MediasfuGeneric`, `MediasfuBroadcast`, `MediasfuConference`, `MediasfuWebinar`, and `MediasfuChat`—now ships with a consistent prop surface and a powerful `uiOverrides` input, so you can bend the bundled experience to match your product without losing MediaSFU's hardened real-time logic.
+
+### Shared component inputs (applies to every MediaSFU UI component)
+
+| Input | Type | Default | What it does |
+| --- | --- | --- | --- |
+| `PrejoinPage` | `ComponentType` | `WelcomePage` | Swap in a custom pre-join experience. Receives unified pre-join options so you can add branding, legal copy, or warm-up flows. |
+| `localLink` | `string` | `""` | Point the SDK at your self-hosted MediaSFU server. Leave empty when using MediaSFU Cloud. |
+| `connectMediaSFU` | `boolean` | `true` | Toggle automatic socket/WebRTC connections. Set to `false` when you only need the UI shell. |
+| `credentials` | `{ apiUserName: string; apiKey: string }` | `{ apiUserName: "", apiKey: "" }` | Supply cloud credentials without hard-coding them elsewhere. |
+| `useLocalUIMode` | `boolean` | `false` | Run the interface in local/demo mode with no remote signaling. |
+| `seedData`, `useSeed` | `SeedData`, `boolean` | `{}`, `false` | Pre-populate the UI for demos, snapshot tests, or onboarding tours. |
+| `imgSrc` | `string` | `https://mediasfu.com/images/logo192.png` | Default artwork used across pre-join and modal flows. |
+| `sourceParameters` | `Record<string, unknown>` | `{}` | Shared helper bag (media devices, participant helpers, layout handlers). Pair with `updateSourceParameters` to mirror the SDK's internal utilities. |
+| `updateSourceParameters` | `(data: Record<string, unknown>) => void` | `() => {}` | Receive the latest helper bundle so you can bridge MediaSFU logic into your own components. |
+| `returnUI` | `boolean` | `true` | When `false`, mount the logic only—a perfect stepping stone to a fully bespoke interface. |
+| `noUIPreJoinOptions` | `CreateMediaSFURoomOptions \| JoinMediaSFURoomOptions` | `undefined` | Feed pre-join data when `returnUI` is `false` and you want to bypass the on-screen wizard. |
+| `joinMediaSFURoom`, `createMediaSFURoom` | `Function` | `undefined` | Inject your own networking layers for joining or creating rooms. |
+| `canUsePersonalTranslation`, `personalTranslationUsername` | `boolean`, `string` | `false`, `undefined` | Seed translation-aware entry flows when you want personal translation defaults available at startup. |
+| `customMainComponent` | `ComponentType` | `undefined` | Replace the main UI shell while retaining MediaSFU transports, sockets, and room helpers. |
+| `customVideoCard`, `customAudioCard`, `customMiniCard` | `ComponentType` | `undefined` | Override participant card renders to add metadata, CTAs, or badges. |
+| `[containerStyle]` | `Record<string, any>` | `undefined` | Apply inline styles to the root wrapper (dashboards, split views, etc.). |
+| `[uiOverrides]` | `MediasfuUICustomOverrides` | `undefined` | Targeted component/function overrides described below. |
+
+> **Power combo:** Set `returnUI="false"` to run MediaSFU logic headless, capture helpers via `updateSourceParameters` output, and selectively bring UI pieces back with `uiOverrides`. That gives you progressive migration with minimal code churn.
+
+```typescript
+import type { MediasfuUICustomOverrides } from 'mediasfu-angular';
+
+const overrides: MediasfuUICustomOverrides = { /* ... */ };
+```
+
+Bring the types into your project to unlock full IntelliSense for every override slot.
+
+### Custom UI Playbook
+
+Use a toggle-driven "playbook" component to experiment with MediaSFU's customization layers. Flip a couple of booleans and you can watch the SDK jump between prebuilt layouts, headless logic, or a fully bespoke workspace driven by `customMainComponent`.
+
+#### What the playbook demonstrates
+
+- **Connection presets**: toggle `connectionScenario` between `cloud`, `hybrid`, or `ce` to swap credentials, local links, and connection modes in one place.
+- **Experience selector**: the `selectedExperience` switch renders `MediasfuGeneric`, `MediasfuBroadcast`, `MediasfuWebinar`, `MediasfuConference`, or `MediasfuChat` without touching the rest of your stack.
+- **UI strategy flags**: booleans like `showPrebuiltUI`, `enableFullCustomUI`, and `enableNoUIPreJoin` demonstrate how to run the MediaSFU logic with or without the bundled UI.
+- **Layered overrides**: toggles enable the custom video/audio/mini cards, drop-in `uiOverrides` for layout and modal surfaces, container styling, and backend proxy helpers.
+- **Custom workspace demo**: a `customMainComponent` receives live MediaSFU helpers so you can build dashboards, CRM surfaces, or any bespoke host interface.
+- **Debug panel & helpers**: optional JSON panel exposes the `updateSourceParameters` payload so you can see exactly what to wire into your own components.
+
+#### Try it quickly
+
+```typescript
+@Component({
+  selector: 'app-custom-ui-playbook',
+  template: `
+    <ng-container [ngSwitch]="selectedExperience">
+      <app-mediasfu-generic *ngSwitchCase="'generic'"
+        [credentials]="currentPreset.credentials"
+        [localLink]="currentPreset.localLink"
+        [connectMediaSFU]="currentPreset.connectMediaSFU"
+        [returnUI]="showPrebuiltUI"
+        [uiOverrides]="overrides"
+        [containerStyle]="containerStyle">
+      </app-mediasfu-generic>
+      
+      <app-mediasfu-broadcast *ngSwitchCase="'broadcast'"
+        [credentials]="currentPreset.credentials"
+        [localLink]="currentPreset.localLink"
+        [connectMediaSFU]="currentPreset.connectMediaSFU"
+        [returnUI]="showPrebuiltUI"
+        [uiOverrides]="overrides">
+      </app-mediasfu-broadcast>
+      
+      <!-- Similar for webinar, conference, chat -->
+    </ng-container>
+  `
+})
+export class CustomUIPlaybookComponent {
+  connectionScenario: 'cloud' | 'hybrid' | 'ce' = 'cloud';
+  selectedExperience: 'generic' | 'broadcast' | 'webinar' | 'conference' | 'chat' = 'generic';
+  showPrebuiltUI = true;
+  enableFullCustomUI = false;
+
+  connectionPresets = {
+    cloud: { 
+      credentials: { apiUserName: 'demo', apiKey: 'demo' }, 
+      localLink: '', 
+      connectMediaSFU: true 
+    },
+    hybrid: { 
+      credentials: { apiUserName: 'demo', apiKey: 'demo' }, 
+      localLink: 'http://localhost:3000', 
+      connectMediaSFU: true 
+    },
+    ce: { 
+      credentials: undefined, 
+      localLink: 'http://localhost:3000', 
+      connectMediaSFU: false 
+    },
+  };
+
+  get currentPreset() {
+    return this.connectionPresets[this.connectionScenario];
+  }
+
+  overrides: MediasfuUICustomOverrides = {
+    mainContainer: this.enableFullCustomUI ? {
+      component: CustomMainContainerComponent
+    } : undefined,
+  };
+
+  containerStyle = {
+    background: 'linear-gradient(135deg, #0f172a, #1e3a8a)',
+    minHeight: '100vh'
+  };
+}
+```
+
+Toggle the configuration values at the top of the playbook and watch the UI reconfigure instantly. It's the fastest path to understand MediaSFU's override surface before you fold the patterns into your production entrypoint.
+
+#### Passing custom props and UI overrides
+
+Use the same playbook to validate bespoke cards, override bundles, and fully custom workspaces before you move them into production code:
+
+```typescript
+@Component({
+  selector: 'app-advanced-playbook',
+  template: `
+    <app-mediasfu-generic
+      [credentials]="credentials"
+      [customVideoCard]="videoCard"
+      [customAudioCard]="audioCard"
+      [customMiniCard]="miniCard"
+      [customMainComponent]="enableFullCustomUI ? customWorkspace : undefined"
+      [containerStyle]="containerStyle"
+      [uiOverrides]="uiOverrides">
+    </app-mediasfu-generic>
+  `
+})
+export class AdvancedPlaybookComponent {
+  credentials = { apiUserName: 'demo', apiKey: 'demo' };
+  enableFullCustomUI = false;
+
+  // Custom card components with themed styling
+  videoCard = VideoCardComponent; // Pass component class
+  audioCard = AudioCardComponent;
+  miniCard = MiniCardComponent;
+  customWorkspace = CustomWorkspaceComponent;
+
+  containerStyle = {
+    background: '#0f172a',
+    borderRadius: '32px',
+    overflow: 'hidden'
+  };
+
+  uiOverrides: MediasfuUICustomOverrides = {
+    mainContainer: {
+      component: CustomMainContainerComponent
+    },
+    menuModal: {
+      component: CustomMenuModalComponent
+    },
+    consumerResume: {
+      wrap: (original) => async (params) => {
+        const startedAt = performance.now();
+        const result = await original(params);
+        console.log('consumer_resume', {
+          durationMs: performance.now() - startedAt,
+          consumerId: params?.consumer?.id,
+        });
+        return result;
+      },
+    },
+  };
+}
+```
+
+Because the playbook surfaces `updateSourceParameters`, you can also log or snapshot the helper bundle (`getParticipantMedia`, `toggleMenuModal`, `showAlert`, and more) to ensure your custom UI always receives the hooks it expects.
+
+### `uiOverrides` input — override keys at a glance
+
+Each key accepts a `CustomComponentOverride<Props>` or `CustomFunctionOverride<Fn>` object with optional `component` and `wrap` fields. You can fully replace the default implementation or wrap it while forwarding props.
+
+#### Layout & control surfaces
+
+| Key | Default component | Typical use |
+| --- | --- | --- |
+| `mainContainer` | `MainContainerComponent` | Inject theming providers or dashboard layouts. |
+| `mainAspect` | `MainAspectComponent` | Tune how the main region splits space. |
+| `mainScreen` | `MainScreenComponent` | Orchestrate hero video + gallery interplay. |
+| `mainGrid` | `MainGridComponent` | Modify layout or layering of primary participants. |
+| `subAspect` | `SubAspectComponent` | Restyle fixed control strips in webinar/conference modes. |
+| `otherGrid` | `OtherGridComponent` | Change presentation of off-stage attendees. |
+| `flexibleGrid`, `flexibleGridAlt` | `FlexibleGrid` | Implement AI-driven or branded array layouts. |
+| `flexibleVideo` | `FlexibleVideo` | Add captions, watermarks, or overlays to highlighted speakers. |
+| `audioGrid` | `AudioGrid` | Customise audio-only attendee presentation. |
+| `pagination` | `Pagination` | Introduce infinite scroll or auto-cycling carousels. |
+| `controlButtons` | `ControlButtonsComponent` | Rebrand the primary action bar. |
+| `controlButtonsAlt` | `ControlButtonsAltComponent` | Control secondary button clusters. |
+| `controlButtonsTouch` | `ControlButtonsComponentTouch` | Deliver mobile-first controls (used heavily by `MediasfuChat`). |
+
+#### Participant cards & widgets
+
+| Key | Default component | Typical use |
+| --- | --- | --- |
+| `videoCard` | `VideoCard` | Add host badges, reactions, or CRM overlays. |
+| `audioCard` | `AudioCard` | Swap avatars or expose spoken-language info. |
+| `miniCard` | `MiniCard` | Customize thumbnails in picture-in-picture modes. |
+| `miniAudio` | `MiniAudio` | Re-style the audio-only mini indicators. |
+| `meetingProgressTimer` | `MeetingProgressTimer` | Replace the elapsed-time widget with countdowns or milestones. |
+| `miniAudioPlayer` | `MiniAudioPlayer` | Provide alternative UI for recorded clip playback. |
+
+#### Modals, dialogs, and collaboration surfaces
+
+| Key | Default component | Typical use |
+| --- | --- | --- |
+| `loadingModal` | `LoadingModal` | Show branded skeletons while connecting. |
+| `alert` | `AlertComponent` | Route alerts through your notification system. |
+| `menuModal` | `MenuModal` | Redesign quick-action trays. |
+| `eventSettingsModal` | `EventSettingsModal` | Extend host tools with your own settings. |
+| `translationSettingsModal` | `TranslationSettingsModal` | Customize spoken-language, subtitle, and listening-preference controls. |
+| `requestsModal` | `RequestsModal` | Build moderation queues tailored to your workflows. |
+| `waitingRoomModal` | `WaitingRoomModal` | Deliver custom waiting-room experiences. |
+| `coHostModal` | `CoHostModal` | Manage co-hosts with bespoke UX. |
+| `mediaSettingsModal` | `MediaSettingsModal` | Embed device tests or instructions. |
+| `participantsModal` | `ParticipantsModal` | Introduce advanced filters, search, or notes. |
+| `messagesModal` | `MessagesModal` | Drop in your full-featured chat module. |
+| `displaySettingsModal` | `DisplaySettingsModal` | Let users pick layouts, themes, or captions. |
+| `confirmExitModal` | `ConfirmExitModal` | Meet compliance wording requirements. |
+| `confirmHereModal` | `ConfirmHereModal` | Customize attendance confirmations for webinars. |
+| `shareEventModal` | `ShareEventModal` | Add referral codes or QR sharing. |
+| `recordingModal` | `RecordingModal` | Tailor recording confirmation flows. |
+| `pollModal` | `PollModal` | Integrate your polling/quiz engine. |
+| `backgroundModal` | `BackgroundModal` | Hook AI background replacement or brand presets. |
+| `breakoutRoomsModal` | `BreakoutRoomsModal` | Implement drag-and-drop or AI room suggestions. |
+| `configureWhiteboardModal` | `ConfigureWhiteboardModal` | Adjust collaboration permissions before launch. |
+| `whiteboard` | `Whiteboard` | Replace with your whiteboard provider. |
+| `screenboard` | `Screenboard` | Modify shared-screen annotation layers. |
+| `screenboardModal` | `ScreenboardModal` | Reimagine how users enable shared annotations. |
+
+#### Entry flows & custom renderers
+
+| Key | Default component | Typical use |
+| --- | --- | --- |
+| `welcomePage` | `WelcomePage` | Provide a fully branded welcome/marketing splash. |
+| `preJoinPage` | `PreJoinPage` | Override the wizard used before joining live sessions. |
+| `customMenuButtonsRenderer` | `Menu button group renderer` | Supply a bespoke renderer for grouped menu actions without overriding each button one by one. |
+
+#### Function overrides
+
+| Key | Default function | Typical use |
+| --- | --- | --- |
+| `consumerResume` | `consumerResume` | Wrap errors, capture analytics, or rate-limit consumer resume behavior. |
+| `addVideosGrid` | `addVideosGrid` | Replace participant ordering or layout heuristics on the fly. |
+| `prepopulateUserMedia` | `prepopulateUserMedia` | Customize initial media setup with custom video/audio/mini cards. |
+
+> Function overrides support `{ implementation, wrap }`. Provide `implementation` for a full replacement, or `wrap` to intercept the default behavior before/after it runs.
+
+### Example: swap the chat modal and theme the controls
+
+```typescript
+import { Component } from '@angular/core';
+import { MediasfuGeneric } from 'mediasfu-angular';
+import { MyChatModalComponent } from './ui/my-chat-modal.component';
+import { MyControlsComponent } from './ui/my-controls.component';
+
+@Component({
+  selector: 'app-my-meeting',
+  template: `
+    <app-mediasfu-generic
+      [credentials]="credentials"
+      [uiOverrides]="uiOverrides">
+    </app-mediasfu-generic>
+  `
+})
+export class MyMeetingComponent {
+  credentials = { apiUserName: 'your-api-user', apiKey: 'your-api-key' };
+
+  uiOverrides = {
+    messagesModal: {
+      component: MyChatModalComponent,
+    },
+    controlButtons: {
+      component: MyControlsComponent,
+    },
+  };
+}
+```
+
+### Example: wrap a MediaSFU helper instead of replacing it
+
+```typescript
+import { Component } from '@angular/core';
+import { MediasfuConference } from 'mediasfu-angular';
+
+@Component({
+  selector: 'app-analytics-meeting',
+  template: `
+    <app-mediasfu-conference
+      [credentials]="credentials"
+      [uiOverrides]="uiOverrides">
+    </app-mediasfu-conference>
+  `
+})
+export class AnalyticsMeetingComponent {
+  credentials = { apiUserName: 'your-api-user', apiKey: 'your-api-key' };
+
+  uiOverrides = {
+    consumerResume: {
+      wrap: (original) => async (params) => {
+        const startedAt = performance.now();
+        const result = await original(params);
+        
+        // Send analytics
+        this.analytics.track('consumer_resume', {
+          durationMs: performance.now() - startedAt,
+          consumerId: params?.consumer?.id,
+        });
+        
+        return result;
+      },
+    },
+  };
+
+  constructor(private analytics: AnalyticsService) {}
+}
+```
+
+---
+
 # Features <a name="features"></a>
 
 MediaSFU's Angular SDK comes with a host of powerful features out of the box:
@@ -193,12 +607,15 @@ Instructions on how to install the module using npm.
 ### 1. **Add the package to your project**
 
     ```bash
-    npm install mediasfu-angular
+  npm install mediasfu-angular bootstrap ngx-cookie-service socket.io-client mediasoup-client @fortawesome/angular-fontawesome @fortawesome/fontawesome-svg-core @fortawesome/free-solid-svg-icons @fortawesome/free-brands-svg-icons
+
+  # Optional but recommended for virtual backgrounds and scanner-based flows
+  npm install @mediapipe/selfie_segmentation @zxing/ngx-scanner
     ```
 
 ### 2. **Bootstrap Integration**
 
-    The `mediasfu-angular` package requires Bootstrap for styling. Bootstrap is included by default with the package, so you do not need to install it separately. Ensure that Bootstrap's CSS is correctly added to your project's styles.
+  The `mediasfu-angular` package expects Bootstrap as a peer dependency. If your Angular app does not already ship with Bootstrap, install it and ensure Bootstrap's CSS is added to your project's styles.
 
     1. **Check `angular.json`:**
 
@@ -224,12 +641,12 @@ Instructions on how to install the module using npm.
       }
       ```
 
-   **Note:** The `mediasfu-angular` package should handle the Bootstrap's package installation automatically. If it's not present, you may need to add it manually install Bootstrap.
+  **Note:** `mediasfu-angular` does not bundle Bootstrap for you. Keep the CSS import explicit so your app and the SDK agree on styling.
 
 
 ### 3. **Configure MediaSFU's PreJoinPage Requirements**
 
-    If you intend to use MediaSFU's `PreJoinPage` component, additional configuration is required. You need to provide the `HttpClient` and `CookieService` providers in your application's configuration. These packages should have been installed by default as well else add manually. 
+    If you intend to use MediaSFU's `PreJoinPage` component, additional configuration is required. Provide `HttpClient` and `CookieService` in your application's configuration, and make sure `ngx-cookie-service` is installed in your Angular app.
 
     #### Update `app.config.ts`
 
@@ -412,7 +829,7 @@ import {
 
 MediaSFU offers three progressive levels of customization:
 
-##### Mode 1: Default UI (Simplest)
+##### Mode 1: Default UI (Beginner / Fastest Path)
 Use MediaSFU's complete pre-built interface - perfect for rapid development.
 
 ```typescript
@@ -435,7 +852,7 @@ export class AppComponent {
 - ✅ Need a production-ready UI quickly
 - ✅ Standard video conferencing features are sufficient
 
-##### Mode 2: Custom UI with MediaSFU Backend (Most Flexible)
+##### Mode 2: Headless Runtime + Custom UI (Intermediate)
 Build your own UI while using MediaSFU's powerful backend infrastructure.
 
 ```typescript
@@ -505,13 +922,14 @@ export class AppComponent implements OnInit {
 - ✅ Building a custom branded experience
 - ✅ Integrating into existing app design
 
-##### Mode 3: Component Replacement (Balanced)
+##### Mode 3: Custom Main Shell (Advanced)
 Replace specific MediaSFU components while keeping the rest of the infrastructure.
 
 ```typescript
 import { Component } from '@angular/core';
 import { 
   MediasfuGeneric, 
+  PreJoinPage,
   FlexibleVideo, 
   FlexibleGrid 
 } from 'mediasfu-angular';
@@ -579,7 +997,7 @@ export class CustomMainComponent {
     <app-mediasfu-generic
       [credentials]="credentials"
       [PrejoinPage]="PreJoinPage"
-      [customComponent]="CustomMainComponent">
+      [customMainComponent]="CustomMainComponent">
     </app-mediasfu-generic>
   `,
 })
@@ -635,11 +1053,11 @@ The `sourceParameters` object (or `parameters` in custom components) is your gat
 // In Mode 2 (Custom UI): Access via sourceParameters
 sourceParameters?.clickVideo({ parameters: sourceParameters });
 
-// In Mode 3 (Component Replacement): Passed to your custom component
+// In Mode 3 (Custom Main Shell): Passed to your custom main component
 @Component({
   template: `<button (click)="toggleVideo()">Toggle</button>`
 })
-export class CustomComponent {
+export class CustomRoomShellComponent {
   @Input() parameters: any;
   
   toggleVideo() {
@@ -1986,7 +2404,7 @@ export type PreJoinPageType = (options: PreJoinPageOptions) => HTMLElement;
 })
 export class PreJoinPage implements OnInit {
   @Input() parameters: PreJoinPageParameters = {} as PreJoinPageParameters;
-  @Input() credentials: Credentials = { apiUserName: 'yourAPIUSERNAME', apiKey: 'yourAPIKEY' };
+  @Input() credentials: Credentials = { apiUserName: '', apiKey: '' };
   @Input() localLink: string | undefined = "";
   @Input() connectMediaSFU: boolean | undefined = true;
   @Input() returnUI?: boolean;
@@ -2940,7 +3358,7 @@ export default AppComponent;
  *       return res.status(401).json({ error: "Invalid or expired credentials" });
  *     }
  *
- *     const response = await fetch("https://mediasfu.com/v1/rooms", {
+ *     const response = await fetch("https://mediasfu.com/v1/rooms/", {
  *       method: "POST",
  *       headers: {
  *         "Content-Type": "application/json",
@@ -3029,7 +3447,7 @@ export default AppComponent;
  *     localLink = '',
  * }) => {
  *     try {
- *         let finalLink = 'https://mediasfu.com/v1/rooms/join';
+ *         let finalLink = 'https://mediasfu.com/v1/rooms/';
  *
  *         // Update finalLink if using a local server
  *         if (localLink) {
@@ -4002,6 +4420,504 @@ Once your custom components are built, modify the imports of `prepopulateUserMed
 This allows for full flexibility in how media is displayed in both the main and mini grids, giving you the ability to tailor the user experience to your specific needs.
 
 
+
+---
+
+## UI Component Customization & Override System
+
+MediaSFU provides comprehensive customization capabilities for all UI components through a powerful override system. You can customize styling, inject custom templates, or completely replace components with your own implementations.
+
+### Overview
+
+The customization system operates at three levels:
+
+1. **Style Overrides**: Apply custom CSS styles to containers, overlays, and content areas
+2. **Template Injection**: Replace default component templates with custom Angular templates
+3. **Component Replacement**: Completely replace MediaSFU components with your own using the `WithOverrideDirective`
+
+### 1. Style Customization
+
+All display and modal components support style customization through Input properties:
+
+#### Display Components (MainContainer, MainAspect, MainScreen, MainGrid, OtherGrid, SubAspect, FlexibleGrid, AudioGrid)
+
+```typescript
+@Component({
+  selector: 'app-my-meeting',
+  template: `
+    <app-main-container
+      [containerStyle]="{
+        backgroundColor: '#1a1a1a',
+        border: '2px solid #333',
+        borderRadius: '12px',
+        padding: '20px'
+      }"
+      [backgroundColor]="'transparent'">
+    </app-main-container>
+    
+    <app-flexible-grid
+      [containerStyle]="{
+        display: 'grid',
+        gridTemplateColumns: 'repeat(3, 1fr)',
+        gap: '16px'
+      }">
+    </app-flexible-grid>
+  `
+})
+export class MyMeetingComponent {
+  // Custom styles can also be dynamic
+  mainGridStyle: Partial<CSSStyleDeclaration> = {
+    backgroundColor: '#2a2a2a',
+    maxWidth: '1400px',
+    margin: '0 auto'
+  };
+}
+```
+
+#### Modal Components (All modals support overlayStyle, contentStyle)
+
+```typescript
+@Component({
+  selector: 'app-custom-modal-example',
+  template: `
+    <!-- Participants Modal with custom styling -->
+    <app-participants-modal
+      [isParticipantsModalVisible]="true"
+      [overlayStyle]="{
+        backgroundColor: 'rgba(0, 0, 0, 0.85)',
+        backdropFilter: 'blur(8px)'
+      }"
+      [contentStyle]="{
+        backgroundColor: '#ffffff',
+        borderRadius: '16px',
+        boxShadow: '0 8px 32px rgba(0, 0, 0, 0.3)',
+        maxWidth: '600px',
+        padding: '24px'
+      }">
+    </app-participants-modal>
+    
+    <!-- Recording Modal with custom theme -->
+    <app-recording-modal
+      [isRecordingModalVisible]="true"
+      [contentStyle]="{
+        backgroundColor: '#f5f5f5',
+        border: '3px solid #007bff',
+        fontFamily: 'Inter, sans-serif'
+      }">
+    </app-recording-modal>
+  `
+})
+export class CustomModalExample {
+  // Styles can be computed or conditional
+  get modalOverlay(): Partial<CSSStyleDeclaration> {
+    return {
+      backgroundColor: this.isDarkMode ? 'rgba(0,0,0,0.9)' : 'rgba(0,0,0,0.5)'
+    };
+  }
+}
+```
+
+### 2. Template Injection
+
+Replace default component templates with custom Angular templates using `TemplateRef`:
+
+```typescript
+import { Component, TemplateRef, ViewChild } from '@angular/core';
+
+@Component({
+  selector: 'app-custom-template-demo',
+  template: `
+    <!-- Define custom template -->
+    <ng-template #customMainGridTemplate let-components="components">
+      <div class="my-custom-grid">
+        <div class="grid-header">
+          <h3>Active Participants</h3>
+          <span class="count">{{ components?.length || 0 }}</span>
+        </div>
+        <div class="grid-content">
+          <!-- Custom rendering logic -->
+          <div *ngFor="let component of components" class="participant-tile">
+            <ng-container *ngComponentOutlet="component"></ng-container>
+          </div>
+        </div>
+      </div>
+    </ng-template>
+    
+    <!-- Use custom template -->
+    <app-main-grid
+      [customTemplate]="customMainGridTemplate"
+      [mainGridStream]="streams">
+    </app-main-grid>
+    
+    <!-- Custom modal template -->
+    <ng-template #customAlertTemplate let-message="message" let-type="type">
+      <div class="custom-alert" [class.error]="type === 'error'">
+        <i class="alert-icon"></i>
+        <p>{{ message }}</p>
+        <button (click)="closeAlert()">Dismiss</button>
+      </div>
+    </ng-template>
+    
+    <app-alert-component
+      [customTemplate]="customAlertTemplate"
+      [visible]="showAlert"
+      [message]="alertMessage">
+    </app-alert-component>
+  `,
+  styles: [`
+    .my-custom-grid {
+      background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+      border-radius: 12px;
+      padding: 20px;
+    }
+    
+    .grid-header {
+      display: flex;
+      justify-content: space-between;
+      color: white;
+      margin-bottom: 16px;
+    }
+    
+    .participant-tile {
+      background: rgba(255, 255, 255, 0.1);
+      border-radius: 8px;
+      padding: 12px;
+      margin: 8px 0;
+    }
+  `]
+})
+export class CustomTemplateDemo {
+  @ViewChild('customMainGridTemplate') customMainGridTemplate!: TemplateRef<any>;
+  @ViewChild('customAlertTemplate') customAlertTemplate!: TemplateRef<any>;
+  
+  streams: any[] = [];
+  showAlert = false;
+  alertMessage = '';
+  
+  closeAlert() {
+    this.showAlert = false;
+  }
+}
+```
+
+### 3. Component Replacement with UI Overrides
+
+Use the `uiOverrides` system to completely replace MediaSFU components with your own:
+
+```typescript
+import { Component, Type } from '@angular/core';
+import { MediasfuUICustomOverrides } from 'mediasfu-angular';
+
+// Your custom replacement components
+@Component({
+  selector: 'app-my-custom-video-card',
+  template: `
+    <div class="premium-video-card">
+      <video [srcObject]="videoStream" autoplay></video>
+      <div class="overlay">
+        <span class="name">{{ participant.name }}</span>
+        <button class="pin-btn" (click)="togglePin()">📌</button>
+      </div>
+    </div>
+  `,
+  styles: [`
+    .premium-video-card {
+      position: relative;
+      border-radius: 16px;
+      overflow: hidden;
+      box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15);
+    }
+    .overlay {
+      position: absolute;
+      bottom: 0;
+      left: 0;
+      right: 0;
+      background: linear-gradient(transparent, rgba(0,0,0,0.8));
+      padding: 12px;
+      display: flex;
+      justify-content: space-between;
+      align-items: center;
+    }
+  `]
+})
+export class MyCustomVideoCard {
+  // Your custom implementation
+}
+
+@Component({
+  selector: 'app-my-custom-control-buttons',
+  template: `
+    <div class="modern-controls">
+      <button class="control-btn mic" [class.active]="!isMuted" (click)="toggleMic()">
+        <i class="icon-mic"></i>
+      </button>
+      <button class="control-btn camera" [class.active]="!isVideoOff" (click)="toggleVideo()">
+        <i class="icon-camera"></i>
+      </button>
+      <button class="control-btn screen" (click)="toggleScreen()">
+        <i class="icon-screen"></i>
+      </button>
+      <button class="control-btn leave danger" (click)="leaveMeeting()">
+        <i class="icon-leave"></i>
+      </button>
+    </div>
+  `,
+  styles: [`
+    .modern-controls {
+      display: flex;
+      gap: 12px;
+      padding: 16px;
+      background: rgba(0, 0, 0, 0.8);
+      border-radius: 24px;
+    }
+    .control-btn {
+      width: 48px;
+      height: 48px;
+      border-radius: 50%;
+      border: none;
+      cursor: pointer;
+      transition: all 0.2s;
+    }
+    .control-btn.active {
+      background: #4CAF50;
+      color: white;
+    }
+    .control-btn.danger {
+      background: #f44336;
+      color: white;
+    }
+  `]
+})
+export class MyCustomControlButtons {
+  // Your custom implementation
+}
+
+@Component({
+  selector: 'app-meeting-room',
+  template: `
+    <app-mediasfu-generic
+      [credentials]="credentials"
+      [uiOverrides]="customUIOverrides"
+      [returnUI]="false">
+    </app-mediasfu-generic>
+  `
+})
+export class MeetingRoomComponent {
+  credentials = { apiUserName: 'user', apiKey: 'key' };
+  
+  // Define your UI overrides
+  customUIOverrides: Partial<MediasfuUICustomOverrides> = {
+    // Replace video cards
+    VideoCard: MyCustomVideoCard as Type<any>,
+    
+    // Replace control buttons
+    ControlButtonsComponent: MyCustomControlButtons as Type<any>,
+    
+    // Replace modals
+    ParticipantsModal: MyCustomParticipantsModal as Type<any>,
+    
+    // Replace other display components
+    MainGrid: MyCustomMainGrid as Type<any>,
+    FlexibleGrid: MyCustomFlexibleGrid as Type<any>,
+    
+    // ... any other components you want to replace
+  };
+}
+```
+
+### 4. Using WithOverrideDirective
+
+The `*appWithOverride` directive enables conditional component replacement:
+
+```typescript
+import { Component } from '@angular/core';
+import { WithOverrideDirective } from 'mediasfu-angular';
+
+@Component({
+  selector: 'app-conditional-override',
+  imports: [WithOverrideDirective, /* other imports */],
+  template: `
+    <!-- Use default or custom component based on condition -->
+    <app-video-card
+      *appWithOverride="useCustomCard ? MyCustomVideoCard : null"
+      [participant]="currentParticipant">
+    </app-video-card>
+    
+    <!-- Override with custom component when premium feature enabled -->
+    <app-control-buttons
+      *appWithOverride="isPremiumUser ? PremiumControlButtons : null">
+    </app-control-buttons>
+  `
+})
+export class ConditionalOverrideComponent {
+  useCustomCard = false;
+  isPremiumUser = false;
+  
+  MyCustomVideoCard = MyCustomVideoCard;
+  PremiumControlButtons = PremiumControlButtons;
+}
+```
+
+### 5. Complete Example: Themed Meeting Room
+
+Here's a comprehensive example combining all customization approaches:
+
+```typescript
+import { Component, TemplateRef, ViewChild, Type } from '@angular/core';
+import { MediasfuUICustomOverrides } from 'mediasfu-angular';
+
+@Component({
+  selector: 'app-themed-meeting-room',
+  template: `
+    <!-- Custom alert template -->
+    <ng-template #brandedAlertTemplate let-message="message">
+      <div class="branded-alert">
+        <img src="/assets/logo.png" alt="Logo" class="alert-logo">
+        <p>{{ message }}</p>
+      </div>
+    </ng-template>
+    
+    <app-mediasfu-conference
+      [credentials]="credentials"
+      [returnUI]="true"
+      [uiOverrides]="themeOverrides"
+      [containerStyle]="meetingContainerStyle">
+      
+      <!-- Customize individual components -->
+      <app-main-grid
+        [containerStyle]="gridStyle"
+        [customTemplate]="customGridTemplate">
+      </app-main-grid>
+      
+      <app-control-buttons-component
+        [containerStyle]="controlsStyle">
+      </app-control-buttons-component>
+      
+      <app-participants-modal
+        [overlayStyle]="modalOverlayStyle"
+        [contentStyle]="modalContentStyle">
+      </app-participants-modal>
+      
+      <app-alert-component
+        [customTemplate]="brandedAlertTemplate">
+      </app-alert-component>
+    </app-mediasfu-conference>
+  `,
+  styles: [`
+    .branded-alert {
+      display: flex;
+      align-items: center;
+      gap: 12px;
+      padding: 16px;
+      background: white;
+      border-left: 4px solid #007bff;
+    }
+  `]
+})
+export class ThemedMeetingRoomComponent {
+  @ViewChild('brandedAlertTemplate') brandedAlertTemplate!: TemplateRef<any>;
+  
+  credentials = {
+    apiUserName: 'your-api-username',
+    apiKey: 'your-api-key'
+  };
+  
+  // Container styling
+  meetingContainerStyle: Partial<CSSStyleDeclaration> = {
+    backgroundColor: '#0f0f0f',
+    fontFamily: 'Inter, system-ui, sans-serif'
+  };
+  
+  // Grid styling
+  gridStyle: Partial<CSSStyleDeclaration> = {
+    display: 'grid',
+    gridTemplateColumns: 'repeat(auto-fit, minmax(300px, 1fr))',
+    gap: '16px',
+    padding: '20px'
+  };
+  
+  // Controls styling
+  controlsStyle: Partial<CSSStyleDeclaration> = {
+    position: 'fixed',
+    bottom: '24px',
+    left: '50%',
+    transform: 'translateX(-50%)',
+    backgroundColor: 'rgba(0, 0, 0, 0.9)',
+    borderRadius: '32px',
+    padding: '12px 24px'
+  };
+  
+  // Modal styling
+  modalOverlayStyle: Partial<CSSStyleDeclaration> = {
+    backgroundColor: 'rgba(0, 0, 0, 0.85)',
+    backdropFilter: 'blur(10px)'
+  };
+  
+  modalContentStyle: Partial<CSSStyleDeclaration> = {
+    backgroundColor: '#1a1a1a',
+    color: '#ffffff',
+    borderRadius: '16px',
+    border: '1px solid #333'
+  };
+  
+  // Component overrides
+  themeOverrides: Partial<MediasfuUICustomOverrides> = {
+    VideoCard: BrandedVideoCard as Type<any>,
+    ControlButtonsComponent: ModernControls as Type<any>
+  };
+}
+```
+
+### Customizable Components Reference
+
+#### Display Components
+- `MainContainer` - Main viewport container
+- `MainAspect` - Aspect ratio container
+- `MainScreen` - Screen share display
+- `MainGrid` - Primary participant grid
+- `OtherGrid` - Secondary participant grid
+- `SubAspect` - Sub-aspect ratio container
+- `FlexibleGrid` - Flexible layout grid
+- `AudioGrid` - Audio-only participants grid
+
+Each accepts: `containerStyle?: Partial<CSSStyleDeclaration>`, `customTemplate?: TemplateRef<any>`
+
+#### Modal Components
+- `LoadingModal` - Loading indicator
+- `ConfirmExitModal` - Exit confirmation
+- `ConfirmHereModal` - Presence confirmation
+- `ShareEventModal` - Event sharing
+- `AlertComponent` - Alert notifications
+- `MenuModal` - Main menu
+- `ParticipantsModal` - Participants list
+- `RecordingModal` - Recording controls
+- `RequestsModal` - Media requests
+- `WaitingRoomModal` - Waiting room management
+- `CoHostModal` - Co-host management
+- `DisplaySettingsModal` - Display settings
+- `EventSettingsModal` - Event settings
+- `MediaSettingsModal` - Media device settings
+- `MessagesModal` - Chat messages
+- `PollModal` - Polls interface
+- `BackgroundModal` - Background effects
+- `BreakoutRoomsModal` - Breakout rooms
+- `ConfigureWhiteboardModal` - Whiteboard settings
+- `ScreenboardModal` - Screen annotation
+
+Each accepts: `overlayStyle?: Partial<CSSStyleDeclaration>`, `contentStyle?: Partial<CSSStyleDeclaration>`, `customTemplate?: TemplateRef<any>`
+
+### Best Practices
+
+1. **Type Safety**: Always use `Partial<CSSStyleDeclaration>` for style properties
+2. **Template Context**: Ensure your custom templates accept the correct context variables
+3. **Component Lifecycle**: Custom replacement components should implement the same interface as the original
+4. **Performance**: Avoid inline style objects in templates; define them in the component class
+5. **Responsive Design**: Use CSS Grid and Flexbox for responsive layouts
+6. **Accessibility**: Maintain ARIA attributes and keyboard navigation in custom components
+7. **Testing**: Test custom components in isolation before integration
+
+---
+
 # API Reference <a name="api-reference"></a>
 
 For detailed information on the API methods and usage, please refer to the [MediaSFU API Documentation](https://mediasfu.com/developers).
@@ -4059,14 +4975,28 @@ https://github.com/MediaSFU/MediaSFU-ReactJS/assets/157974639/a6396722-5b2f-4e93
 
 # Contributing <a name="contributing"></a>
 
-We welcome contributions from the community to improve the project! If you'd like to contribute, please check out our [GitHub repository](https://github.com/MediaSFU-Angular) and follow the guidelines outlined in the README.
+We welcome contributions from the community to improve the project! If you'd like to contribute, please check out our [GitHub repository](https://github.com/MediaSFU/MediaSFU-Angular) and follow the guidelines outlined in the README.
 
 If you encounter any issues or have suggestions for improvement, please feel free to open an issue on GitHub.
 
 We appreciate your interest in contributing to the project!
 
 If you need further assistance or have any questions, feel free to ask!
-```
+
+---
+
+## Related SDKs
+
+| Package | Framework | npm |
+|---------|-----------|-----|
+| [mediasfu-reactjs](https://github.com/MediaSFU/MediaSFU-ReactJS) | React 18/19 | [`npm install mediasfu-reactjs`](https://www.npmjs.com/package/mediasfu-reactjs) |
+| [mediasfu-vue](https://github.com/MediaSFU/MediaSFU-Vue) | Vue 3 | [`npm install mediasfu-vue`](https://www.npmjs.com/package/mediasfu-vue) |
+| **[mediasfu-angular](https://github.com/MediaSFU/MediaSFU-Angular)** | **Angular 17+** | **this package** |
+| [mediasfu-shared](https://github.com/MediaSFU/MediaSFU-Shared) | Framework-agnostic | [`npm install mediasfu-shared`](https://www.npmjs.com/package/mediasfu-shared) |
+
+## License
+
+MIT © [MediaSFU](https://www.mediasfu.com)