Global Configuration

Centralized configuration for CometChat Angular UIKit components using the COMETCHAT_GLOBAL_CONFIG injection token

AI Integration Quick Reference

Field	Value
Purpose	App-wide kit defaults through one injection token, instead of repeating the same input on every component instance.
Package	@cometchat/chat-uikit-angular v5.x
Key symbols	COMETCHAT_GLOBAL_CONFIG
Common trap	Not knowing it is there — a component appearing to ignore a default (call buttons hidden, say) is usually global config, not the component.
On this page	Setup · Configuration Properties · Components That Read GlobalConfig
Related	All guides · LLM index

Overview

The CometChat Angular UIKit provides a centralized configuration system through the COMETCHAT_GLOBAL_CONFIG injection token. This allows you to set default values for common properties across all UIKit components from a single location, without having to pass the same inputs to every component instance.

Priority System

All configurable properties follow a three-tier priority system:

1. @Input value (if explicitly set on the component)
2. GlobalConfig value (from the injection token)
3. Component’s internal default value

This means you can set a global default and still override it on individual component instances when needed.

Setup

Standalone Application (app.config.ts)

import { ApplicationConfig } from '@angular/core';
import { COMETCHAT_GLOBAL_CONFIG, GlobalConfig } from '@cometchat/chat-uikit-angular';

export const appConfig: ApplicationConfig = {
  providers: [
    {
      provide: COMETCHAT_GLOBAL_CONFIG,
      useValue: {
        hideReceipts: true,
        hideUserStatus: false,
        showSearchBar: true,
        disableSoundForMessages: false,
      } as GlobalConfig,
    },
  ],
};

NgModule Application (app.module.ts)

import { NgModule } from '@angular/core';
import { COMETCHAT_GLOBAL_CONFIG, GlobalConfig } from '@cometchat/chat-uikit-angular';

@NgModule({
  providers: [
    {
      provide: COMETCHAT_GLOBAL_CONFIG,
      useValue: {
        hideReceipts: true,
        showSearchBar: true,
      } as GlobalConfig,
    },
  ],
})
export class AppModule {}

Dynamic Configuration with Factory

import { COMETCHAT_GLOBAL_CONFIG } from '@cometchat/chat-uikit-angular';

{
  provide: COMETCHAT_GLOBAL_CONFIG,
  useFactory: (envService: EnvironmentService) => ({
    hideReceipts: envService.isProduction,
    disableSoundForMessages: envService.isMobile,
    showSearchBar: true,
  }),
  deps: [EnvironmentService],
}

Configuration Properties

Property	Type	Default	Description
hideReceipts	boolean	undefined	Hide read receipts across all components
hideError	boolean	undefined	Hide error states across all components
hideUserStatus	boolean	undefined	Hide user online/offline status indicators
hideGroupType	boolean	undefined	Hide group type badges (public/private/password)
showScrollbar	boolean	undefined	Show scrollbar in list components
showSearchBar	boolean	undefined	Show search bar in list components
disableSoundForMessages	boolean	undefined	Disable sound notifications for messages
textFormatters	CometChatTextFormatter[]	undefined	Text formatters for message rendering
disableDefaultContextMenu	boolean	undefined	Disable right-click context menu across components
disableSoundForCalls	boolean	undefined	Disable sound for incoming/outgoing calls
customSoundForCalls	string	undefined	Custom sound URL for calls
customSoundForMessages	string	undefined	Custom sound URL for messages
hideAvatar	boolean	undefined	Hide avatar across components
enablePinMessage	boolean	undefined	Force the Pin Message surfaces on or off, overriding the app-level flag the Chat SDK reports
enableSaveMessage	boolean	undefined	Force the Save Message surfaces on or off, overriding the app-level flag the Chat SDK reports
callSettingsBuilder	CallSettingsBuilder	undefined	Custom CallSettingsBuilder for call components (call buttons, call logs, ongoing call)

All properties are optional. When a property is undefined (not set), the component falls back to its own internal default.

Feature Gates

Two properties gate whole features rather than tune a component’s appearance. They behave differently from the rest of the table, so they are worth calling out.

enablePinMessage and enableSaveMessage

These override the features.ux.messages.pinned.enabled and features.ux.messages.saved.enabled app settings, which the Chat SDK reports through CometChat.isPinMessageEnabled() and CometChat.isSaveMessageEnabled(). An explicit value wins; leaving a property unset falls back to the SDK’s answer.

{
  provide: COMETCHAT_GLOBAL_CONFIG,
  useValue: {
    enablePinMessage: true,
    enableSaveMessage: true,
  } as GlobalConfig,
}

Leave both unset in production. The app’s own settings are the right source of truth. These exist because the flags are provisioned server-side — so before they are switched on for an app, “flag off” is indistinguishable from “not built” and there is no way to develop or demo against the feature.

See the Pin and Save guide.

Call Settings Customization

The callSettingsBuilder property lets you provide a custom CometChatCalls.CallSettingsBuilder that is used across all call-related components. This is useful for configuring call UI features like layout, recording, analytics, or audio-only mode globally.

Global Call Settings

import { CometChatCalls } from '@cometchat/calls-sdk-javascript';
import { COMETCHAT_GLOBAL_CONFIG } from '@cometchat/chat-uikit-angular';

const customCallSettings = new CometChatCalls.CallSettingsBuilder()
  .enableDefaultLayout(true)
  .setIsAudioOnlyCall(false);

export const appConfig: ApplicationConfig = {
  providers: [
    {
      provide: COMETCHAT_GLOBAL_CONFIG,
      useValue: {
        callSettingsBuilder: customCallSettings,
      },
    },
  ],
};

Per-Component Override

Even with a global callSettingsBuilder, you can override it on individual component instances:

<!-- This component uses the per-instance builder, ignoring GlobalConfig -->
<cometchat-call-buttons
  [user]="activeUser"
  [callSettingsBuilder]="myCustomBuilder">
</cometchat-call-buttons>

<!-- This component falls back to GlobalConfig.callSettingsBuilder -->
<cometchat-call-logs
  (itemClick)="onCallLogClick($event)">
</cometchat-call-logs>

Components That Support callSettingsBuilder

Component	Behavior
CometChatOngoingCall	Accepts callSettingsBuilder as @Input. Passes it to OngoingCallService.
CometChatCallButtons	Accepts callSettingsBuilder as @Input. Forwards to CometChatOngoingCall.
CometChatMessageHeader	Accepts callSettingsBuilder as @Input. Forwards to CometChatCallButtons.
CometChatCallLogs	Accepts callSettingsBuilder as @Input. Uses it in the ongoing call overlay.

Components That Read GlobalConfig

The following components read from COMETCHAT_GLOBAL_CONFIG and apply the three-tier priority system:

Component	Properties Read
CometChatConversations	hideReceipts, hideError, hideUserStatus, hideGroupType, showScrollbar, showSearchBar, disableSoundForMessages, textFormatters, customSoundForMessages, hideAvatar, disableDefaultContextMenu
CometChatMessageHeader	hideUserStatus
CometChatMessageList	hideReceipts, hideError, textFormatters, disableSoundForMessages, customSoundForMessages, disableDefaultContextMenu, enablePinMessage, enableSaveMessage
CometChatMessageComposer	textFormatters, disableSoundForMessages, customSoundForMessages
CometChatCallButtons	disableSoundForCalls, customSoundForCalls, callSettingsBuilder
CometChatCallLogs	showScrollbar, callSettingsBuilder
CometChatUsers	hideUserStatus, showScrollbar, showSearchBar, hideAvatar, disableDefaultContextMenu
CometChatGroups	hideGroupType, showScrollbar, showSearchBar, hideAvatar, disableDefaultContextMenu
CometChatGroupMembers	hideUserStatus, showScrollbar, showSearchBar, hideAvatar, disableDefaultContextMenu
CometChatOutgoingCall	disableSoundForCalls, customSoundForCalls
CometChatIncomingCall	disableSoundForCalls, customSoundForCalls

Full Example

import { ApplicationConfig } from '@angular/core';
import { CometChatCalls } from '@cometchat/calls-sdk-javascript';
import { COMETCHAT_GLOBAL_CONFIG, GlobalConfig } from '@cometchat/chat-uikit-angular';

const callSettings = new CometChatCalls.CallSettingsBuilder()
  .enableDefaultLayout(true)
  .setIsAudioOnlyCall(false);

export const appConfig: ApplicationConfig = {
  providers: [
    {
      provide: COMETCHAT_GLOBAL_CONFIG,
      useValue: {
        // Display
        hideReceipts: false,
        hideUserStatus: false,
        hideGroupType: false,
        hideAvatar: false,
        showScrollbar: false,
        showSearchBar: true,

        // Sound
        disableSoundForMessages: false,
        disableSoundForCalls: false,

        // Calls
        hideVoiceCallButton: false,
        hideVideoCallButton: false,
        callSettingsBuilder: callSettings,

        // Context menu
        disableDefaultContextMenu: false,
      } as GlobalConfig,
    },
  ],
};

Related

• Theming — Customize the visual appearance with CSS variables
• Localization — Configure language and translations
• ChatStateService — Centralized chat state management