hubchat-react-native 1.0.1 → 1.0.2

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.
Files changed (3) hide show
  1. package/README.md +18 -2
  2. package/package.json +1 -1
  3. package/src/index.tsx +1 -1
package/README.md CHANGED
@@ -2,11 +2,23 @@
2
2
 
3
3
  ویجت چت پشتیبانی هاب‌چت برای اپ‌های React Native (iOS و اندروید)، با همان ظاهر و امکانات ویجت سایت.
4
4
 
5
+ ## امکانات
6
+ - دکمه‌ی شناور با رنگ، آیکن، متن و جایگاهی که در پنل هاب‌چت تنظیم کرده‌اید
7
+ - پنل گفتگو با همان ظاهر و امکانات ویجت سایت: ارسال فایل و عکس، پایگاه دانش، ساعات کاری و نظرسنجی رضایت
8
+ - شمارنده‌ی پیام‌های خوانده‌نشده روی دکمه، حتی وقتی پنل بسته است
9
+ - تغییر ظاهر از پنل، بدون نیاز به انتشار نسخه‌ی جدید اپ
10
+ - پیام‌های کاربران در صندوق ورودی هاب‌چت، کنار تلگرام، بله، روبیکا و بقیه‌ی کانال‌ها
11
+
12
+ ## کلید کانال
13
+ کلید را از پنل هاب‌چت بگیرید: «تنظیمات > کانال‌ها > افزودن کانال > اپلیکیشن موبایل». کلید با `hc_` شروع می‌شود و در صفحه‌ی همان کانال، کنار نمونه‌کد نصب، نمایش داده می‌شود.
14
+
15
+ ## نصب
5
16
  ```bash
6
17
  npm install hubchat-react-native react-native-webview
7
18
  cd ios && pod install
8
19
  ```
9
20
 
21
+ ## استفاده
10
22
  ```tsx
11
23
  import { HubChatProvider, useHubChat } from 'hubchat-react-native';
12
24
 
@@ -24,6 +36,7 @@ function SupportButton() {
24
36
  }
25
37
  ```
26
38
 
39
+ ## ویژگی‌ها (props)
27
40
  | prop | توضیح |
28
41
  |---|---|
29
42
  | `widgetKey` | کلید ویجت از پنل (`hc_...`) |
@@ -32,7 +45,10 @@ function SupportButton() {
32
45
  | `onUnreadChange` | تعداد پیام‌های خوانده‌نشده |
33
46
  | `onEvent` | رویدادهای `ready`، `close`، `unread` |
34
47
 
48
+ ## تنظیمات iOS
35
49
  برای آپلود فایل در iOS این کلیدها را به `Info.plist` اضافه کنید: `NSCameraUsageDescription`، `NSPhotoLibraryUsageDescription`، `NSMicrophoneUsageDescription`.
36
50
 
37
- ## نحوه‌ی کار
38
- تنظیمات دکمه از `GET https://widget.hubchat.ir/widget/{key}/config` خوانده و دکمه‌ی شناور به‌صورت نیتیو ساخته می‌شود. خود صفحه‌ی ویجت (`/widget/{key}`)، همان صفحه‌ای که روی سایت در iframe باز می‌شود، در WebView بارگذاری می‌شود؛ پس ظاهر و امکانات پنل دقیقاً مثل سایت است. SDK پیش از بارگذاری صفحه `window.HubChatBridge.postMessage` را تعریف می‌کند و ویجت رویدادهای `ready`، `close` و `unread` را از آن می‌فرستد.
51
+ ## پشتیبانی
52
+ - مستندات: https://hubchat.ir/docs/connect-channel/mobile_sdk
53
+ - گزارش مشکل: بخش Issues همین مخزن
54
+ - وب‌سایت: https://hubchat.ir
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "hubchat-react-native",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "HubChat support chat widget for React Native (iOS & Android)",
5
5
  "main": "src/index.tsx",
6
6
  "types": "src/index.tsx",
package/src/index.tsx CHANGED
@@ -8,7 +8,7 @@ export type { HubChatSettings, HubChatEvent } from './protocol';
8
8
  export type HubChatProps = {
9
9
  /** Widget key from the HubChat panel (hc_...). */
10
10
  widgetKey: string;
11
- /** Override the widget host (self-hosted / staging). */
11
+ /** Custom widget host. Leave empty to use https://widget.hubchat.ir. */
12
12
  baseUrl?: string;
13
13
  /** Show the floating launcher button. Set false to open only via ref / useHubChat(). */
14
14
  showLauncher?: boolean;