@paramms/chat-widget 1.0.39 → 1.0.40

package/README.md

@@ -191,6 +191,40 @@ const signedToken = `${hdr}.${pay}.${sig}`
 />
 ```
 
+### Launcher message (the teaser card)
+
+An optional card shown **above the closed bubble** to invite a conversation.
+Visitors can dismiss it with the ×; it stays dismissed for the browser session
+and retires automatically once the chat is opened.
+
+```tsx
+<ChatWidget
+  url="https://api.relay.paramms.com"
+  profileId="YOUR_PROFILE_ID"
+  launcher
+  launcherMessage={{ title: 'Questions? Chat with us', subtitle: 'Start a conversation' }}
+/>
+```
+
+A bare string works too (title only): `launcherMessage="Need help?"`.
+
+**You usually don't need this prop.** Set the message once per chatroom in the
+dashboard (*Chatrooms → your chatroom → Widget message & availability*) and it
+arrives automatically over the socket. Pass `launcherMessage` only to override
+the dashboard value for one embed (it also renders instantly, before the
+socket connects).
+
+Script-tag embeds use data attributes:
+
+```html
+<script
+  src="https://relay.paramms.com/embed.js"
+  data-relay-app="YOUR_PROFILE_ID"
+  data-relay-launcher-message="Questions? Chat with us"
+  data-relay-launcher-subtitle="Start a conversation"
+></script>
+```
+
 ## Internationalisation
 
 ```tsx
@@ -222,6 +256,7 @@ RTL is detected automatically for Arabic, Hebrew, Persian and Urdu browsers.
 | `accent` | `string` | `#f5713c` | Brand colour (hex) |
 | `launcher` | `boolean` | `false` | Render as floating button |
 | `position` | `'bottom-right' \| 'bottom-left'` | `'bottom-right'` | Launcher position |
+| `launcherMessage` | `string \| { title, subtitle? }` | chatroom setting | Teaser card above the closed launcher. Overrides the dashboard's per-chatroom message; dismissible per session |
 | `translateLang` | `string` | — | Auto-translate incoming messages (ISO language code) |
 | `quickReplies` | `string[]` | — | Pre-set reply chips shown above input |
 | `i18n` | `I18nStrings` | English | UI string overrides |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paramms/chat-widget",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "Embeddable real-time chat widget for the Relay platform",
   "license": "MIT",
   "repository": {