@helpway/react 0.10.0 → 0.12.0

package/dist/index.d.ts

@@ -375,6 +375,59 @@ interface MessagePreviewProps {
  */
 declare function MessagePreview({ onOpen, avatar, placement, autoDismissMs, footer, }: MessagePreviewProps): react_jsx_runtime.JSX.Element | null;
 
+/** Placement of the announcement stack — mirrors `MessagePreviewPlacement`. */
+type AnnouncementPreviewsPlacement = "launcher" | "anchored";
+/** Shape of a single announcement entry as it lives in the widget store. */
+interface AnnouncementPreviewEntry {
+    title: string;
+    body: string | null;
+    slug: string;
+    tabId: string;
+    badge: string | null;
+}
+interface AnnouncementPreviewsProps {
+    /** Called when the visitor taps an announcement card. Receives the
+     *  entry's slug + the parent tab id. The consumer decides what to
+     *  do — at minimum `setOpen(true)`, optionally deep-link into the
+     *  matching content tab + detail. */
+    onOpen: (slug: string, tabId: string) => void;
+    /** The avatar node shown in each card's header. Injected so the
+     *  component is decoupled from avatar resolution; pass
+     *  `<WidgetLogo />` for the SDK default. */
+    avatar: ReactNode;
+    /**
+     * Outer positioning mode. `"launcher"` (default) keeps the stack
+     * pinned above the floating bubble; `"anchored"` drops that and
+     * lets the consumer's positioned wrapper place the stack — and
+     * each card stretches to the wrapper width instead of the launcher
+     * 300px (via the same `.hw-preview--anchored` modifier the
+     * message preview uses).
+     */
+    placement?: AnnouncementPreviewsPlacement;
+    /**
+     * Optional caption rendered as a separated footer beneath each
+     * card (e.g. a "via X" provenance line). Omitted on the launcher
+     * so its visual stays byte-identical to the original.
+     */
+    footer?: ReactNode;
+}
+/**
+ * `<AnnouncementPreviews>` — proactive "new content" cards shown when
+ * the widget panel is closed and the visitor hasn't seen the latest
+ * entries from a "Promote new content" tab yet. Stacks multiple
+ * entries vertically.
+ *
+ * Extracted from the default widget so `hideLauncher` integrations can
+ * surface the *exact same* cards next to their own UI instead of the
+ * floating launcher. Visual/markup is byte-identical to the launcher
+ * version — only the outer positioning is parameterised via
+ * `placement`. Announcements never auto-dismiss (visitors need time to
+ * read); they're cleared by tapping the card or the ✕.
+ *
+ * Must be rendered inside `<SupportProvider>`.
+ */
+declare function AnnouncementPreviews({ onOpen, avatar, placement, footer, }: AnnouncementPreviewsProps): react_jsx_runtime.JSX.Element | null;
+
 /**
  * Lightweight Markdown → HTML renderer.
  * Zero dependencies. Handles common patterns:
@@ -403,4 +456,4 @@ declare function MarkdownContent({ bodyHtml, bodyMarkdown, className, }: {
     className?: string;
 }): react_jsx_runtime.JSX.Element | null;
 
-export { Composer, DefaultWidget, type HelpwayPublicAPI, HelpwayWidget, type HelpwayWidgetProps, type IdentifyData, MarkdownContent, MessageBubble, MessageList, MessagePreview, type MessagePreviewPlacement, type MessagePreviewProps, SupportProvider, WidgetLogo, linkifyText, renderMarkdown, useComposer, useConversations, useIdentify, usePresence, useRealtime, useTimeline, useUnread, useWidget, useWidgetStore };
+export { type AnnouncementPreviewEntry, AnnouncementPreviews, type AnnouncementPreviewsPlacement, type AnnouncementPreviewsProps, Composer, DefaultWidget, type HelpwayPublicAPI, HelpwayWidget, type HelpwayWidgetProps, type IdentifyData, MarkdownContent, MessageBubble, MessageList, MessagePreview, type MessagePreviewPlacement, type MessagePreviewProps, SupportProvider, WidgetLogo, linkifyText, renderMarkdown, useComposer, useConversations, useIdentify, usePresence, useRealtime, useTimeline, useUnread, useWidget, useWidgetStore };