@xapp/stentor-chat-widget 1.100.0 → 1.101.0

package/lib/WidgetEnv.d.ts

@@ -258,6 +258,10 @@ export interface WidgetEnv extends WidgetEnvDeprecated {
      * Optional, custom header configuration including messages for the widget.
      */
     readonly header?: WidgetHeaderConfig;
+    /**
+     * Pop the embedded chat out into a floating window when it is scrolled off-screen.
+     */
+    readonly popOut?: WidgetPopOutConfig;
     /**
      * Optional, configure aspects of the footer.
      */
@@ -342,6 +346,44 @@ export interface WidgetUrlPolicy {
     readonly pattern: string;
     readonly behavior: WidgetUrlBehavior;
 }
+/**
+ * Pop the chat out into a floating window while its place on the page is scrolled out of view,
+ * then put it back when the visitor scrolls to it again.
+ *
+ * Only for an embedded (`docked`) widget, and only once there is a conversation worth following
+ * the visitor: an untouched chat stays on the page rather than chasing them down the article.
+ */
+export interface WidgetPopOutConfig {
+    readonly enabled?: boolean;
+    /**
+     * When the chat starts following the visitor.
+     *
+     * - `"seen"` (default): as soon as they scroll past it, whether or not they have chatted.
+     * - `"message"`: only after they have sent a message, so a chat nobody has spoken to stays
+     *   on the page. The assistant's greeting does not count - it arrives before anyone types.
+     *
+     * Either way the chat has to have been on screen once first, so a chat below the fold never
+     * floats in front of someone who has not reached it.
+     */
+    readonly after?: "seen" | "message";
+    /**
+     * Narrowest viewport, in pixels, that opens the floating window. Below this the chat offers
+     * its entry point instead of covering most of a phone screen - see `mobile`.
+     *
+     * @default 640
+     */
+    readonly minWidth?: number;
+    /**
+     * What a visitor below `minWidth` gets once they scroll past the chat. Tapping it opens the
+     * conversation where they left it; closing that returns to this rather than to nothing.
+     *
+     * - `"auto"` (default): the action bar if the app has one, otherwise the chat button.
+     * - `"actionBar"`: the action bar, falling back to the chat button if none is configured.
+     * - `"button"`: the chat button, even where an action bar is configured.
+     * - `"none"`: nothing. The conversation waits where it sits on the page.
+     */
+    readonly mobile?: "auto" | "actionBar" | "button" | "none";
+}
 export interface WidgetHeaderConfig {
     /**
      * Hide the header when the widget is embedded in a page (`docked` or `static` mode),

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "1.100.0",
+    "version": "1.101.0",
     "description": "Chat Widget channel for stentor",
     "types": "lib/index",
     "main": "lib/index",