showcase/shell-docs/src/content/docs/prebuilt-components/popup.mdx
<CopilotPopup> is a prebuilt floating launcher that opens an overlay chat
window on top of your page content. It's the lightest-weight way to add a
copilot to an existing app. Drop it in once and a bubble appears in the
corner ready to chat.
Use the popup when you want:
If you need chat to live alongside your content rather than on top of it,
use CopilotSidebar. For a fully embedded
chat pane, use <CopilotChat> directly.
Here's the popup in action. Click the launcher button to open the chat:
<InlineDemo demo="prebuilt-popup" />The gif below shows the popup launcher toggling open over page content:
Wrap your app in <CopilotKit> once (the provider wires the runtime,
session, and agent registry) and render <CopilotPopup> as a sibling of
your main content. The example below opens the popup by default and
customizes the input placeholder via labels:
<CopilotPopup> accepts the same props as <CopilotChat> plus a few of
its own. Commonly used options:
| Prop | Description |
|---|---|
defaultOpen | Whether the popup starts open on first render. |
agentId | Agent slug the popup should talk to (must match an agent configured on the runtime). |
labels | User-facing copy for the header, placeholder, and disclaimer. |
header | Slot for the popup header bar — see the slot system. |
toggleButton | Slot for the floating launcher button. |
CopilotPopup participates in the slot system, so every piece of its UI
is customizable, from Tailwind classes on the message view to a full
component swap for the header or toggle button. See
custom look and feel for the full slot
reference.