Web Components Chat (チャット) の概要

Ignite UI for Web Components チャットコンポーネントは、アプリケーションで会話型インターフェースを構築するための完全なソリューションを提供します。カスタマーサポートツール、コラボレーションワークスペース、チャットボットアシスタントなどを作成する場合でも、チャットコンポーネントは必要な機能を提供します: テキストメッセージの送受信、ファイル添付のアップロード、クイックリプライサジェストの表示、他の参加者が入力中であることを示す入力中インジケーター。

Chat コンポーネントは静的なメッセージリストではなく、リアルタイム通信を想定したインタラクティブな設計です。入力やレンダリング、ユーザー操作を管理しつつ、メッセージや添付の表示方法は完全にカスタマイズ可能です。また、レイアウトやビジュアルの任意部分をオーバーライドできる広範なレンダリング API も提供されています。

インストール

Ignite UI for Web Components を使用するには、以下のコマンドでインストールします。

npm install igniteui-webcomponents

インストール後、プロジェクトにコンポーネントをインポートし、カスタム要素として登録すると利用可能になります。

import { defineComponents, IgcChatComponent } from "igniteui-webcomponents";
import 'igniteui-webcomponents/themes/light/bootstrap.css';

defineComponents(IgcChatComponent);

CSS ファイルにはデフォルトテーマが含まれています。Chat をアプリケーションのブランドに合わせて変更したい場合は、別のテーマに置き換えたり、カスタムテーマを作成したりできます。

使用方法

最も簡単な使用方法は、HTML に直接 Chat を宣言することです。

const options: IgcChatOptions = {
  currentUserId: 'me',
  headerText: 'Support Chat',
};

<igc-chat id="myChat" .options=${options}>
</igc-chat>

ここで、currentUserId プロパティは、どのメッセージが「送信済み」 (現在のユーザー) で、どれ「受信済み」 (他のユーザー) かをコンポーネントに判定します。headerText はチャットウィンドウのタイトルを提供します。

レンダリング後は、プログラムからメッセージを追加することも可能です。

const chat = document.getElementById('myChat');
const newMessage = {
  id: '1',
  sender: 'me',
  text: 'Hello! How can I help you?',
  timestamp: Date.now().toString()
};
chat.messages = [...chat.messages, newMessage ];

この方法により、サーバーエンドポイント、チャットボットエンジン、コラボレーションアプリのバックエンドなど、任意のデータソースと簡単に統合できます。

プロパティ

Chat コンポーネントは、その状態と構成を制御できるいくつかの重要なプロパティを公開します。

名前	説明
`messages`	チャットに表示されるメッセージの配列 (`ChatMessage[]`)。表示するメッセージを制御するためにバインド可能。
`draftMessage`	未送信メッセージ。`text` とオプションの `attachments` を含むオブジェクト。メッセージ下書きの保存や復元に便利。
`options`	現在のユーザー ID、入力プレースホルダー、許可されるファイルタイプ、クイックリプライサジェスト、入力遅延、カスタムレンダラーなどのチャット設定 (`ChatOptions`)。
`resourceStrings`	ラベル、ヘッダー、システムテキストのローカライズ文字列。多言語対応に使用。

上記のプロパティを使用することで、Chat の UI をアプリケーションの状態やバックエンドと簡単に同期させることができます。

添付

モダンな会話ではテキストだけに限られません。Chat コンポーネントはファイル添付機能のサポートが組み込まれており、ユーザーは画像、ドキュメント、その他のファイルを共有できます。デフォルトでは入力領域に添付ボタンが表示されます。acceptedFiles プロパティで許可されるファイルタイプを制御可能です。

const options: IgcChatOptions = {
  acceptedFiles="image/*,.pdf",
};

この例では、ユーザーは画像と PDF ファイルのみをアップロードできます。添付が不要なユースケースの場合は、簡単にオフにすることができます。

const options: IgcChatOptions = {
  disableInputAttachments: true,
};

サジェスト

クイックリプライのサジェストは、ユーザーがすぐにタップして返信できる事前定義の応答を提供します。この機能は、チャットボットやカスタマーサービスのフロー、あるいはユーザーを構造化されたプロセスに案内する場合に特に有用です。サジェストは、文字列の配列を suggestions プロパティにバインドすることで提供できます。suggestions-position 属性を使用すると、表示位置を入力領域の下またはメッセージリストの下に制御できます。

const options: IgcChatOptions = {
  currentUserId: "me",
  suggestions: ['Yes', 'No', 'Maybe later'],
  suggestionsPosition: "below-input"
};

<igc-chat
  .options=${options}>
</igc-chat>

この方法により、繰り返し入力する必要が減り、ガイド付きの会話でユーザー体験を向上させることができます。

入力中インジケーター

相手が入力中であることが見えると、会話はより自然に感じられます。Chat コンポーネントでは、オプションオブジェクトの isTyping プロパティを通じてこの動作を提供します。 true に設定すると、メッセージ下にさりげない入力中インジケーターが表示されます。

const options: IgcChatOptions = {
  isTyping: true
};

この機能は通常、バックエンドサービスからの入力イベントを受け取ったときなど、プログラムで切り替えます。

カスタムレンダラー

Chat コンポーネントはデフォルトの UI ですぐに使用できますが、多くのアプリケーションでは外観と操作性をカスタマイズする必要があります。たとえば、既読通知を追加したり、アバターを表示したり、入力領域を音声録音ボタンに置き換えたりする場合です。 Chat コンポーネントはレンダラーシステムでこのニーズに対応します。レンダラーは、UI の特定の部分のテンプレートを返す関数です。必要に応じて、任意の数のレンダラーをオーバーライドできます。

ChatTemplateRenderer

すべてのレンダラーは同じ関数シグネチャに従います。

export type ChatTemplateRenderer<T> = (ctx: T) => unknown;

ctx パラメーターは、レンダリングされる対象に応じたさまざまなコンテキストデータを提供します。

レンダラーコンテキスト

コンテキストタイプ	提供データ
`ChatRenderContext`	`instance` (チャットコンポーネントインスタンス).
`ChatInputRenderContext`	`ChatRenderContext` を継承し、`attachments` (`ChatMessageAttachment` の配列) と `value` (現在の入力テキスト) を追加。
`ChatMessageRenderContext`	`ChatRenderContext` を継承し、`ChatMessage` (レンダリングされる `ChatMessage`) を追加。
`ChatAttachmentRenderContext`	`ChatMessageRenderContext` を継承し、`attachment` (レンダリングされる `ChatMessageAttachment`) を追加。

利用可能なレンダラー

Chat のカスタマイズ可能な部分は次の通りです:

Message レベル: message、messageHeader、messageContent、messageAttachments、messageActions
Attachment レベル: attachment、attachmentHeader、attachmentContent
Input レベル: input、inputActions、inputActionsStart、inputActionsEnd、inputAttachments、fileUploadButton、sendButton
Suggestion: suggestionPrefix
その他: TypingIndicator

この粒度により、添付の表示方法など、特定の部分だけを変更してもチャット全体のレイアウトを書き換える必要はありません。

例: メッセージ内容のカスタマイズ

メッセージバブルを独自のテンプレートに置き換える例です。

const options = {
  renderers = {
    messageContent: (ctx) => {
      const { message } = ctx;
      return html`<div class="bubble custom">${message.content}</div>`;
    }
  }
};

例: 入力領域のカスタマイズ

デフォルトでは、チャット入力はテキスト領域です。音声入力ボタンなど、より適した体験を提供するためにオーバーライドできます。

const options = {
  renderers = {
    input: (ctx) => html`
      <textarea placeholder=${ctx.instance?.options?.inputPlaceholder || 'Type here...'}>${ctx.value}</textarea>
      <button @click=${() => alert('Voice input!')}>🎤</button>
    `
  }
};

例: 入力アクションの拡張

Chat コンポーネントには、デフォルトのアクション (アップロードと送信) を保持しつつ追加のコントロールを拡張できるレンダラーがあります:

inputActionsStart - デフォルトのアップロードボタンの後にカスタムコンテンツを挿入可能。
inputActionsEnd - デフォルトの送信ボタンの後にカスタムコンテンツを挿入可能。

例えば、アップロードボタンの横に音声録音ボタンを追加したり、送信ボタンの後に追加オプションメニューを追加したりできます。次の例では、デフォルトのアップロードボタンはそのままですが、その隣にマイクボタンが追加されています。一方、デフォルトの送信ボタンを削除し、カスタムの「質問」ボタンと「その他」メニューに置き換えます。

const _actionsStartTemplate = () => html`
  <igc-icon-button variant="flat">🎤</igc-icon-button>
`;

const _actionsEndTemplate = (ctx: ChatRenderContext) => html`
  <div>
    <igc-button @click=${() => handleCustomSendClick(ctx.instance)}>Ask</igc-button>
    <igc-icon-button variant="flat" name="more_horiz"></igc-icon-button>
  </div>
`;

const options = {
  renderers: {
    inputActionsStart: _actionsStartTemplate,
    inputActionsEnd: _actionsEndTemplate,
    sendButton: () => nothing,
  },
};

この設定では:

アップロードボタンはそのまま残ります。
その後にマイクボタンが追加されます (inputActionsStart)。
デフォルトの送信ボタンが削除され、カスタムの「質問」ボタンと「その他」アイコン (inputActionsEnd) に置き換えられました。

この方法により、チャット入力バーの柔軟性が完全に向上し、入力領域を最初から再構築することなく、アクションを追加、削除、または並べ替えることができます。

Markdown レンダリング

Chat コンポーネントは igniteui-webcomponents/extras からエクスポートされる createMarkdownRenderer ヘルパーを通じて Markdown をサポートします。これにより、書式付きテキスト、リンク、リスト、シンタックスハイライト付きコードブロックを表示しつつ、安全に HTML をサニタイズできます。

[!Note] Markdown レンダラーを使用するには、プロジェクトに次のピア依存関係をインストールする必要があります。

npm install marked marked-shiki shiki dompurify

デフォルトでは、メッセージはプレーンテキストとして表示されます。Markdown サポートを有効にする場合は、messageContent レンダラーをオーバーライドし、以下に示すように Markdown レンダラーを使用できます。

import { createMarkdownRenderer } from 'igniteui-webcomponents/extras';

// Create a reusable Markdown renderer instance
const markdownRenderer = await createMarkdownRenderer();

const options = {
  renderers: {
    messageContent: async ({ message }) => markdownRenderer(message),
  }
};

例:

各メッセージの text プロパティが marked ライブラリを使用して Markdown として解析されます。
レンダラーは DOMPurify を使用して出力をサニタイズします。
リンクは自動的に新しいタブで開き、安全な rel 属性が付与されます。

構文のハイライト表示

Markdown レンダラーは、Shiki を使用したコードブロックの構文のハイライト表示もサポートします。デフォルトでは JavaScript、TypeScript、HTML、CSS に対して github-light テーマでハイライト表示されます。この動作は、MarkdownRendererOptions を通じてカスタマイズできます。

const markdownRenderer = await createMarkdownRenderer({
  theme: { light: 'min-light' },
  languages: ['javascript', 'python']
});

これにより、GitHub のダークテーマでスタイル設定された、JavaScript、Python、Go のハイライト表示されたコードブロックが有効になります。

構成オプション

オプション	説明
`noHighlighter`	true の場合、構文のハイライト表示が完全に無効になります。
`languages`	ハイライト表示されたコードブロックでサポートするプログラミング言語のリスト。
`theme`	適用する Shiki テーマを指定するオブジェクト。`light` モードと `dark` モードに個別の値をサポートします (例: `{ light: 'github-light', dark: 'github-dark' }`)。
`sanitizer`	最終的な HTML をサニタイズするカスタム関数。デフォルトは `DOMPurify.sanitize` です。

イベント

アプリケーションロジックと統合するために、Chat コンポーネントは一連のイベントを発行します。

igcMessageCreated - 新しいメッセージ作成時
igcMessageReact - メッセージにリアクションした時
igcAttachmentClick - 添付クリック時
igcAttachmentChange - 添付変更時
igcAttachmentDrag - 添付ドラッグ中
igcAttachmentDrop - 添付ドロップ時
igcTypingChange - 入力状態変更時
igcInputFocus / igcInputBlur - 入力フォーカスイベント
igcInputChange - 入力値変更時

これらのイベントをリッスンし、バックエンドと同期することができます。

chat.addEventListener('igcMessageCreated', (e) => {
  console.log('Message:', e.detail);
});

スタイル設定

Chat コンポーネントは、外観や構造を詳細にカスタマイズできる CSS パーツとスロットを提供します。

CSS パーツ

パーツ名	説明
`chat-container`	メインチャットコンテナーのスタイルを設定します。
`header`	チャットヘッダーコンテナーのスタイルを設定します。
`prefix`	チャットタイトルの前の要素 (アバターなど) のスタイルを設定します。
`title`	チャットヘッダータイトルのスタイルを設定します。
`message-area-container`	メッセージと (オプションの) サジェストを保持するコンテナーのスタイルを設定します。
`message-list`	メッセージリストコンテナーのスタイルを設定します。
`message-item`	各メッセージラッパーのスタイルを設定します。
`typing-indicator`	入力インジケーターコンテナーのスタイルを設定します。
`typing-dot`	個々の入力中インジケーターのドットをスタイルします。
`suggestions-container`	すべてのサジェストを保持するコンテナーのスタイルを設定します。
`suggestions-header`	サジェストヘッダーのスタイルを設定します。
`suggestion`	各サジェスト項目にスタイルを設定します。
`suggestion-prefix`	サジェスト内のアイコンまたはプレフィックスのスタイルを設定します。
`suggestion-title`	サジェストのテキスト/タイトルのスタイルを設定します。
`empty-state`	メッセージがない場合の空の状態のコンテナーのスタイルを設定します。
`input-area-container`	チャット入力領域のラッパーのスタイルを設定します。
`input-container`	メイン入力コンテナーのスタイルを設定します。
`input-attachments-container`	入力内の添付のコンテナーのスタイルを設定します。
`input-attachment-container`	入力領域内の単一の添付にスタイルを設定します。
`input-attachment-name`	添付のファイル名のスタイルを設定します。
`input-attachment-icon`	添付のアイコンのスタイルを設定します。
`text-input`	メッセージを入力するためのテキスト入力フィールドのスタイルを設定します。
`input-actions-container`	入力アクション用のコンテナーのスタイルを設定します。
`input-actions-start`	デフォルトのファイルアップロード後、入力の先頭にあるアクショングループをスタイル設定します。
`input-actions-end`	入力の末尾にあるアクショングループをスタイル設定します。
`file-upload-container`	ファイルアップロード入力用のコンテナーのスタイルを設定します。
`file-upload`	ファイルアップロード入力自体のスタイルを設定します。
`send-button-container`	送信ボタンの周囲のコンテナーのスタイルを設定します。
`send-button`	送信ボタンのスタイルを設定します。
`message-container`	単一メッセージのコンテナーをスタイルします。
`message-list (forwarded)`	メッセージの内部リストのスタイルを設定します。
`message-header`	メッセージのヘッダー (送信者、タイムスタンプなど) のスタイルを設定します。
`message-content`	メッセージのテキストコンテンツのスタイルを設定します。
`message-attachments-container`	メッセージ添付のコンテナーのスタイルを設定します。
`message-attachment`	単一のメッセージ添付にスタイルを設定します。
`message-actions-container`	メッセージアクションを保持するコンテナーのスタイルを設定します。
`message-sent`	現在のユーザーによって送信済みとしてマークされたメッセージにスタイルを設定します。
`attachment-header`	添付ブロックのヘッダーにスタイルを設定します。
`attachment-content`	添付ブロックのコンテンツにスタイルを設定します。
`attachment-icon`	添付のアイコンのスタイルを設定します。
`file-name`	添付に表示されるファイル名のスタイルを指定します。

スロット

スロット名	説明
`prefix`	チャットタイトルの前にコンテンツ (アバターやアイコンなど) を挿入するためのスロット。
`title`	チャットタイトルの内容をオーバーライドするためのスロット。
`actions`	ヘッダーアクション (ボタン、メニューなど) を挿入するためのスロット。
`suggestions-header`	サジェストリストのカスタムヘッダーをレンダリングするためのスロット。
`suggestions`	クイックリプライのサジェストのカスタムリストをレンダリングするためのスロット。
`suggestions-actions`	追加のアクションをレンダリングするためのスロット。
`suggestion`	単一のサジェスト項目をレンダリングするためのスロット。
`empty-state`	メッセージがない場合に表示されるスロット。

ルートスタイルの採用 (adoptRootStyles)

Chat コンポーネントのオプションには、高度なスタイル設定シナリオ用の特別なフラグが含まれています。

オプション	タイプ	デフォルト	説明
`adoptRootStyles`	`boolean`	false	true の場合、コンポーネントは、Shadow DOM 内でレンダリングされるコンテンツ (カスタムレンダラーなど) がドキュメントのルートからスタイルを継承することを許可します。これは、スタイル設定のための簡単な回避策を提供しますが、本番環境での使用は推奨されません。

このプロパティは、カスタムレンダリングされたテンプレートにグローバル CSS を適用するときに Shadow DOM カプセル化を処理したくない場合に役立ちます。ただし、以下のトレードオフがあります:

✅ 利便性: ドキュメントのグローバルスタイルがカスタムメッセージレンダラーに適用されます。
⚠️ 危険: カプセル化が破られ、グローバル CSS によって内部の表示が意図せず変更される可能性があります。
🔒 1 回限りの設定: このオプションは初期化時のみ設定可能で、実行時に変更しても効果はありません。

このプロパティに使用する前に、標準の Web Component スタイル設定アプローチを使用することを強くお勧めします。

CSS 変数と ::part API - 公開されたパーツと変数を使用したカスタマイズを優先します。
<link> 要素 – 大きなスタイルシートの場合は、Shadow DOM 内に挿入します。
インライン <style> タグ – 小さなスコープのスタイルオーバーライド用。

例

igc-chat::part(header) {
  background: var(--ig-primary-100);
}

igc-chat::part(message-container) {
  border-radius: 12px;
  padding: 0.5rem;
}

igc-chat::part(empty-state) {
  font-style: italic;
  color: var(--ig-gray-500);
}

これにより、Chat の機能を置き換えることなく、ブランドに合わせたスタイルを適用できます。

API リファレンス

Chat
ChatOptions
ChatMessage
ChatMessageAttachment
ChatRenderers
ChatTemplateRenderer
スタイル設定およびテーマ