AssistantModal

Overview

A chat bubble shown in the bottom right corner of the screen. Useful for support or Q&A use cases.

Getting Started

Install `@assistant-ui/react-ui`

npm install @assistant-ui/react-ui

Import CSS styles

Add the following to your tailwind.config.ts:

/tailwind.config.ts

{
  plugins: [
    require("tailwindcss-animate"), // make sure to "npm install tailwindcss-animate"
    require("@assistant-ui/react-ui/tailwindcss")({
      components: ["assistant-modal"],
    })
  ],
}

/tailwind.config.ts

{
  plugins: [
    require("tailwindcss-animate"), // make sure to "npm install tailwindcss-animate"
    require("@assistant-ui/react-ui/tailwindcss")({
      components: ["assistant-modal"],
      shadcn: true
    })
  ],
}

/app/layout.tsx

import "@assistant-ui/react-ui/styles/index.css";
import "@assistant-ui/react-ui/styles/modal.css";

Use it in your app

/app/page.tsx

import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
import { AssistantModal } from "@assistant-ui/react-ui";

const MyApp = () => {
  const runtime = useChatRuntime({
    api: "/api/chat",
  });

  return (
    <div>
      <AssistantModal runtime={runtime} />
    </div>
  );
};