@yext/chat-ui-react 0.8.5 → 0.8.6

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 (46) hide show
  1. package/lib/bundle.css +1 -1
  2. package/lib/commonjs/package.json.js +1 -1
  3. package/lib/commonjs/src/components/ChatInput.d.ts +3 -1
  4. package/lib/commonjs/src/components/ChatInput.d.ts.map +1 -1
  5. package/lib/commonjs/src/components/ChatInput.js +5 -3
  6. package/lib/commonjs/src/components/ChatInput.js.map +1 -1
  7. package/lib/commonjs/src/components/ChatPanel.d.ts +3 -0
  8. package/lib/commonjs/src/components/ChatPanel.d.ts.map +1 -1
  9. package/lib/commonjs/src/components/ChatPanel.js +9 -2
  10. package/lib/commonjs/src/components/ChatPanel.js.map +1 -1
  11. package/lib/commonjs/src/components/ChatPopUp.d.ts.map +1 -1
  12. package/lib/commonjs/src/components/ChatPopUp.js +5 -3
  13. package/lib/commonjs/src/components/ChatPopUp.js.map +1 -1
  14. package/lib/commonjs/src/components/Markdown.d.ts +17 -3
  15. package/lib/commonjs/src/components/Markdown.d.ts.map +1 -1
  16. package/lib/commonjs/src/components/Markdown.js +10 -5
  17. package/lib/commonjs/src/components/Markdown.js.map +1 -1
  18. package/lib/commonjs/src/components/MessageBubble.d.ts.map +1 -1
  19. package/lib/commonjs/src/components/MessageBubble.js +4 -1
  20. package/lib/commonjs/src/components/MessageBubble.js.map +1 -1
  21. package/lib/esm/index.d.ts +6 -1
  22. package/lib/esm/package.json.mjs +1 -1
  23. package/lib/esm/src/components/ChatInput.d.ts +3 -1
  24. package/lib/esm/src/components/ChatInput.d.ts.map +1 -1
  25. package/lib/esm/src/components/ChatInput.mjs +5 -3
  26. package/lib/esm/src/components/ChatInput.mjs.map +1 -1
  27. package/lib/esm/src/components/ChatPanel.d.ts +3 -0
  28. package/lib/esm/src/components/ChatPanel.d.ts.map +1 -1
  29. package/lib/esm/src/components/ChatPanel.mjs +9 -2
  30. package/lib/esm/src/components/ChatPanel.mjs.map +1 -1
  31. package/lib/esm/src/components/ChatPopUp.d.ts.map +1 -1
  32. package/lib/esm/src/components/ChatPopUp.mjs +5 -3
  33. package/lib/esm/src/components/ChatPopUp.mjs.map +1 -1
  34. package/lib/esm/src/components/Markdown.d.ts +17 -3
  35. package/lib/esm/src/components/Markdown.d.ts.map +1 -1
  36. package/lib/esm/src/components/Markdown.mjs +10 -5
  37. package/lib/esm/src/components/Markdown.mjs.map +1 -1
  38. package/lib/esm/src/components/MessageBubble.d.ts.map +1 -1
  39. package/lib/esm/src/components/MessageBubble.mjs +5 -2
  40. package/lib/esm/src/components/MessageBubble.mjs.map +1 -1
  41. package/package.json +1 -1
  42. package/src/components/ChatInput.tsx +7 -2
  43. package/src/components/ChatPanel.tsx +28 -2
  44. package/src/components/ChatPopUp.tsx +5 -1
  45. package/src/components/Markdown.tsx +33 -7
  46. package/src/components/MessageBubble.tsx +10 -3
@@ -1 +1 @@
1
- {"version":3,"file":"MessageBubble.mjs","sources":["../../../../src/components/MessageBubble.tsx"],"sourcesContent":["import React from \"react\";\nimport { Message, MessageSource } from \"@yext/chat-headless-react\";\nimport { useComposedCssClasses } from \"../hooks\";\nimport { twMerge } from \"tailwind-merge\";\nimport { Markdown } from \"./Markdown\";\nimport { withStylelessCssClasses } from \"../utils/withStylelessCssClasses\";\nimport { FeedbackButtons, FeedbackButtonsCssClasses } from \"./FeedbackButtons\";\n\n/**\n * The CSS class interface for the {@link MessageBubble} component.\n *\n * @public\n */\nexport interface MessageBubbleCssClasses {\n topContainer?: string;\n subContainer?: string;\n subContainer__bot?: string;\n subContainer__user?: string;\n bubble?: string;\n bubble__bot?: string;\n bubble__user?: string;\n text?: string;\n text__bot?: string;\n text__user?: string;\n timestamp?: string;\n timestamp__bot?: string;\n timestamp__user?: string;\n feedbackButtonsCssClasses?: FeedbackButtonsCssClasses;\n}\n\nconst builtInCssClasses: MessageBubbleCssClasses =\n withStylelessCssClasses<MessageBubbleCssClasses>(\"MessageBubble\", {\n topContainer: \"w-full animate-fade-in @container\",\n subContainer:\n \"flex flex-col @lg:flex-row @lg:items-center @lg:gap-x-2 @lg:m-1\",\n subContainer__bot: \"\",\n subContainer__user: \"@lg:flex-row-reverse\",\n bubble: \"relative group peer w-fit max-w-[80%] rounded-2xl p-4\",\n bubble__bot: \"bg-gradient-to-tr from-slate-50 to-slate-100\",\n bubble__user:\n \"ml-auto @lg:ml-0 bg-gradient-to-tr from-blue-600 to-blue-700 text-white\",\n text: \"text-[13px] @[480px]:text-base prose overflow-x-auto\",\n text__bot: \"text-slate-900\",\n text__user: \"text-white break-words\",\n timestamp:\n \"w-fit my-0.5 ml-4 @lg:ml-0 text-slate-400 text-[10px] @[480px]:text-[13px] opacity-0 peer-hover:opacity-100 duration-200 whitespace-pre-wrap\",\n timestamp__bot: \"\",\n timestamp__user: \"ml-auto\",\n feedbackButtonsCssClasses: {},\n });\n\n/**\n * The props for the {@link MessageBubble} component.\n *\n * @public\n */\nexport interface MessageBubbleProps {\n /** The message to display. */\n message: Message;\n /**\n * Whether to show the feedback buttons on the message bubble.\n * Defaults to true.\n */\n showFeedbackButtons?: boolean;\n /**\n * Whether to show the timestamp of the message with the message bubble.\n * Defaults to true.\n */\n showTimestamp?: boolean;\n /**\n * A function which is called to format the message's timestamp given in\n * ISO format (e.g. \"2023-05-18T19:33:34.553Z\").\n * Defaults to \"HH:MM A\" (e.g. \"7:33 PM\").\n */\n formatTimestamp?: (timestamp: string) => string;\n /** CSS classes for customizing the component styling. */\n customCssClasses?: MessageBubbleCssClasses;\n}\n\n/**\n * A component that displays the provided message.\n *\n * @public\n *\n * @param props - {@link MessageBubbleProps}\n */\nexport function MessageBubble({\n message,\n showFeedbackButtons = true,\n showTimestamp = true,\n customCssClasses,\n formatTimestamp = defaultFormatTimestamp,\n}: MessageBubbleProps) {\n const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);\n const bubbleCssClasses = twMerge(\n cssClasses.bubble,\n message.source === MessageSource.USER\n ? cssClasses.bubble__user\n : cssClasses.bubble__bot\n );\n const textCssClasses = twMerge(\n cssClasses.text,\n message.source === MessageSource.USER\n ? cssClasses.text__user\n : cssClasses.text__bot\n );\n const subContainerCssClasses = twMerge(\n cssClasses.subContainer,\n message.source === MessageSource.USER\n ? cssClasses.subContainer__user\n : cssClasses.subContainer__bot\n );\n const timestampCssClasses = twMerge(\n cssClasses.timestamp,\n message.source === MessageSource.USER\n ? cssClasses.timestamp__user\n : cssClasses.timestamp__bot\n );\n\n return (\n <div className={cssClasses.topContainer}>\n <div className={subContainerCssClasses}>\n <div className={bubbleCssClasses}>\n {showFeedbackButtons && message.source === MessageSource.BOT && (\n <FeedbackButtons\n customCssClasses={cssClasses.feedbackButtonsCssClasses}\n responseId={message.responseId}\n />\n )}\n <Markdown\n content={message.text}\n responseId={message.responseId}\n className={textCssClasses}\n />\n </div>\n {/* fallback on empty space here to perserve the height for timestamp div */}\n {showTimestamp && (\n <div className={timestampCssClasses}>\n {message.timestamp ? formatTimestamp(message.timestamp) : \" \"}\n </div>\n )}\n </div>\n </div>\n );\n}\n\n/**\n * Formats message's timestamp from \"2023-05-18T19:33:34.553Z\" to \"7:33 PM\"\n *\n * @param timestamp - the timestamp to convert from\n * @returns formatted timestamp\n */\nfunction defaultFormatTimestamp(timestamp: string): string {\n return new Date(timestamp).toLocaleString(undefined, {\n hour: \"numeric\",\n minute: \"numeric\",\n hour12: true,\n });\n}\n"],"names":[],"mappings":";;;;;;;;AA8BA,MAAM,iBAAiB,GACrB,uBAAuB,CAA0B,eAAe,EAAE;AAChE,IAAA,YAAY,EAAE,mCAAmC;AACjD,IAAA,YAAY,EACV,iEAAiE;AACnE,IAAA,iBAAiB,EAAE,EAAE;AACrB,IAAA,kBAAkB,EAAE,sBAAsB;AAC1C,IAAA,MAAM,EAAE,uDAAuD;AAC/D,IAAA,WAAW,EAAE,8CAA8C;AAC3D,IAAA,YAAY,EACV,yEAAyE;AAC3E,IAAA,IAAI,EAAE,sDAAsD;AAC5D,IAAA,SAAS,EAAE,gBAAgB;AAC3B,IAAA,UAAU,EAAE,wBAAwB;AACpC,IAAA,SAAS,EACP,8IAA8I;AAChJ,IAAA,cAAc,EAAE,EAAE;AAClB,IAAA,eAAe,EAAE,SAAS;AAC1B,IAAA,yBAAyB,EAAE,EAAE;AAC9B,CAAA,CAAC,CAAC;AA8BL;;;;;;AAMG;SACa,aAAa,CAAC,EAC5B,OAAO,EACP,mBAAmB,GAAG,IAAI,EAC1B,aAAa,GAAG,IAAI,EACpB,gBAAgB,EAChB,eAAe,GAAG,sBAAsB,GACrB,EAAA;IACnB,MAAM,UAAU,GAAG,qBAAqB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;AAC9E,IAAA,MAAM,gBAAgB,GAAG,OAAO,CAC9B,UAAU,CAAC,MAAM,EACjB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,YAAY;AACzB,UAAE,UAAU,CAAC,WAAW,CAC3B,CAAC;AACF,IAAA,MAAM,cAAc,GAAG,OAAO,CAC5B,UAAU,CAAC,IAAI,EACf,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,UAAU;AACvB,UAAE,UAAU,CAAC,SAAS,CACzB,CAAC;AACF,IAAA,MAAM,sBAAsB,GAAG,OAAO,CACpC,UAAU,CAAC,YAAY,EACvB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,kBAAkB;AAC/B,UAAE,UAAU,CAAC,iBAAiB,CACjC,CAAC;AACF,IAAA,MAAM,mBAAmB,GAAG,OAAO,CACjC,UAAU,CAAC,SAAS,EACpB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,eAAe;AAC5B,UAAE,UAAU,CAAC,cAAc,CAC9B,CAAC;AAEF,IAAA,QACE,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,UAAU,CAAC,YAAY,EAAA;QACrC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,sBAAsB,EAAA;YACpC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,gBAAgB,EAAA;gBAC7B,mBAAmB,IAAI,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,GAAG,KAC1D,KAAC,CAAA,aAAA,CAAA,eAAe,IACd,gBAAgB,EAAE,UAAU,CAAC,yBAAyB,EACtD,UAAU,EAAE,OAAO,CAAC,UAAU,EAAA,CAC9B,CACH;AACD,gBAAA,KAAA,CAAA,aAAA,CAAC,QAAQ,EACP,EAAA,OAAO,EAAE,OAAO,CAAC,IAAI,EACrB,UAAU,EAAE,OAAO,CAAC,UAAU,EAC9B,SAAS,EAAE,cAAc,GACzB,CACE;AAEL,YAAA,aAAa,KACZ,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,mBAAmB,EAChC,EAAA,OAAO,CAAC,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,GAAG,CACzD,CACP,CACG,CACF,EACN;AACJ,CAAC;AAED;;;;;AAKG;AACH,SAAS,sBAAsB,CAAC,SAAiB,EAAA;IAC/C,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE;AACnD,QAAA,IAAI,EAAE,SAAS;AACf,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,MAAM,EAAE,IAAI;AACb,KAAA,CAAC,CAAC;AACL;;;;"}
1
+ {"version":3,"file":"MessageBubble.mjs","sources":["../../../../src/components/MessageBubble.tsx"],"sourcesContent":["import React, { useMemo } from \"react\";\nimport { Message, MessageSource } from \"@yext/chat-headless-react\";\nimport { useComposedCssClasses } from \"../hooks\";\nimport { twMerge } from \"tailwind-merge\";\nimport { Markdown, MarkdownCssClasses } from \"./Markdown\";\nimport { withStylelessCssClasses } from \"../utils/withStylelessCssClasses\";\nimport { FeedbackButtons, FeedbackButtonsCssClasses } from \"./FeedbackButtons\";\n\n/**\n * The CSS class interface for the {@link MessageBubble} component.\n *\n * @public\n */\nexport interface MessageBubbleCssClasses {\n topContainer?: string;\n subContainer?: string;\n subContainer__bot?: string;\n subContainer__user?: string;\n bubble?: string;\n bubble__bot?: string;\n bubble__user?: string;\n text?: string;\n text__bot?: string;\n text__user?: string;\n timestamp?: string;\n timestamp__bot?: string;\n timestamp__user?: string;\n feedbackButtonsCssClasses?: FeedbackButtonsCssClasses;\n}\n\nconst builtInCssClasses: MessageBubbleCssClasses =\n withStylelessCssClasses<MessageBubbleCssClasses>(\"MessageBubble\", {\n topContainer: \"w-full animate-fade-in @container\",\n subContainer:\n \"flex flex-col @lg:flex-row @lg:items-center @lg:gap-x-2 @lg:m-1\",\n subContainer__bot: \"\",\n subContainer__user: \"@lg:flex-row-reverse\",\n bubble: \"relative group peer w-fit max-w-[80%] rounded-2xl p-4\",\n bubble__bot: \"bg-gradient-to-tr from-slate-50 to-slate-100\",\n bubble__user:\n \"ml-auto @lg:ml-0 bg-gradient-to-tr from-blue-600 to-blue-700 text-white\",\n text: \"text-[13px] @[480px]:text-base prose overflow-x-auto\",\n text__bot: \"text-slate-900\",\n text__user: \"text-white break-words\",\n timestamp:\n \"w-fit my-0.5 ml-4 @lg:ml-0 text-slate-400 text-[10px] @[480px]:text-[13px] opacity-0 peer-hover:opacity-100 duration-200 whitespace-pre-wrap\",\n timestamp__bot: \"\",\n timestamp__user: \"ml-auto\",\n feedbackButtonsCssClasses: {},\n });\n\n/**\n * The props for the {@link MessageBubble} component.\n *\n * @public\n */\nexport interface MessageBubbleProps {\n /** The message to display. */\n message: Message;\n /**\n * Whether to show the feedback buttons on the message bubble.\n * Defaults to true.\n */\n showFeedbackButtons?: boolean;\n /**\n * Whether to show the timestamp of the message with the message bubble.\n * Defaults to true.\n */\n showTimestamp?: boolean;\n /**\n * A function which is called to format the message's timestamp given in\n * ISO format (e.g. \"2023-05-18T19:33:34.553Z\").\n * Defaults to \"HH:MM A\" (e.g. \"7:33 PM\").\n */\n formatTimestamp?: (timestamp: string) => string;\n /** CSS classes for customizing the component styling. */\n customCssClasses?: MessageBubbleCssClasses;\n}\n\n/**\n * A component that displays the provided message.\n *\n * @public\n *\n * @param props - {@link MessageBubbleProps}\n */\nexport function MessageBubble({\n message,\n showFeedbackButtons = true,\n showTimestamp = true,\n customCssClasses,\n formatTimestamp = defaultFormatTimestamp,\n}: MessageBubbleProps) {\n const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);\n const bubbleCssClasses = twMerge(\n cssClasses.bubble,\n message.source === MessageSource.USER\n ? cssClasses.bubble__user\n : cssClasses.bubble__bot\n );\n const textCssClasses = twMerge(\n cssClasses.text,\n message.source === MessageSource.USER\n ? cssClasses.text__user\n : cssClasses.text__bot\n );\n const subContainerCssClasses = twMerge(\n cssClasses.subContainer,\n message.source === MessageSource.USER\n ? cssClasses.subContainer__user\n : cssClasses.subContainer__bot\n );\n const timestampCssClasses = twMerge(\n cssClasses.timestamp,\n message.source === MessageSource.USER\n ? cssClasses.timestamp__user\n : cssClasses.timestamp__bot\n );\n\n const markdownCssClasses: MarkdownCssClasses = useMemo(\n () => ({\n container: textCssClasses,\n }),\n [textCssClasses]\n );\n\n return (\n <div className={cssClasses.topContainer}>\n <div className={subContainerCssClasses}>\n <div className={bubbleCssClasses}>\n {showFeedbackButtons && message.source === MessageSource.BOT && (\n <FeedbackButtons\n customCssClasses={cssClasses.feedbackButtonsCssClasses}\n responseId={message.responseId}\n />\n )}\n <Markdown\n content={message.text}\n responseId={message.responseId}\n customCssClasses={markdownCssClasses}\n />\n </div>\n {/* fallback on empty space here to perserve the height for timestamp div */}\n {showTimestamp && (\n <div className={timestampCssClasses}>\n {message.timestamp ? formatTimestamp(message.timestamp) : \" \"}\n </div>\n )}\n </div>\n </div>\n );\n}\n\n/**\n * Formats message's timestamp from \"2023-05-18T19:33:34.553Z\" to \"7:33 PM\"\n *\n * @param timestamp - the timestamp to convert from\n * @returns formatted timestamp\n */\nfunction defaultFormatTimestamp(timestamp: string): string {\n return new Date(timestamp).toLocaleString(undefined, {\n hour: \"numeric\",\n minute: \"numeric\",\n hour12: true,\n });\n}\n"],"names":[],"mappings":";;;;;;;;AA8BA,MAAM,iBAAiB,GACrB,uBAAuB,CAA0B,eAAe,EAAE;AAChE,IAAA,YAAY,EAAE,mCAAmC;AACjD,IAAA,YAAY,EACV,iEAAiE;AACnE,IAAA,iBAAiB,EAAE,EAAE;AACrB,IAAA,kBAAkB,EAAE,sBAAsB;AAC1C,IAAA,MAAM,EAAE,uDAAuD;AAC/D,IAAA,WAAW,EAAE,8CAA8C;AAC3D,IAAA,YAAY,EACV,yEAAyE;AAC3E,IAAA,IAAI,EAAE,sDAAsD;AAC5D,IAAA,SAAS,EAAE,gBAAgB;AAC3B,IAAA,UAAU,EAAE,wBAAwB;AACpC,IAAA,SAAS,EACP,8IAA8I;AAChJ,IAAA,cAAc,EAAE,EAAE;AAClB,IAAA,eAAe,EAAE,SAAS;AAC1B,IAAA,yBAAyB,EAAE,EAAE;AAC9B,CAAA,CAAC,CAAC;AA8BL;;;;;;AAMG;SACa,aAAa,CAAC,EAC5B,OAAO,EACP,mBAAmB,GAAG,IAAI,EAC1B,aAAa,GAAG,IAAI,EACpB,gBAAgB,EAChB,eAAe,GAAG,sBAAsB,GACrB,EAAA;IACnB,MAAM,UAAU,GAAG,qBAAqB,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;AAC9E,IAAA,MAAM,gBAAgB,GAAG,OAAO,CAC9B,UAAU,CAAC,MAAM,EACjB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,YAAY;AACzB,UAAE,UAAU,CAAC,WAAW,CAC3B,CAAC;AACF,IAAA,MAAM,cAAc,GAAG,OAAO,CAC5B,UAAU,CAAC,IAAI,EACf,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,UAAU;AACvB,UAAE,UAAU,CAAC,SAAS,CACzB,CAAC;AACF,IAAA,MAAM,sBAAsB,GAAG,OAAO,CACpC,UAAU,CAAC,YAAY,EACvB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,kBAAkB;AAC/B,UAAE,UAAU,CAAC,iBAAiB,CACjC,CAAC;AACF,IAAA,MAAM,mBAAmB,GAAG,OAAO,CACjC,UAAU,CAAC,SAAS,EACpB,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI;UACjC,UAAU,CAAC,eAAe;AAC5B,UAAE,UAAU,CAAC,cAAc,CAC9B,CAAC;AAEF,IAAA,MAAM,kBAAkB,GAAuB,OAAO,CACpD,OAAO;AACL,QAAA,SAAS,EAAE,cAAc;AAC1B,KAAA,CAAC,EACF,CAAC,cAAc,CAAC,CACjB,CAAC;AAEF,IAAA,QACE,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,UAAU,CAAC,YAAY,EAAA;QACrC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,sBAAsB,EAAA;YACpC,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,gBAAgB,EAAA;gBAC7B,mBAAmB,IAAI,OAAO,CAAC,MAAM,KAAK,aAAa,CAAC,GAAG,KAC1D,KAAC,CAAA,aAAA,CAAA,eAAe,IACd,gBAAgB,EAAE,UAAU,CAAC,yBAAyB,EACtD,UAAU,EAAE,OAAO,CAAC,UAAU,EAAA,CAC9B,CACH;AACD,gBAAA,KAAA,CAAA,aAAA,CAAC,QAAQ,EACP,EAAA,OAAO,EAAE,OAAO,CAAC,IAAI,EACrB,UAAU,EAAE,OAAO,CAAC,UAAU,EAC9B,gBAAgB,EAAE,kBAAkB,GACpC,CACE;AAEL,YAAA,aAAa,KACZ,KAAK,CAAA,aAAA,CAAA,KAAA,EAAA,EAAA,SAAS,EAAE,mBAAmB,EAChC,EAAA,OAAO,CAAC,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,GAAG,CACzD,CACP,CACG,CACF,EACN;AACJ,CAAC;AAED;;;;;AAKG;AACH,SAAS,sBAAsB,CAAC,SAAiB,EAAA;IAC/C,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE;AACnD,QAAA,IAAI,EAAE,SAAS;AACf,QAAA,MAAM,EAAE,SAAS;AACjB,QAAA,MAAM,EAAE,IAAI;AACb,KAAA,CAAC,CAAC;AACL;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yext/chat-ui-react",
3
- "version": "0.8.5",
3
+ "version": "0.8.6",
4
4
  "description": "A library of React Components for powering Yext Chat integrations.",
5
5
  "author": "clippy@yext.com",
6
6
  "main": "./lib/commonjs/src/index.js",
@@ -56,6 +56,8 @@ export interface ChatInputProps {
56
56
  sendButtonIcon?: JSX.Element;
57
57
  /** CSS classes for customizing the component styling. */
58
58
  customCssClasses?: ChatInputCssClasses;
59
+ /** A callback which is called when user sends a message. */
60
+ onSend?: (message: string) => void;
59
61
  }
60
62
 
61
63
  /**
@@ -76,6 +78,7 @@ export function ChatInput({
76
78
  handleError,
77
79
  sendButtonIcon = <ArrowIcon />,
78
80
  customCssClasses,
81
+ onSend,
79
82
  }: ChatInputProps) {
80
83
  const chat = useChatActions();
81
84
  const [input, setInput] = useState("");
@@ -91,8 +94,10 @@ export function ChatInput({
91
94
  ? chat.streamNextMessage(input)
92
95
  : chat.getNextMessage(input);
93
96
  setInput("");
94
- res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
95
- }, [chat, input, handleError, defaultHandleApiError, stream]);
97
+ res.then(() => {
98
+ onSend?.(input)
99
+ }).catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
100
+ }, [chat, input, handleError, defaultHandleApiError, stream, onSend]);
96
101
 
97
102
  const handleKeyDown = useCallback(
98
103
  (e: React.KeyboardEvent<HTMLTextAreaElement>) => {
@@ -21,6 +21,7 @@ import {
21
21
  MessageSuggestionCssClasses,
22
22
  MessageSuggestions,
23
23
  } from "./MessageSuggestions";
24
+ import { Markdown, MarkdownCssClasses } from "./Markdown";
24
25
 
25
26
  /**
26
27
  * The CSS class interface for the {@link ChatPanel} component.
@@ -35,6 +36,7 @@ export interface ChatPanelCssClasses {
35
36
  inputCssClasses?: ChatInputCssClasses;
36
37
  messageBubbleCssClasses?: MessageBubbleCssClasses;
37
38
  messageSuggestionClasses?: MessageSuggestionCssClasses;
39
+ footer?: string;
38
40
  }
39
41
 
40
42
  const builtInCssClasses: ChatPanelCssClasses = withStylelessCssClasses(
@@ -47,6 +49,7 @@ const builtInCssClasses: ChatPanelCssClasses = withStylelessCssClasses(
47
49
  messageBubbleCssClasses: {
48
50
  topContainer: "first:mt-4",
49
51
  },
52
+ footer: "text-center text-slate-400 rounded-b-3xl px-4 pb-4 text-[12px]",
50
53
  }
51
54
  );
52
55
 
@@ -60,6 +63,8 @@ export interface ChatPanelProps
60
63
  Omit<ChatInputProps, "customCssClasses"> {
61
64
  /** A header to render at the top of the panel. */
62
65
  header?: ReactNode;
66
+ /** A footer markdown string to render at the bottom of the panel. */
67
+ footer?: string;
63
68
  /**
64
69
  * CSS classes for customizing the component styling.
65
70
  */
@@ -81,8 +86,14 @@ export interface ChatPanelProps
81
86
  * @param props - {@link ChatPanelProps}
82
87
  */
83
88
  export function ChatPanel(props: ChatPanelProps) {
84
- const { header, customCssClasses, stream, handleError, messageSuggestions } =
85
- props;
89
+ const {
90
+ header,
91
+ footer,
92
+ customCssClasses,
93
+ stream,
94
+ handleError,
95
+ messageSuggestions,
96
+ } = props;
86
97
  const messages = useChatState((state) => state.conversation.messages);
87
98
  const loading = useChatState((state) => state.conversation.isLoading);
88
99
  const suggestedReplies = useChatState(
@@ -136,6 +147,14 @@ export function ChatPanel(props: ChatPanelProps) {
136
147
  return (message) => (messagesRef.current[index] = message);
137
148
  }, []);
138
149
 
150
+ const footerCssClasses: MarkdownCssClasses = useMemo(
151
+ () => ({
152
+ container: cssClasses.footer,
153
+ link: "cursor-pointer hover:underline text-blue-600",
154
+ }),
155
+ [cssClasses]
156
+ );
157
+
139
158
  return (
140
159
  <div className="yext-chat w-full h-full">
141
160
  <div className={cssClasses.container}>
@@ -163,6 +182,13 @@ export function ChatPanel(props: ChatPanelProps) {
163
182
  )}
164
183
  <ChatInput {...props} customCssClasses={cssClasses.inputCssClasses} />
165
184
  </div>
185
+ {footer && (
186
+ <Markdown
187
+ content={footer}
188
+ linkClickEvent="WEBSITE"
189
+ customCssClasses={footerCssClasses}
190
+ />
191
+ )}
166
192
  </div>
167
193
  </div>
168
194
  );
@@ -133,6 +133,7 @@ export function ChatPopUp(props: ChatPopUpProps) {
133
133
  showUnreadNotification = false,
134
134
  ctaLabel,
135
135
  title,
136
+ footer,
136
137
  } = props;
137
138
 
138
139
  const reportAnalyticsEvent = useReportAnalyticsEvent();
@@ -224,6 +225,7 @@ export function ChatPopUp(props: ChatPopUpProps) {
224
225
  customCssClasses={cssClasses.headerCssClasses}
225
226
  />
226
227
  }
228
+ footer={footer}
227
229
  />
228
230
  )}
229
231
  </div>
@@ -254,7 +256,9 @@ export function ChatPopUp(props: ChatPopUpProps) {
254
256
  onClick={onClick}
255
257
  className={
256
258
  cssClasses.button +
257
- (showHeartBeatAnimation && !!numUnreadMessages ? " animate-heartbeat" : "")
259
+ (showHeartBeatAnimation && !!numUnreadMessages
260
+ ? " animate-heartbeat"
261
+ : "")
258
262
  }
259
263
  >
260
264
  {openPanelButtonIcon ?? (
@@ -7,6 +7,7 @@ import rehypeRaw from "rehype-raw";
7
7
  import rehypeSanitize from "rehype-sanitize";
8
8
  import React, { useMemo } from "react";
9
9
  import { useReportAnalyticsEvent } from "../hooks/useReportAnalyticsEvent";
10
+ import { useComposedCssClasses } from "../hooks/useComposedCssClasses";
10
11
 
11
12
  // The Remark and Rehype plugins to use in conjunction with ReactMarkdown.
12
13
  const unifiedPlugins: { remark?: PluggableList; rehype: PluggableList } = {
@@ -19,13 +20,32 @@ const unifiedPlugins: { remark?: PluggableList; rehype: PluggableList } = {
19
20
  ],
20
21
  };
21
22
 
23
+ /**
24
+ * The CSS class interface for the Markdown component.
25
+ *
26
+ * @internal
27
+ */
28
+ export interface MarkdownCssClasses {
29
+ container?: string;
30
+ link?: string;
31
+ }
32
+
33
+ const builtInCssClasses: MarkdownCssClasses = {
34
+ link: "cursor-pointer",
35
+ };
36
+
22
37
  interface MarkdownProps {
23
38
  /** Stringified markdown. */
24
39
  content: string;
25
40
  /** The response ID correlates to the current message. */
26
41
  responseId?: string;
27
- /** Classnames for the container. */
28
- className?: string;
42
+ /** CSS classes for customizing the component styling. */
43
+ customCssClasses?: MarkdownCssClasses;
44
+ /**
45
+ * Action to report for analytics event when a link is clicked.
46
+ * Defaults to 'CHAT_LINK_CLICK'.
47
+ */
48
+ linkClickEvent?: "WEBSITE" | "CHAT_LINK_CLICK";
29
49
  }
30
50
 
31
51
  /**
@@ -37,13 +57,19 @@ interface MarkdownProps {
37
57
  *
38
58
  * @internal
39
59
  */
40
- export function Markdown({ content, responseId, className }: MarkdownProps) {
60
+ export function Markdown({
61
+ content,
62
+ responseId,
63
+ customCssClasses,
64
+ linkClickEvent = "CHAT_LINK_CLICK",
65
+ }: MarkdownProps) {
41
66
  const reportAnalyticsEvent = useReportAnalyticsEvent();
67
+ const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
42
68
 
43
69
  const components: ReactMarkdownOptions["components"] = useMemo(() => {
44
70
  const createClickHandlerFn = (href?: string) => () => {
45
71
  reportAnalyticsEvent({
46
- action: "CHAT_LINK_CLICK",
72
+ action: linkClickEvent,
47
73
  destinationUrl: href,
48
74
  chat: {
49
75
  responseId,
@@ -58,18 +84,18 @@ export function Markdown({ content, responseId, className }: MarkdownProps) {
58
84
  onClick={createClickHandlerFn(props.href)}
59
85
  target="_blank"
60
86
  rel="noopener noreferrer"
61
- className="cursor-pointer"
87
+ className={cssClasses.link}
62
88
  >
63
89
  {children}
64
90
  </a>
65
91
  );
66
92
  },
67
93
  };
68
- }, [reportAnalyticsEvent, responseId]);
94
+ }, [reportAnalyticsEvent, linkClickEvent, responseId, cssClasses]);
69
95
 
70
96
  return (
71
97
  <ReactMarkdown
72
- className={className}
98
+ className={cssClasses.container}
73
99
  children={content}
74
100
  remarkPlugins={unifiedPlugins.remark}
75
101
  rehypePlugins={unifiedPlugins.rehype}
@@ -1,8 +1,8 @@
1
- import React from "react";
1
+ import React, { useMemo } from "react";
2
2
  import { Message, MessageSource } from "@yext/chat-headless-react";
3
3
  import { useComposedCssClasses } from "../hooks";
4
4
  import { twMerge } from "tailwind-merge";
5
- import { Markdown } from "./Markdown";
5
+ import { Markdown, MarkdownCssClasses } from "./Markdown";
6
6
  import { withStylelessCssClasses } from "../utils/withStylelessCssClasses";
7
7
  import { FeedbackButtons, FeedbackButtonsCssClasses } from "./FeedbackButtons";
8
8
 
@@ -117,6 +117,13 @@ export function MessageBubble({
117
117
  : cssClasses.timestamp__bot
118
118
  );
119
119
 
120
+ const markdownCssClasses: MarkdownCssClasses = useMemo(
121
+ () => ({
122
+ container: textCssClasses,
123
+ }),
124
+ [textCssClasses]
125
+ );
126
+
120
127
  return (
121
128
  <div className={cssClasses.topContainer}>
122
129
  <div className={subContainerCssClasses}>
@@ -130,7 +137,7 @@ export function MessageBubble({
130
137
  <Markdown
131
138
  content={message.text}
132
139
  responseId={message.responseId}
133
- className={textCssClasses}
140
+ customCssClasses={markdownCssClasses}
134
141
  />
135
142
  </div>
136
143
  {/* fallback on empty space here to perserve the height for timestamp div */}