@mediansh/widget 0.3.0 → 0.6.0

package/dist/index.d.ts

@@ -118,6 +118,22 @@ type MedianSupportOptions = {
      * redeploy, and either side saying no is enough to keep it away.
      */
     requireEmail?: boolean;
+    /**
+     * Show the first lines of an unread reply on the closed button. On by
+     * default: the count says something arrived, and the card is what says
+     * whether it is worth opening.
+     *
+     *   <MedianSupport apiKey="median_pk_..." messagePreview={false} />
+     *
+     * Pass `false` and the corner stays a button with a count on it. Nothing
+     * else changes: the reply is still there, still counted, still announced.
+     * For a page where a customer's words should never appear unprompted,
+     * over somebody's shoulder or in a screen share.
+     *
+     * Your team can turn it off from the dashboard without a redeploy, and
+     * either side saying no is enough to keep the card away.
+     */
+    messagePreview?: boolean;
     /**
      * Watch what goes wrong on the page, so a bug report arrives with the
      * error already attached instead of after four messages of asking.
@@ -161,16 +177,20 @@ type MedianSupportOptions = {
     /** Every open and close, whoever asked for it. */
     onOpenChange?: (open: boolean) => void;
     /**
-     * Take the visitor to a page, when one of your own tools asks for it.
+     * Take the visitor to a page, when one of your own tools offers one.
      *
      *   <MedianSupport apiKey="median_pk_..." onNavigate={router.push} />
      *
+     * A tool that answers with a destination puts a button under the reply
+     * that explains it, and this is what the button does. Nothing moves on its
+     * own: the visitor presses it, or they stay where they are.
+     *
      * Called with a path on your own site, already checked against this page's
      * origin. Your router decides what happens: pass `router.push` and the
      * conversation stays open across the move.
      *
-     * Without it a tool that asks to navigate cannot, and says so in the
-     * console while you are building. Nothing else needs it.
+     * Without it there is nowhere for a press to go, so no button is shown and
+     * the console says so while you are building. Nothing else needs it.
      */
     onNavigate?: (path: string) => void;
 };