Files
copilotkit__copilotkit/showcase/shell-docs/src/content/docs/agentic-chat-ui.mdx
Tyler Slaton 80c54bc60a feat(shell-docs): docs UX polish — Setup as page narrative, demo positioning, landing redesign
Bundles several improvements to how shell-docs feature pages flow when
read cold by a user landing from Google.

Setup section redesign:
  - <FrameworkSetup concept="..." /> now renders inline (no outer
    Accordion wrapper). Concept authors own the structure.
  - LGP/LGT/ADK agent-setup.mdx restructured: an integrated narrative
    paragraph + <DemoCode> excerpt of the framework's middleware
    wiring (CopilotKitMiddleware / CopilotKitStateAnnotation /
    AGUIToolset), then a collapsed "Install the SDK" <Accordion>
    containing just the package install command. The middleware
    reads as page prose; the install step is one click away but
    doesn't visually compete.
  - The slot now lives INSIDE the page's first code-bearing section
    (typically "How it works in code") so it integrates with the
    feature's own explanation rather than standing apart.
  - 6 per-page concept names (frontend-tools-setup,
    shared-state-setup, etc.) collapsed to one universal
    `agent-setup` concept — same content shape across every page,
    each framework decides what to ship.
  - state-rendering's slot removed entirely — its existing
    state-streaming-middleware Snippet already shows CopilotKit
    middleware wiring in fuller context, so the Setup block was
    pure duplication.

Demo positioning + visual treatment:
  - <InlineDemo> wrapper height reduced 500px → 550px and the
    inner iframe zoomed out 30% (scale 0.7, iframe sized to
    100%/0.7 × 550px/0.7 then transformed back). Net: more demo
    content visible (composer + suggested prompts + a few messages
    fit in the 550px viewport at once) at a smaller effective scale.
  - First top-level <InlineDemo> on 31 agnostic docs pages moved to
    sit directly after the frontmatter (was buried after "What is
    this?" intro paragraphs). The live demo IS the page's primary
    visual anchor — let it be the first thing readers see.
  - Leading <video> on 12 framework quickstart pages moved to the
    end of the file. The "Get started in 10 minutes" path needs
    the install steps first; the demo video is a closer.

Landing page redesign:
  - per-framework landing (`/<framework>` URL) reworked: subtle
    accent glow atmospherics, confident hierarchy (eyebrow
    breadcrumb + icon lockup + 3-3.75rem display headline), action
    cluster with copy-init-command chip, numbered milestone-list
    treatment for supported features, SectionEyebrow rhythm, slim
    "Where to next" grid replacing the chunky footer cards.
  - Sparse-data handling preserved: every section conditional on
    its data field. Frameworks with no supportedFeatures /
    liveDemos / tutorialLink collapse cleanly.
  - MDX adapter (mdx-framework-overview.tsx) untouched — authored
    `index.mdx` files (Mastra, etc.) still render through the same
    pipeline.

Other content cleanup:
  - Gif/demo images removed from /prebuilt-components/{chat,
    sidebar,popup} on generated frameworks (LGP/LGT/ADK). With the
    live InlineDemo now at the top of these pages, the static gif
    was redundant (the demo IS the gif, just interactive).
    Authored frameworks have their own copies of these pages and
    are unaffected.

Out of scope:
  - The 18 unused per-page concept files
    (frontend-tools-setup.mdx, shared-state-setup.mdx, etc. × 3
    frameworks) are now dead code on disk. Leaving in place for
    now; cleanup is a follow-up.
  - Subagent's editorial review surfaced other improvements
    (frontend snippets too thin, no "what next" footer) that are
    out of scope for this round.

Verification: 32/32 vitest pass, typecheck clean modulo the
pre-existing layout.ts RESERVED_ROUTE_SLUGS error.

--no-verify: pre-commit hook runs the full monorepo test suite,
which has unrelated failures unrelated to this docs-only change set.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-20 11:04:40 -07:00

39 lines
1.4 KiB
Plaintext

---
title: Chat Components
icon: "lucide/MessageSquare"
description: Customizable, drop-in components for building AI-powered chat interfaces
hideTOC: true
snippet_cell: agentic-chat
---
<InlineDemo demo="agentic-chat" />
## Pre-built components for agentic chat
CopilotKit's chat components give you a fully functional, customizable AI chat interface out of the box.
They handle streaming, generative UI, and deep customization so you can focus on your agent's behavior, not UI plumbing.
<video
src="https://cdn.copilotkit.ai/docs/copilotkit/images/coagents/agentic-chat-ui.mp4"
className="rounded-lg shadow-xl"
loop
playsInline
controls
autoPlay
muted
/>
## What it looks like in code
The live `agentic-chat` cell above is built from a single, small page. Wrap your UI in `<CopilotKit>` once (it wires the runtime, session, and agent registry) and drop `<CopilotChat>` wherever the chat should go:
<Snippet region="provider-setup" title="frontend/src/app/page.tsx — CopilotKit provider" />
Inside the chat, the `useConfigureSuggestions` hook lets you show contextual
starter prompts. The example below uses it to seed a simple "Write a sonnet"
suggestion:
<Snippet region="configure-suggestions" title="frontend/src/app/page.tsx — starter suggestions" />
<IntegrationGrid path="chat" description="The chat components work with any AI backend. Pick your integration to get started." />