chatKit lib
v0.8.0
チャットと対話する機能を提供するサードパーティ サービスと対話するダイアログ インターフェイスを作成できる反応コンポーネントのライブラリ。
ライブラリをインストールするには、次のコマンドを入力する必要があります。
npm i sova - chatkit
クイックスタートしてライブラリコンポーネントに変更を加えるには、 App.jsxファイルに次のコマンドを入力します。
import React from "react"
import { CkComponents } from "sova-chatkit"
function App ( ) {
return (
< div className = "App" >
< CkComponents . ChatIt ckStore = { true } / >
< / div >
)
}
export default App
ライブラリは次のコンポーネントで構成されます。
? CkComponents - ウィジェットの UI コンポーネント (反応コンポーネント)。
? ckAPIMethods - UI の動作または UI との対話に影響を与えるメソッド。
ckStore - コンテンツの管理。
ライブラリの詳細については、以下で説明します。
import { CkComponents } from "sova-chatkit"
ウィジェットは次の React コンポーネントを使用します。
成分 | |
---|---|
バッジ | ウィジェット展開ボタン |
メッセージ | それに関する情報を含むテキスト メッセージのバブル |
ダイアログ | 一連のテキストメッセージを表示する |
ヘッダ | ウィジェットのタイトル |
レート | メッセージの評価のコンポーネント |
送信者 | メッセージ入力および送信コンポーネント |
各コンポーネントは、コンポーネントがベースckStore
からの情報に固執する必要があるかどうかを示す値true
またはfalse
持つckStore
からの小道具を受け入れます。
import { ckAPIMethods } from "sova-chatkit"
ckAPIMethods
メソッドのリストを保存します。
APIメソッド | |
---|---|
メッセージAPIを受け取る | テキストメッセージをSTOREに追加する |
sendMessageAPI | リクエストを呼び出すためにモジュールにメッセージを送信します |
スタイルAPI | ウィジェットのテーマまたは個々のコンポーネントを編集する |
ui管理API | STORE のコンポーネントの設定を変更する |
設定API | ウィジェット内の写真を変更する |
モジュールAPI | ダイアログモジュールの接続 |
言語API | 設定言語パック |
すべてのメソッドはckStore
に保存されている情報に影響を与え、ウィジェットの動作や表示を変更する可能性があります。
import { ckStore } from "sova-chatkit"
ckStore
コンテンツ情報をグローバル キーに保存します。
鍵 | |
---|---|
メッセージ | ユーザーのメッセージ履歴と受信した回答 |
モジュール | ダイアログモジュールの情報 |
設定 | ダイアログの設定とその状態 |
言語 | 設定言語パック |
スタイル | ダイアログと個々のコンポーネントのスタイル設定 |
clientConfig | トップレベルのウィジェット設定 |
管理 | ウィジェット設定 |
Storeon で実装されます。 React dev tools ですべてのコンテンツ情報を確認できます。