@copilotkit/react-ui 0.14.1 → 0.15.0-alpha.1

package/src/components/chat/ChatContext.tsx

@@ -0,0 +1,176 @@
+import React, { useMemo } from "react";
+import * as DefaultIcons from "./Icons";
+
+/**
+ * Icons for CopilotKitChat component.
+ */
+export interface CopilotKitChatIcons {
+  /**
+   * The icon to use for the open chat button.
+   * @default <OpenIcon />
+   */
+  openIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the close chat button.
+   * @default <CloseIcon />
+   */
+  closeIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the close chat button in the header.
+   * @default <HeaderCloseIcon />
+   */
+  headerCloseIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the send button.
+   * @default <SendIcon />
+   */
+  sendIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the activity indicator.
+   * @default <ActivityIcon />
+   */
+  activityIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the spinner.
+   * @default <SpinnerIcon />
+   */
+  spinnerIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the stop button.
+   * @default <StopIcon />
+   */
+  stopIcon?: React.ReactNode;
+
+  /**
+   * The icon to use for the regenerate button.
+   * @default <RegenerateIcon />
+   */
+  regenerateIcon?: React.ReactNode;
+}
+
+/**
+ * Labels for CopilotKitChat component.
+ */
+export interface CopilotKitChatLabels {
+  /**
+   * The initial message(s) to display in the chat window.
+   */
+  initial?: string | string[];
+
+  /**
+   * The title to display in the header.
+   * @default "CopilotKit"
+   */
+  title?: string;
+
+  /**
+   * The placeholder to display in the input.
+   * @default "Type a message..."
+   */
+  placeholder?: string;
+
+  /**
+   * The message to display while the chat GPT is "thinking".
+   * @default "Thinking..."
+   */
+  thinking?: string;
+
+  /**
+   * The message to display when the chat is done executing a function.
+   * @default "✅ Done"
+   */
+  done?: string;
+
+  /**
+   * The message to display when an error occurs.
+   * @default "❌ An error occurred. Please try again."
+   */
+  error?: string;
+
+  /**
+   * The label to display on the stop button.
+   * @default "Stop generating"
+   */
+  stopGenerating?: string;
+
+  /**
+   * The label to display on the regenerate button.
+   * @default "Regenerate response"
+   */
+  regenerateResponse?: string;
+}
+
+interface ChatContext {
+  labels: Required<CopilotKitChatLabels>;
+  icons: Required<CopilotKitChatIcons>;
+}
+
+export const ChatContext = React.createContext<ChatContext | undefined>(undefined);
+
+export function useChatContext(): ChatContext {
+  const context = React.useContext(ChatContext);
+  if (context === undefined) {
+    throw new Error(
+      "Context not found. Did you forget to wrap your app in a <ChatContextProvider> component?",
+    );
+  }
+  return context;
+}
+
+interface ChatContextProps {
+  // temperature?: number;
+  // instructions?: string;
+  // maxFeedback?: number;
+  labels?: CopilotKitChatLabels;
+  icons?: CopilotKitChatIcons;
+  children?: React.ReactNode;
+}
+
+export const ChatContextProvider: React.FC<ChatContextProps> = ({
+  // temperature,
+  // instructions,
+  // maxFeedback,
+  labels,
+  icons,
+  children,
+}) => {
+  const context = useMemo(
+    () => ({
+      labels: {
+        ...{
+          initial: "",
+          title: "CopilotKit",
+          placeholder: "Type a message...",
+          thinking: "Thinking...",
+          done: "✅ Done",
+          error: "❌ An error occurred. Please try again.",
+          stopGenerating: "Stop generating",
+          regenerateResponse: "Regenerate response",
+        },
+        ...labels,
+      },
+
+      icons: {
+        ...{
+          openIcon: DefaultIcons.OpenIcon,
+          closeIcon: DefaultIcons.CloseIcon,
+          headerCloseIcon: DefaultIcons.HeaderCloseIcon,
+          sendIcon: DefaultIcons.SendIcon,
+          activityIcon: DefaultIcons.ActivityIcon,
+          spinnerIcon: DefaultIcons.SpinnerIcon,
+          stopIcon: DefaultIcons.StopIcon,
+          regenerateIcon: DefaultIcons.RegenerateIcon,
+        },
+        icons,
+      },
+    }),
+    [labels, icons],
+  );
+  return <ChatContext.Provider value={context}>{children}</ChatContext.Provider>;
+};

package/src/components/chat/CodeBlock.tsx

@@ -0,0 +1,149 @@
+"use client";
+
+import { FC, memo } from "react";
+import { Prism as SyntaxHighlighter } from "react-syntax-highlighter";
+
+import { useCopyToClipboard } from "../../hooks/use-copy-to-clipboard";
+import { CheckIcon, CopyIcon, DownloadIcon } from "./Icons";
+
+interface CodeActionButtonProps {
+  onClick: () => void;
+  children: React.ReactNode;
+}
+
+const CodeActionButton: FC<CodeActionButtonProps> = ({ onClick, children }) => {
+  let className =
+    "inline-flex items-center justify-center rounded-md text-sm font-medium ring-offset-background " +
+    "transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-ring " +
+    "focus-visible:ring-offset-2 disabled:pointer-events-none disabled:opacity-50 ";
+
+  className +=
+    "hover:bg-zinc-800 focus-visible:ring-1 focus-visible:ring-slate-700 focus-visible:ring-offset-0 ";
+  className += "hover:bg-accent hover:text-accent-foreground ";
+  className += "h-10 w-10";
+
+  return (
+    <button className={className} onClick={onClick}>
+      {children}
+    </button>
+  );
+};
+
+interface Props {
+  language: string;
+  value: string;
+}
+
+interface languageMap {
+  [key: string]: string | undefined;
+}
+
+export const programmingLanguages: languageMap = {
+  javascript: ".js",
+  python: ".py",
+  java: ".java",
+  c: ".c",
+  cpp: ".cpp",
+  "c++": ".cpp",
+  "c#": ".cs",
+  ruby: ".rb",
+  php: ".php",
+  swift: ".swift",
+  "objective-c": ".m",
+  kotlin: ".kt",
+  typescript: ".ts",
+  go: ".go",
+  perl: ".pl",
+  rust: ".rs",
+  scala: ".scala",
+  haskell: ".hs",
+  lua: ".lua",
+  shell: ".sh",
+  sql: ".sql",
+  html: ".html",
+  css: ".css",
+  // add more file extensions here, make sure the key is same as language prop in CodeBlock.tsx component
+};
+
+export const generateRandomString = (length: number, lowercase = false) => {
+  const chars = "ABCDEFGHJKLMNPQRSTUVWXY3456789"; // excluding similar looking characters like Z, 2, I, 1, O, 0
+  let result = "";
+  for (let i = 0; i < length; i++) {
+    result += chars.charAt(Math.floor(Math.random() * chars.length));
+  }
+  return lowercase ? result.toLowerCase() : result;
+};
+
+const CodeBlock: FC<Props> = memo(({ language, value }) => {
+  const { isCopied, copyToClipboard } = useCopyToClipboard({ timeout: 2000 });
+
+  const downloadAsFile = () => {
+    if (typeof window === "undefined") {
+      return;
+    }
+    const fileExtension = programmingLanguages[language] || ".file";
+    const suggestedFileName = `file-${generateRandomString(3, true)}${fileExtension}`;
+    const fileName = window.prompt("Enter file name" || "", suggestedFileName);
+
+    if (!fileName) {
+      // User pressed cancel on prompt.
+      return;
+    }
+
+    const blob = new Blob([value], { type: "text/plain" });
+    const url = URL.createObjectURL(blob);
+    const link = document.createElement("a");
+    link.download = fileName;
+    link.href = url;
+    link.style.display = "none";
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+    URL.revokeObjectURL(url);
+  };
+
+  const onCopy = () => {
+    if (isCopied) return;
+    copyToClipboard(value);
+  };
+
+  return (
+    <div className="codeblock relative w-full bg-zinc-950 font-sans">
+      <div className="flex w-full items-center justify-between bg-zinc-800 px-6 py-2 pr-4 text-zinc-100">
+        <span className="text-xs lowercase">{language}</span>
+        <div className="flex items-center space-x-1">
+          <CodeActionButton onClick={downloadAsFile}>
+            <DownloadIcon />
+            <span className="sr-only">Download</span>
+          </CodeActionButton>
+          <CodeActionButton onClick={onCopy}>
+            {isCopied ? <CheckIcon /> : <CopyIcon />}
+            <span className="sr-only">Copy code</span>
+          </CodeActionButton>
+        </div>
+      </div>
+      <SyntaxHighlighter
+        language={language}
+        PreTag="div"
+        showLineNumbers
+        customStyle={{
+          margin: 0,
+          width: "100%",
+          background: "transparent",
+          padding: "1.5rem 1rem",
+        }}
+        codeTagProps={{
+          style: {
+            fontSize: "0.9rem",
+            fontFamily: "var(--font-mono)",
+          },
+        }}
+      >
+        {value}
+      </SyntaxHighlighter>
+    </div>
+  );
+});
+CodeBlock.displayName = "CodeBlock";
+
+export { CodeBlock };

package/src/components/chat/Header.tsx

@@ -0,0 +1,16 @@
+import React from "react";
+import { HeaderProps } from "./props";
+import { useChatContext } from "./ChatContext";
+
+export const Header: React.FC<HeaderProps> = ({ setOpen }) => {
+  const context = useChatContext();
+
+  return (
+    <div className="copilotKitHeader">
+      <div>{context.labels.title}</div>
+      <button onClick={() => setOpen(false)} aria-label="Close">
+        {context.icons.headerCloseIcon}
+      </button>
+    </div>
+  );
+};

package/src/components/chat/Icons.tsx

@@ -0,0 +1,179 @@
+import React from "react";
+
+export const OpenIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 24 24"
+    fill="currentColor"
+    width="24"
+    height="24"
+  >
+    <g transform="translate(24, 0) scale(-1, 1)">
+      <path
+        fillRule="evenodd"
+        d="M5.337 21.718a6.707 6.707 0 01-.533-.074.75.75 0 01-.44-1.223 3.73 3.73 0 00.814-1.686c.023-.115-.022-.317-.254-.543C3.274 16.587 2.25 14.41 2.25 12c0-5.03 4.428-9 9.75-9s9.75 3.97 9.75 9c0 5.03-4.428 9-9.75 9-.833 0-1.643-.097-2.417-.279a6.721 6.721 0 01-4.246.997z"
+        clipRule="evenodd"
+      />
+    </g>
+  </svg>
+);
+
+export const CloseIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    fill="none"
+    viewBox="0 0 24 24"
+    strokeWidth="1.5"
+    stroke="currentColor"
+    width="24"
+    height="24"
+  >
+    <path strokeLinecap="round" strokeLinejoin="round" d="M19.5 8.25l-7.5 7.5-7.5-7.5" />
+  </svg>
+);
+
+export const HeaderCloseIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    fill="none"
+    viewBox="0 0 24 24"
+    strokeWidth="1.5"
+    stroke="currentColor"
+    width="24"
+    height="24"
+  >
+    <path strokeLinecap="round" strokeLinejoin="round" d="M6 18L18 6M6 6l12 12" />
+  </svg>
+);
+
+export const SendIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    fill="none"
+    viewBox="0 0 24 24"
+    strokeWidth={1.5}
+    stroke="currentColor"
+    width="24"
+    height="24"
+  >
+    <path
+      strokeLinecap="round"
+      strokeLinejoin="round"
+      d="M6 12L3.269 3.126A59.768 59.768 0 0121.485 12 59.77 59.77 0 013.27 20.876L5.999 12zm0 0h7.5"
+    />
+  </svg>
+);
+
+export const SpinnerIcon = (
+  <svg
+    style={{
+      animation: "copilotKitSpinAnimation 1s linear infinite",
+      color: "rgb(107 114 128)",
+    }}
+    width="24"
+    height="24"
+    xmlns="http://www.w3.org/2000/svg"
+    fill="none"
+    viewBox="0 0 24 24"
+  >
+    <circle
+      style={{ opacity: 0.25 }}
+      cx="12"
+      cy="12"
+      r="10"
+      stroke="currentColor"
+      strokeWidth="4"
+    ></circle>
+    <path
+      style={{ opacity: 0.75 }}
+      fill="currentColor"
+      d="M4 12a8 8 0 018-8V0C5.373 0 0 5.373 0 12h4zm2 5.291A7.962 7.962 0 014 12H0c0 3.042 1.135 5.824 3 7.938l3-2.647z"
+    ></path>
+  </svg>
+);
+
+export const ActivityIcon = (
+  <svg
+    style={{
+      display: "inline-block",
+      marginLeft: "0.25rem",
+      marginRight: "0.25rem",
+    }}
+    height="24"
+    width="24"
+    viewBox="0 0 27 27"
+    xmlns="http://www.w3.org/2000/svg"
+    fill="currentColor"
+  >
+    <circle className="copilotKitActivityDot1" cx="4" cy="12" r="3" />
+    <circle className="copilotKitActivityDot1 copilotKitActivityDot2" cx="12" cy="12" r="3" />
+    <circle className="copilotKitActivityDot1 copilotKitActivityDot3" cx="20" cy="12" r="3" />
+  </svg>
+);
+
+export function CheckIcon({ className, ...props }: React.ComponentProps<"svg">) {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      viewBox="0 0 256 256"
+      fill="currentColor"
+      style={{ height: "1rem", width: "1rem" }}
+      className={className}
+      {...props}
+    >
+      <path d="m229.66 77.66-128 128a8 8 0 0 1-11.32 0l-56-56a8 8 0 0 1 11.32-11.32L96 188.69 218.34 66.34a8 8 0 0 1 11.32 11.32Z" />
+    </svg>
+  );
+}
+
+export function DownloadIcon({ className, ...props }: React.ComponentProps<"svg">) {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      viewBox="0 0 256 256"
+      fill="currentColor"
+      style={{ height: "1rem", width: "1rem" }}
+      className={className}
+      {...props}
+    >
+      <path d="M224 152v56a16 16 0 0 1-16 16H48a16 16 0 0 1-16-16v-56a8 8 0 0 1 16 0v56h160v-56a8 8 0 0 1 16 0Zm-101.66 5.66a8 8 0 0 0 11.32 0l40-40a8 8 0 0 0-11.32-11.32L136 132.69V40a8 8 0 0 0-16 0v92.69l-26.34-26.35a8 8 0 0 0-11.32 11.32Z" />
+    </svg>
+  );
+}
+
+export function CopyIcon({ className, ...props }: React.ComponentProps<"svg">) {
+  return (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      viewBox="0 0 256 256"
+      fill="currentColor"
+      style={{ height: "1rem", width: "1rem" }}
+      className={className}
+      {...props}
+    >
+      <path d="M216 32H88a8 8 0 0 0-8 8v40H40a8 8 0 0 0-8 8v128a8 8 0 0 0 8 8h128a8 8 0 0 0 8-8v-40h40a8 8 0 0 0 8-8V40a8 8 0 0 0-8-8Zm-56 176H48V96h112Zm48-48h-32V88a8 8 0 0 0-8-8H96V48h112Z" />
+    </svg>
+  );
+}
+
+export const StopIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 256 256"
+    fill="currentColor"
+    style={{ height: "1rem", width: "1rem" }}
+  >
+    <path d="M128 24a104 104 0 1 0 104 104A104.11 104.11 0 0 0 128 24Zm0 192a88 88 0 1 1 88-88 88.1 88.1 0 0 1-88 88Zm24-120h-48a8 8 0 0 0-8 8v48a8 8 0 0 0 8 8h48a8 8 0 0 0 8-8v-48a8 8 0 0 0-8-8Zm-8 48h-32v-32h32Z" />
+  </svg>
+);
+
+export const RegenerateIcon = (
+  <svg
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 256 256"
+    fill="currentColor"
+    style={{ height: "1rem", width: "1rem" }}
+  >
+    <path d="M197.67 186.37a8 8 0 0 1 0 11.29C196.58 198.73 170.82 224 128 224c-37.39 0-64.53-22.4-80-39.85V208a8 8 0 0 1-16 0v-48a8 8 0 0 1 8-8h48a8 8 0 0 1 0 16H55.44C67.76 183.35 93 208 128 208c36 0 58.14-21.46 58.36-21.68a8 8 0 0 1 11.31.05ZM216 40a8 8 0 0 0-8 8v23.85C192.53 54.4 165.39 32 128 32c-42.82 0-68.58 25.27-69.66 26.34a8 8 0 0 0 11.3 11.34C69.86 69.46 92 48 128 48c35 0 60.24 24.65 72.56 40H168a8 8 0 0 0 0 16h48a8 8 0 0 0 8-8V48a8 8 0 0 0-8-8Z" />
+  </svg>
+);

package/src/components/chat/Input.tsx

@@ -0,0 +1,51 @@
+import React, { useRef, useState } from "react";
+import { InputProps } from "./props";
+import { useChatContext } from "./ChatContext";
+import AutoResizingTextarea from "./Textarea";
+
+export const Input: React.FC<InputProps> = ({ inProgress, onSend, children }) => {
+  const context = useChatContext();
+  const textareaRef = useRef<HTMLTextAreaElement>(null);
+
+  const handleDivClick = (event: React.MouseEvent<HTMLDivElement>) => {
+    // Check if the clicked element is not the textarea itself
+    if (event.target !== event.currentTarget) return;
+
+    textareaRef.current?.focus();
+  };
+
+  const [text, setText] = useState("");
+  const send = () => {
+    if (inProgress) return;
+    onSend(text);
+    setText("");
+
+    textareaRef.current?.focus();
+  };
+
+  const icon = inProgress ? context.icons.activityIcon : context.icons.sendIcon;
+  const disabled = inProgress || text.length === 0;
+
+  return (
+    <div className="copilotKitInput" onClick={handleDivClick}>
+      <span>{children}</span>
+      <button className="copilotKitSendButton" disabled={disabled} onClick={send}>
+        {icon}
+      </button>
+      <AutoResizingTextarea
+        ref={textareaRef}
+        placeholder={context.labels.placeholder}
+        autoFocus={true}
+        maxRows={5}
+        value={text}
+        onChange={(event) => setText(event.target.value)}
+        onKeyDown={(event) => {
+          if (event.key === "Enter" && !event.shiftKey) {
+            event.preventDefault();
+            send();
+          }
+        }}
+      />
+    </div>
+  );
+};

package/src/components/chat/Markdown.tsx

@@ -0,0 +1,62 @@
+import React from "react";
+import { FC, memo } from "react";
+import ReactMarkdown, { Options, Components } from "react-markdown";
+import { CodeBlock } from "./CodeBlock";
+import remarkGfm from "remark-gfm";
+import remarkMath from "remark-math";
+
+const MemoizedReactMarkdown: FC<Options> = memo(
+  ReactMarkdown,
+  (prevProps, nextProps) =>
+    prevProps.children === nextProps.children && prevProps.className === nextProps.className,
+);
+
+type MarkdownProps = {
+  content: string;
+};
+
+export const Markdown: React.FC<MarkdownProps> = ({ content }) => {
+  return (
+    <MemoizedReactMarkdown
+      className="prose break-words dark:prose-invert prose-p:leading-relaxed prose-pre:p-0 text-sm"
+      components={components}
+      remarkPlugins={[remarkGfm, remarkMath]}
+    >
+      {content}
+    </MemoizedReactMarkdown>
+  );
+};
+
+const components: Components = {
+  p({ children }) {
+    return <p className="mb-2 last:mb-0">{children}</p>;
+  },
+  code({ children, className, inline, ...props }) {
+    if (children.length) {
+      if (children[0] == "▍") {
+        return <span className="mt-1 animate-pulse cursor-default">▍</span>;
+      }
+
+      children[0] = (children[0] as string).replace("`▍`", "▍");
+    }
+
+    const match = /language-(\w+)/.exec(className || "");
+
+    if (inline) {
+      return (
+        <code className={className} {...props}>
+          {children}
+        </code>
+      );
+    }
+
+    return (
+      <CodeBlock
+        key={Math.random()}
+        language={(match && match[1]) || ""}
+        value={String(children).replace(/\n$/, "")}
+        {...props}
+      />
+    );
+  },
+};