@yext/chat-ui-react 0.1.0

package/src/components/ChatPanel.tsx

@@ -0,0 +1,108 @@
+import { useEffect, useRef } from "react";
+import { useChatState, useChatActions } from "@yext/chat-headless-react";
+import {
+  MessageBubble,
+  MessageBubbleCssClasses,
+  MessageBubbleProps,
+} from "./MessageBubble";
+import { ChatInput, ChatInputCssClasses, ChatInputProps } from "./ChatInput";
+import { LoadingDots } from "./LoadingDots";
+import { useComposedCssClasses } from "../hooks";
+import { defaultHandleApiError } from "../utils/defaultHandleError";
+
+/**
+ * The CSS class interface for the {@link ChatPanel} component.
+ *
+ * @public
+ */
+export interface ChatPanelCssClasses {
+  container?: string;
+  messagesContainer?: string;
+  inputContainer?: string;
+  inputCssClasses?: ChatInputCssClasses;
+  messageBubbleCssClasses?: MessageBubbleCssClasses;
+}
+
+const builtInCssClasses: ChatPanelCssClasses = {
+  container:
+    "h-full w-full flex flex-col relative rounded-3xl shadow-2xl bg-white",
+  messagesContainer:
+    "flex flex-col gap-y-1 mt-auto px-4 pb-[85px] overflow-auto",
+  inputContainer: "w-full absolute bottom-0 p-4 rounded-b-3xl backdrop-blur-lg",
+};
+
+/**
+ * The props for the {@link ChatPanel} component.
+ *
+ * @public
+ */
+export interface ChatPanelProps
+  extends Omit<MessageBubbleProps, "customCssClasses" | "message">,
+    Omit<ChatInputProps, "customCssClasses"> {
+  /** A header to render at the top of the panel. */
+  header?: JSX.Element;
+  /**
+   * CSS classes for customizing the component styling.
+   */
+  customCssClasses?: ChatPanelCssClasses;
+}
+
+/**
+ * A component that renders a full panel for chat bot interactions. This includes
+ * the message bubbles for the conversation, input box with send button, and header
+ * (if provided).
+ *
+ * @public
+ *
+ * @param props - {@link ChatPanelProps}
+ */
+export function ChatPanel(props: ChatPanelProps) {
+  const { header, customCssClasses } = props;
+  const chat = useChatActions();
+  const messages = useChatState((state) => state.conversation.messages);
+  const loading = useChatState((state) => state.conversation.isLoading);
+  const canSendMessage = useChatState(
+    (state) => state.conversation.canSendMessage
+  );
+  const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
+
+  // Fetch the first message on load, if there are no existing messages or a request being processed
+  useEffect(() => {
+    if (messages.length !== 0 || !canSendMessage) {
+      return;
+    }
+    const { stream = true, handleError } = props;
+    const res = stream ? chat.streamNextMessage() : chat.getNextMessage();
+    res.catch((e) => (handleError ? handleError(e) : defaultHandleApiError(e)));
+  }, [chat, props, messages, canSendMessage]);
+
+  const messagesRef = useRef<HTMLDivElement>(null);
+
+  // Scroll to the bottom of the chat when the messages change
+  useEffect(() => {
+    messagesRef.current?.scroll({
+      top: messagesRef.current?.scrollHeight,
+      behavior: 'smooth',
+  });
+  }, [messages]);
+
+  return (
+    <div className={cssClasses.container}>
+      {header}
+      <div ref={messagesRef} className={cssClasses.messagesContainer}>
+        {messages.map((message, index) => (
+          <MessageBubble
+            {...props}
+            customCssClasses={cssClasses.messageBubbleCssClasses}
+            key={index}
+            message={message}
+          />
+        ))}
+        {loading && <LoadingDots />}
+      </div>
+      <div className={cssClasses.inputContainer}>
+        <ChatInput {...props} customCssClasses={cssClasses.inputCssClasses} />
+      </div>
+    </div>
+  );
+}

package/src/components/ChatPopUp.tsx

@@ -0,0 +1,112 @@
+import { useCallback, useState } from "react";
+import { MessageIcon } from '../icons/Message'
+import { ChatPanel, ChatPanelCssClasses, ChatPanelProps } from "./ChatPanel";
+import { ChatHeader, ChatHeaderCssClasses, ChatHeaderProps } from "./ChatHeader";
+import { twMerge } from "tailwind-merge";
+import { useComposedCssClasses } from "../hooks";
+
+/**
+ * The CSS class interface for the {@link ChatPopUp} component.
+ *
+ * @public
+ */
+export interface ChatPopUpCssClasses {
+  container?: string;
+  panel?: string;
+  panel__display?: string;
+  panel__hidden?: string;
+  button?: string;
+  button__display?: string;
+  button__hidden?: string;
+  headerCssClasses?: ChatHeaderCssClasses,
+  panelCssClasses?: ChatPanelCssClasses,
+}
+
+const fixedPosition = "fixed bottom-6 right-4 lg:bottom-14 lg:right-10 "
+const builtInCssClasses: ChatPopUpCssClasses = {
+  container: "transition-all",
+  panel: fixedPosition + "w-80 lg:w-96 h-[75vh]",
+  panel__display: "duration-300 translate-y-0",
+  panel__hidden: "duration-300 translate-y-[20%] opacity-0 invisible",
+  button: fixedPosition + "p-2 w-12 h-12 lg:w-16 lg:h-16 flex justify-center items-center text-white shadow-xl rounded-full bg-gradient-to-br from-blue-600 to-blue-700 hover:-translate-y-2 duration-150",
+  button__display: "duration-300 transform translate-y-0",
+  button__hidden: "duration-300 transform translate-y-[20%] opacity-0 invisible",
+};
+
+/**
+ * The props for the {@link ChatPopUp} component.
+ *
+ * @public
+ */
+export interface ChatPopUpProps extends
+  Omit<ChatHeaderProps, "showCloseButton" | "customCssClasses">,
+  Omit<ChatPanelProps, "header" | "customCssClasses">
+{
+  /** Custom icon for the popup button to open the panel. */
+  openPanelButtonIcon?: JSX.Element;
+  /**
+   * CSS classes for customizing the component styling.
+   */
+  customCssClasses?: ChatPopUpCssClasses;
+}
+
+/**
+ * A component that renders a popup button that displays and hides
+ * a panel for chat bot interactions.
+ *
+ * @public
+ *
+ * @param props - {@link ChatPanelProps}
+ */
+export function ChatPopUp(props: ChatPopUpProps) {
+  const {
+    openPanelButtonIcon = <MessageIcon />,
+    customCssClasses,
+    showRestartButton = true,
+    onClose:customOnClose,
+    title
+  } = props
+  const [showChat, setShowChat] = useState(false);
+  const onClick = useCallback(() => {
+    setShowChat(!showChat);
+  }, [showChat]);
+
+  const onClose = useCallback(() => {
+    setShowChat(false);
+    customOnClose?.();
+  }, [customOnClose])
+  
+  const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
+  const panelCssClasses = twMerge(
+    cssClasses.panel,
+    showChat ? cssClasses.panel__display : cssClasses.panel__hidden
+  );
+  const buttonCssClasses = twMerge(
+    cssClasses.button,
+    showChat ? cssClasses.button__hidden : cssClasses.button__display
+  );
+
+  return (
+    <div className={cssClasses.container}>
+      <div className={panelCssClasses} aria-label="Chat Popup Panel">
+        <ChatPanel
+          {...props}
+          customCssClasses={cssClasses.panelCssClasses}
+          header={<ChatHeader
+            title={title}
+            showRestartButton={showRestartButton}
+            showCloseButton={true}
+            onClose={onClose}
+            customCssClasses={cssClasses.headerCssClasses}/>
+          } />
+      </div>
+      <button
+        aria-label="Chat Popup Button"
+        onClick={onClick}
+        className={buttonCssClasses}
+      >
+        {openPanelButtonIcon}
+      </button>
+    </div>
+  );
+}

package/src/components/LoadingDots.tsx

@@ -0,0 +1,22 @@
+import { twMerge } from "tailwind-merge";
+
+/**
+ * A component that signifies loading status.
+ *
+ * @internal
+ */
+export function LoadingDots({ className }: { className?: string }) {
+  return (
+    <div
+      aria-label="Loading Indicator"
+      className={twMerge(
+        "flex gap-1 p-2 animate-fade-in",
+        className
+      )}
+    >
+      <div className="w-2 h-2 bg-slate-500 rounded-full animate-[bounce_1s_infinite]" />
+      <div className="w-2 h-2 bg-slate-500 rounded-full animate-[bounce_1s_infinite_0.3s]" />
+      <div className="w-2 h-2 bg-slate-500 rounded-full animate-[bounce_1s_infinite_0.6s]" />
+    </div>
+  );
+}

package/src/components/Markdown.tsx

@@ -0,0 +1,36 @@
+import ReactMarkdown, { PluggableList } from "react-markdown";
+import remarkGfm from "remark-gfm";
+import rehypeRaw from "rehype-raw";
+import rehypeSanitize from "rehype-sanitize";
+
+// The Remark and Rehype plugins to use in conjunction with ReactMarkdown.
+const unifiedPlugins: { remark?: PluggableList; rehype: PluggableList } = {
+  remark: [
+    remarkGfm //renders Github-Flavored Markdown
+  ],
+  rehype: [
+    rehypeRaw, //to support HTML embedded in markdown
+    rehypeSanitize, //to sanitize HTML content
+  ],
+};
+
+interface MarkdownProps {
+  /** Stringified markdown. */
+  content: string;
+}
+
+/**
+ * Renders Github-Flavored Markdown from the Knowledge Graph. This Markdown can include
+ * arbitrary HTML. Any HTML will be sanitized according to Rehype's default Schema.
+ * 
+ * @public
+ */
+export function Markdown({ content }: MarkdownProps) {
+  return (
+    <ReactMarkdown
+      children={content}
+      remarkPlugins={unifiedPlugins.remark}
+      rehypePlugins={unifiedPlugins.rehype}
+    />
+  );
+}

package/src/components/MessageBubble.tsx

@@ -0,0 +1,125 @@
+import { Message, MessageSource } from "@yext/chat-headless-react";
+import { useComposedCssClasses } from "../hooks";
+import { twMerge } from "tailwind-merge";
+import { Markdown } from "./Markdown";
+
+/**
+ * The CSS class interface for the {@link MessageBubble} component.
+ *
+ * @public
+ */
+export interface MessageBubbleCssClasses {
+  topContainer?: string;
+  subContainer?: string;
+  subContainer__bot?: string;
+  subContainer__user?: string;
+  message?: string;
+  message__bot?: string;
+  message__user?: string;
+  timestamp?: string;
+  timestamp__bot?: string;
+  timestamp__user?: string;
+}
+
+const builtInCssClasses: MessageBubbleCssClasses = {
+  topContainer: "w-full animate-fade-in @container",
+  subContainer:
+    "flex flex-col @lg:flex-row @lg:items-center @lg:gap-x-2 @lg:m-1",
+  subContainer__user: "@lg:flex-row-reverse",
+  message:
+    "peer rounded-2xl text-[13px] @[480px]:text-base p-4 w-fit max-w-[80%] prose overflow-x-auto",
+  message__bot: "text-slate-900 bg-gradient-to-tr from-slate-50 to-slate-100",
+  message__user:
+    "ml-auto @lg:ml-0 text-white bg-gradient-to-tr from-blue-600 to-blue-700",
+  timestamp:
+    "w-fit my-0.5 text-slate-400 text-[13px] opacity-0 peer-hover:opacity-100 duration-200 whitespace-pre-wrap",
+  timestamp__user: "ml-auto",
+};
+
+/**
+ * The props for the {@link MessageBubble} component.
+ *
+ * @public
+ */
+export interface MessageBubbleProps {
+  /** The message to display. */
+  message: Message;
+  /**
+   * Whether to show the timestamp of the message with the message bubble.
+   * Defaults to true.
+   */
+  showTimestamp?: boolean;
+  /**
+   * A function which is called to format the message's timestamp given in
+   * ISO format (e.g. "2023-05-18T19:33:34.553Z").
+   * Defaults to "HH:MM:SS A" (e.g. "7:33:34 PM").
+   */
+  formatTimestamp?: (timestamp: string) => string;
+  /** CSS classes for customizing the component styling. */
+  customCssClasses?: MessageBubbleCssClasses;
+}
+
+/**
+ * A component that displays the provided message.
+ *
+ * @public
+ *
+ * @param props - {@link MessageBubbleProps}
+ */
+export function MessageBubble({
+  message,
+  showTimestamp = true,
+  customCssClasses,
+  formatTimestamp = defaultFormatTimestamp,
+}: MessageBubbleProps) {
+  const cssClasses = useComposedCssClasses(builtInCssClasses, customCssClasses);
+  const messageCssClasses = twMerge(
+    cssClasses.message,
+    message.source === MessageSource.USER
+      ? cssClasses.message__user
+      : cssClasses.message__bot
+  );
+  const subContainerCssClasses = twMerge(
+    cssClasses.subContainer,
+    message.source === MessageSource.USER
+      ? cssClasses.subContainer__user
+      : cssClasses.subContainer__bot
+  );
+  const timestampCssClasses = twMerge(
+    cssClasses.timestamp,
+    message.source === MessageSource.USER
+      ? cssClasses.timestamp__user
+      : cssClasses.timestamp__bot
+  );
+
+  return (
+    <div className={cssClasses.topContainer}>
+      <div className={subContainerCssClasses}>
+        <div className={messageCssClasses}>
+          <Markdown content={message.text} />
+        </div>
+        {/* fallback on empty space here to perserve the height for timestamp div */}
+        {showTimestamp && (
+          <div className={timestampCssClasses}>
+            {message.timestamp ? formatTimestamp(message.timestamp) : " "}
+          </div>
+        )}
+      </div>
+    </div>
+  );
+}
+
+/**
+ * Formats message's timestamp from "2023-05-18T19:33:34.553Z" to "7:33:34 PM"
+ *
+ * @param timestamp - the timestamp to convert from
+ * @returns formatted timestamp
+ */
+function defaultFormatTimestamp(timestamp: string): string {
+  return new Date(timestamp).toLocaleString(undefined, {
+    hour: "numeric",
+    minute: "numeric",
+    second: "numeric",
+    hour12: true,
+  });
+}

package/src/components/index.ts

@@ -0,0 +1,17 @@
+export { ChatInput } from "./ChatInput";
+export type { ChatInputCssClasses, ChatInputProps } from "./ChatInput";
+
+export { ChatHeader } from "./ChatHeader";
+export type { ChatHeaderCssClasses, ChatHeaderProps } from "./ChatHeader";
+
+export { MessageBubble } from "./MessageBubble";
+export type {
+  MessageBubbleCssClasses,
+  MessageBubbleProps,
+} from "./MessageBubble";
+
+export { ChatPanel } from "./ChatPanel";
+export type { ChatPanelCssClasses, ChatPanelProps } from "./ChatPanel";
+
+export { ChatPopUp } from "./ChatPopUp";
+export type { ChatPopUpCssClasses, ChatPopUpProps } from "./ChatPopUp";

package/src/hooks/index.ts

@@ -0,0 +1 @@
+export { useComposedCssClasses } from "./useComposedCssClasses";

package/src/hooks/useComposedCssClasses.ts

@@ -0,0 +1,62 @@
+import { useMemo } from "react";
+import { twMerge } from "tailwind-merge";
+
+/**
+ * useComposedCssClasses merges a component's built-in tailwind classes with custom tailwind classes.
+ *
+ * @remarks
+ * Tailwind classes will be merged without conflict, with custom classes having higher priority
+ * than built-in ones.
+ *
+ * @example
+ * Suppose a component has built-in classes of `{ container: 'px-4 text-slate-700' }`.
+ *
+ * Passing in the custom classes:
+ *
+ * ```ts
+ * { container: 'text-red-200 mb-3' }
+ * ```
+ *
+ * results in the merged classes of:
+ *
+ * ```ts
+ * { container: 'px-4 text-red-200 mb-3' }
+ * ```
+ *
+ * @public
+ *
+ * @param builtInClasses - The component's built-in tailwind classes
+ * @param customClasses - The custom tailwind classes to merge with the built-in ones
+ * @returns The composed CSS classes
+ */
+export function useComposedCssClasses<
+  ClassInterface extends Partial<Record<keyof ClassInterface, string | object>>
+>(
+  builtInClasses: Readonly<ClassInterface>,
+  customClasses?: Partial<ClassInterface>
+): ClassInterface {
+  return useMemo(() => {
+    const mergeCssClasses = (
+      builtInClasses: Readonly<ClassInterface>,
+      customClasses?: Partial<ClassInterface>
+    ) => {
+      const mergedCssClasses = { ...builtInClasses };
+      if (!customClasses) {
+        return mergedCssClasses;
+      }
+      Object.keys(customClasses).forEach((key) => {
+        const builtIn = builtInClasses[key];
+        const custom = customClasses[key];
+        if (!builtIn || !custom) {
+          mergedCssClasses[key] = custom || builtIn;
+        } else if (typeof builtIn === "object" && typeof custom === "object") {
+          mergedCssClasses[key] = mergeCssClasses(builtIn, custom);
+        } else if (typeof builtIn === "string" && typeof custom === "string") {
+          mergedCssClasses[key] = twMerge(builtIn, custom);
+        }
+      });
+      return mergedCssClasses;
+    };
+    return mergeCssClasses(builtInClasses, customClasses);
+  }, [builtInClasses, customClasses]);
+}

package/src/icons/Arrow.tsx

@@ -0,0 +1,8 @@
+export function ArrowIcon(): JSX.Element {
+  return (
+    <svg width="100%" height="100%" viewBox="0 0 20 20"  fill='none' stroke="currentColor" strokeLinecap="square" xmlns="http://www.w3.org/2000/svg">
+      <path d="M10 5V15"/>
+      <path d="M15 8.84615L10 4L5 8.84615"/>
+    </svg>
+  );
+}

package/src/icons/Cross.tsx

@@ -0,0 +1,8 @@
+export function CrossIcon(): JSX.Element {
+  return (
+    <svg width="100%" height="100%" viewBox="0 0 20 20" stroke="currentColor" xmlns="http://www.w3.org/2000/svg">
+      <path d="M14 14L6 6" strokeLinecap="square" strokeLinejoin="round"/>
+      <path d="M14 6L6 14" strokeLinecap="square" strokeLinejoin="round"/>
+    </svg>
+  );
+}

package/src/icons/DualSync.tsx

@@ -0,0 +1,8 @@
+export function DualSyncIcon(): JSX.Element {
+  return (
+    <svg width="100%" height="100%" viewBox="0 0 20 20" fill='currentColor' stroke="currentColor" xmlns="http://www.w3.org/2000/svg">
+    <path d="M14.3148 6.47397C14.9074 7.36266 15.2593 8.46858 15.2593 9.63375C15.2593 12.675 12.9259 15.1634 10.0741 15.1634C9.11111 15.1634 8.2037 14.8671 7.42593 14.3734L9.05556 13.8995L8.87037 13.1293L6 13.939L6.75926 17L7.48148 16.8025L7.03704 15.0449C7.92593 15.6176 8.96296 15.9336 10.0741 15.9336C13.3519 15.9336 16 13.1095 16 9.614C16 8.2711 15.6111 7.02693 14.9259 6L14.3148 6.47397Z"/>
+    <path d="M9.92593 4.68459C10.8889 4.68459 11.7963 4.95341 12.5741 5.40143L10.9444 5.81362L11.1296 6.51254L14 5.77778L13.2407 3L12.5185 3.17921L12.963 4.77419C12.0741 4.25448 11.037 3.96774 9.92593 3.96774C6.64815 3.96774 4 6.53047 4 9.70251C4 10.9211 4.40741 12.0681 5.07407 13L5.68518 12.5878C5.09259 11.7634 4.74074 10.7778 4.74074 9.70251C4.74074 6.94265 7.07407 4.68459 9.92593 4.68459Z"/>
+    </svg>
+  );
+}

package/src/icons/Message.tsx

@@ -0,0 +1,10 @@
+export function MessageIcon(): JSX.Element {
+  return (
+    <svg width="100%" height="100%" viewBox="0 0 20 20" fill='currentColor' xmlns="http://www.w3.org/2000/svg">
+      <path d="M3.37424 17.1166L6.31902 14.1718H16.6258V4.84663H3.37424V17.1166ZM3.86503 5.33742H16.135V13.681H6.31902H6.11043L5.96319 13.8282L3.85276 15.9386V5.33742H3.86503Z"/>
+      <path d="M14.4172 9.2638H6.07362V9.7546H14.4172V9.2638Z" />
+      <path d="M13.9264 10.7362H6.07362V11.227H13.9264V10.7362Z" />
+      <path d="M13.4356 7.79141H6.07362V8.28221H13.4356V7.79141Z" />
+    </svg>
+  );
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./components";
+export * from "./hooks";

package/src/utils/defaultHandleError.ts

@@ -0,0 +1,10 @@
+/**
+ * Default handler function for API errors.
+ *
+ * @internal
+ *
+ * @param e - error returned from api request
+ */
+export function defaultHandleApiError(e: unknown) {
+  console.error(e);
+}