chatkitty

Chatkitty NPMパッケージ

chatkitty NPMパッケージは、チャット機能をWebアプリケーションに統合するための強力なツールです。開発者が最小限の労力で豊富なチャットエクスペリエンスを作成できるようにする包括的な一連の機能を提供します。メッセージングアプリを構築したり、ソーシャルネットワークにチャットを追加したり、カスタマーサポートチャットをアプリケーションに統合したりする場合でも、 chatkitty迅速かつ効率的に開始するために必要なすべてのコンポーネントを提供します。

特徴

• リアルタイムメッセージング機能
• 直接メッセージ、グループチャット、およびチャネルのサポート
• カスタマイズ可能なUIコンポーネント
• 画像、ビデオ、ファイルなどのリッチメディアメッセージ
• インジケーターの入力、領収書の読み取り、およびメッセージステータスの更新
• ユーザー認証と承認
• 高度なカスタマイズと統合のための包括的なAPI

前提条件

• node.js（バージョン12.x以上）
• npm（バージョン6.x以上）

インストール

プロジェクトでchatkittyの使用を開始するには、次のコマンドでNPM経由でインストールできます。

npm install chatkitty --save

基本的な使用法

Chatkittyに接続します

まず、APIキーと接続しているユーザーのユーザー名を使用して、Chatkitty APIとの接続を確立する必要があります。

 import { connectApi } from 'chatkitty' ;

const apiKey = 'YOUR_CHATKITTY_API_KEY' ;
const username = 'USER_USERNAME' ;

const connection = await connectApi ( {
  apiKey : apiKey ,
  username : username ,
} ) ;

console . log ( 'Connected to ChatKitty as' , connection . user . value . username ) ;

チャットインターフェイスの表示

Widget IDとChat UIをレンダリングするコンテナを指定することにより、アプリケーションにChatkitty UIを簡単に読み込んで表示できます。

 import { loadChatUi } from 'chatkitty' ;

const chatUi = await loadChatUi ( {
  widgetId : 'YOUR_WIDGET_ID' ,
  username : 'USER_USERNAME' ,
  container : {
    id : 'chat-ui' ,
    height : '100%' ,
  } ,
} ) ;

// Optional: To unmount the chat UI
// await chatUi.unmount();

チャットエクスペリエンスをカスタマイズします

chatkitty 、テーマ、ローカリゼーション、オーディオ通知などを通じて、チャットUIと動作を広範囲にカスタマイズすることができます。たとえば、テーマをカスタマイズしてカスタムユーザープロファイルを提供するには：

 await loadChatUi ( {
  widgetId : 'YOUR_WIDGET_ID' ,
  theme : 'dark' ,
  profile : {
    displayName : 'John Doe' ,
    displayPicture : 'https://example.com/user-avatar.jpg' ,
  } ,
  // Other options...
} ) ; 

高度な機能

chatkitty 、オーディオ通知、さまざまな言語のローカリゼーション、カスタムチャットコンポーネント、テーラードチャットエクスペリエンスのエラーテンプレートなどの高度な機能を提供します。これらの機能と完全なAPIに関するより詳細なドキュメントについては、公式のChatkittyドキュメントをご覧ください。