@vunex/support-chat 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/dist/components/ChatMessage.vue.d.ts +12 -0
- package/dist/components/ChatWindow.vue.d.ts +13 -0
- package/dist/components/GigSupportChat.vue.d.ts +6 -0
- package/dist/gig-support-chat.es.js +3106 -0
- package/dist/gig-support-chat.umd.js +9 -0
- package/dist/index.d.ts +9 -0
- package/dist/store/supportChat.d.ts +349 -0
- package/dist/support-chat.css +1 -0
- package/package.json +43 -0
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Инструкция по интеграции GIG Support Chat
|
|
2
|
+
|
|
3
|
+
Этот модуль представляет собой автономный виджет чата техподдержки для Vue 3 приложений.
|
|
4
|
+
|
|
5
|
+
## 1. Установка
|
|
6
|
+
|
|
7
|
+
Если модуль находится в локальной папке:
|
|
8
|
+
```bash
|
|
9
|
+
npm install ./path/to/gig-support-chat
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 2. Инициализация (main.ts)
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { createApp } from 'vue';
|
|
16
|
+
import App from './App.vue';
|
|
17
|
+
import GigSupportChat from '@gig/support-chat';
|
|
18
|
+
import '@gig/support-chat/style.css';
|
|
19
|
+
|
|
20
|
+
const app = createApp(App);
|
|
21
|
+
|
|
22
|
+
app.use(GigSupportChat, {
|
|
23
|
+
config: {
|
|
24
|
+
// URL бэкенда техподдержки
|
|
25
|
+
apiUrl: 'https://support-api.digitaltaxtech.kz',
|
|
26
|
+
// Путь для сокетов (дефолтно /ws)
|
|
27
|
+
path: '/ws',
|
|
28
|
+
// Ключ системы, выдается администратором
|
|
29
|
+
apiKey: 'your_project_api_key',
|
|
30
|
+
// Уникальный ID текущего пользователя
|
|
31
|
+
uuid: 'user-unique-id',
|
|
32
|
+
// Данные для отображения оператору (необязательно)
|
|
33
|
+
metaUser: {
|
|
34
|
+
name: 'Иван Иванов',
|
|
35
|
+
phone: '+7 777 000 00 00',
|
|
36
|
+
role: 'CLIENT'
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
app.mount('#app');
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## 3. Компонент (App.vue)
|
|
45
|
+
|
|
46
|
+
Разместите компонент в корневом шаблоне вашего приложения:
|
|
47
|
+
|
|
48
|
+
```html
|
|
49
|
+
<template>
|
|
50
|
+
<div id="app">
|
|
51
|
+
<router-view />
|
|
52
|
+
<!-- Виджет чата появится в правом нижнем углу -->
|
|
53
|
+
<GigSupportChat />
|
|
54
|
+
</div>
|
|
55
|
+
</template>
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## 4. Особенности
|
|
59
|
+
- **Изоляция стилей**: Все CSS классы начинаются с префикса `gig-`, что предотвращает конфликты с вашими стилями.
|
|
60
|
+
- **Адаптивность**: Окно чата оптимизировано для десктопных и мобильных браузеров.
|
|
61
|
+
- **Дизайн**: Современный интерфейс с эффектами глассморфизма и плавными анимациями.
|
|
62
|
+
- **Зависимости**: Модуль сам управляет соединением через `socket.io-client`.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
type __VLS_Props = {
|
|
2
|
+
message: any;
|
|
3
|
+
currentUserId: string;
|
|
4
|
+
};
|
|
5
|
+
declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
|
|
6
|
+
reply: (...args: any[]) => void;
|
|
7
|
+
"scroll-to": (...args: any[]) => void;
|
|
8
|
+
}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
|
|
9
|
+
onReply?: ((...args: any[]) => any) | undefined;
|
|
10
|
+
"onScroll-to"?: ((...args: any[]) => any) | undefined;
|
|
11
|
+
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
|
|
12
|
+
export default _default;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
type __VLS_Props = {
|
|
2
|
+
messages: any[];
|
|
3
|
+
isConnected: boolean;
|
|
4
|
+
currentUserId: string;
|
|
5
|
+
};
|
|
6
|
+
declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
|
|
7
|
+
close: (...args: any[]) => void;
|
|
8
|
+
}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
|
|
9
|
+
onClose?: ((...args: any[]) => any) | undefined;
|
|
10
|
+
}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
|
|
11
|
+
messagesContainer: HTMLDivElement;
|
|
12
|
+
}, HTMLDivElement>;
|
|
13
|
+
export default _default;
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { ChatConfig } from '../store/supportChat';
|
|
2
|
+
type __VLS_Props = {
|
|
3
|
+
config: ChatConfig;
|
|
4
|
+
};
|
|
5
|
+
declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
|
|
6
|
+
export default _default;
|