chatKit lib

? Почему?

Библиотека реагирующих компонентов, позволяющая создавать диалоговый интерфейс, взаимодействующий со сторонним сервисом, предоставляющим возможность взаимодействия с чатом.

? Установить

Для установки библиотеки вам необходимо ввести следующую команду:

 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 — компоненты пользовательского интерфейса виджета (реагирующие компоненты);
? ckAPIMethods — методы, влияющие на поведение пользовательского интерфейса или взаимодействие с пользовательским интерфейсом;
ckStore — управление контентом.

Подробное описание библиотеки приведено ниже.

Описание библиотеки

CkComponents

 import { CkComponents } from "sova-chatkit"

Виджет использует следующие компоненты реакции:

Компонент
Значок	кнопка раскрытия виджета
Сообщение	пузырь текстового сообщения с информацией об этом
Диалог	отображение набора текстовых сообщений
Заголовок	заголовок виджета
Ставка	компонент оценки сообщения
Отправитель	компонент ввода и отправки сообщений

Каждый компонент принимает реквизиты из ckStore со значением true или false , обозначающим, должен ли компонент цеплять информацию из базового ckStore или нет.

ckAPIMethods

 import { ckAPIMethods } from "sova-chatkit"

ckAPIMethods хранит список методов:

API-метод
получить сообщениеAPI	добавить текстовые сообщения в МАГАЗИН
sendMessageAPI	отправлять сообщения модулю для запроса вызова
стильAPI	редактировать тему виджета или отдельный компонент
uiManagmentAPI	изменить настройки компонентов в МАГАЗИНЕ
настройкиAPI	поменять картинки в виджете
модулиAPI	подключение диалоговых модулей
языкAPI	языковые пакеты настроек

Все методы влияют на информацию, хранящуюся ckStore , и могут изменять поведение и отображение виджета.

ckStore

 import { ckStore } from "sova-chatkit"

ckStore хранит информацию о контенте в глобальных ключах:

Ключ
сообщение	история сообщений пользователя и входящие ответы
модули	информация о диалоговых модулях
настройки	настройки диалога и его состояния
язык	языковые пакеты настроек
стили	настройки стиля диалога и отдельных компонентов
конфигурация клиента	настройки виджета верхнего уровня
менеджмент	настройки виджета

Реализовано с помощью Storeon. Вы можете увидеть всю информацию о содержимом в инструментах разработки React.