Skip to content
cccskills
FreePublished on GitHub

x-components

Use when building AI chat UIs with @ant-design/x components — covers Bubble, Sender, Conversations, Prompts, ThoughtChain, Actions, Welcome, Attachments, Sources, Suggestion, Think, FileCard, CodeHighlighter, Mermaid, Folder, XProvider, and Notification.

The English summary is being prepared. Showing the original description.

See how to install

Files included (4)

  • SKILL.md7.9 KB
  • reference/API.md47.5 KB
  • reference/COMPONENTS.md18.3 KB
  • reference/PATTERNS.md8.4 KB

SKILL.md (original)

Review the instructions the agent will receive before you install.

🎯 Skill Positioning

This skill covers all UI components in @ant-design/x — the React component library for building AI-driven chat interfaces based on the RICH interaction paradigm.

It covers component selection, API usage, composition patterns, and common anti-patterns.

Prerequisite: This skill handles UI only. For data flow and streaming, see use-x-chat, x-chat-provider, x-request skills.

Table of Contents

📦 Package Overview

PackageResponsibility
@ant-design/xAll UI components in this skill
@ant-design/x-sdkData providers, request, streaming state — not covered here
@ant-design/x-markdownMarkdown rendering inside Bubble — see x-markdown skill
npm install @ant-design/x

@ant-design/x extends antd. If you use ConfigProvider, replace it with XProvider.

🗂️ Component Groups

Based on the RICH interaction paradigm:

StageComponents
GeneralBubble, Bubble.List, Conversations, Notification
WakeWelcome, Prompts
ExpressSender, Attachments, Suggestion
ConfirmationThink, ThoughtChain
FeedbackActions, FileCard, Sources, CodeHighlighter, Mermaid, Folder
GlobalXProvider

🚀 Quick Start Decision Guide

If you need to...Read first
Render a chat message bubbleCOMPONENTS.md → Bubble
Build a chat input boxCOMPONENTS.md → Sender
List and switch conversationsCOMPONENTS.md → Conversations
Show AI thinking processCOMPONENTS.md → ThoughtChain / Think
Add action buttons below a messageCOMPONENTS.md → Actions
Build a welcome / onboarding screenCOMPONENTS.md → Welcome + Prompts
Show file attachments in inputCOMPONENTS.md → Attachments
Show source citationsCOMPONENTS.md → Sources
Add quick command suggestionsCOMPONENTS.md → Suggestion
Display a hierarchical file/folder treeCOMPONENTS.md → Folder
Wire a complete chat pagePATTERNS.md
Look up a specific propAPI.md

🛠 Recommended Workflow

  1. Pick components from COMPONENTS.md for each interaction stage.
  2. Use PATTERNS.md to understand how components compose into full pages.
  3. Wrap the app root with XProvider (replaces antd's ConfigProvider) for locale, theme, and shortcut keys.
  4. Use API.md for precise prop names — do not guess them.

Minimal Full-Page Example

import { XProvider, Welcome, Prompts, Bubble, Sender } from '@ant-design/x';

export default () => (
  <XProvider>
    <Welcome title="Hello!" description="How can I help you?" />
    <Prompts
      items={[{ key: '1', label: 'What can you do?' }]}
      onItemClick={(info) => console.log(info.data.label)}
    />
    <Bubble.List items={[{ key: '1', content: 'Hello World', placement: 'end' }]} />
    <Sender onSubmit={(msg) => console.log(msg)} />
  </XProvider>
);

🚨 Development Rules

  • Always use XProvider at the app root — it supersedes antd's ConfigProvider and enables locale, direction, and x-specific shortcut keys.
  • Bubble.List not Bubble in loops — Bubble.List handles scroll anchoring, auto-scroll, and role-based layout; mapping Bubble manually loses these.
  • Keep components prop stable in Bubble and Bubble.List — inline object creation causes re-renders and resets typing animations.
  • Set streaming={true} during stream, streaming={false} on final chunk — leaving it true permanently breaks the done state.
  • ThoughtChain vs Think: use ThoughtChain for multi-step tool/agent call chains; use Think for a collapsible single-block reasoning display.
  • Actions.Copy, Actions.Feedback, Actions.Audio are preset sub-components — prefer them over building custom equivalents.
  • Sender onSubmit vs onChange: onSubmit fires on send button or Enter key; onChange fires on every keystroke — do not conflate them.
  • Never render Mermaid or CodeHighlighter inside a Bubble content string — use contentRender or the components map instead.

🤝 Skill Collaboration

ScenarioSkill combination
Full AI chat appx-chat-provider → x-request → use-x-chat → x-components → x-markdown
Just building UI structurex-components only
Markdown in bubble repliesx-components + x-markdown
Streaming data flow onlyuse-x-chat + x-request

🔗 Reference Resources

  • COMPONENTS.md — Component-by-component guide with usage, key props, and examples
  • PATTERNS.md — Full-page composition patterns and integration recipes
  • API.md — Auto-generated prop reference from official component docs — covers all 17 components

Official Documentation

Reviews

No reviews yet. Tell others what you thought.

Comments

No login needed. Share how it worked for you, ask a question, or note where it did not run.

No comments yet. Be the first to write one.

Comments are published right away. Do not include personal information such as email addresses or phone numbers. Up to 2 URLs.

0 / 1,000 characters

This form is protected by reCAPTCHA, and the Google Privacy Policy and Terms of Service apply.

More skills from this repository

专注讲解如何使用 useXChat Hook,包括自定义 Provider 的集成、消息管理、错误处理、多会话管理等

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

Focus on explaining how to use the useXChat Hook, including custom Provider integration, message management, error handling, multi-conversation management, and more

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

x-card

Free

Use when building AI-driven UIs with @ant-design/x-card — covers XCard.Box, XCard.Card, A2UI v0.9 commands, data binding, catalogs, actions, and streaming patterns.

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

x-card

Free

当需要用 @ant-design/x-card 让 AI Agent 动态渲染富交互 UI 时使用——涵盖 XCard.Box、XCard.Card、A2UI v0.9 命令、数据绑定、Catalog、Actions 和流式渲染模式。

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

专注于自定义 Chat Provider 的实现,帮助将任意流式接口适配为 Ant Design X 标准格式

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

Focus on implementing custom Chat Provider, helping to adapt any streaming interface to Ant Design X standard format

The English summary is being prepared. Showing the original description.

ant-design/x4.8KUpdated Oct 12, 2026

See all skills by ant-design

Report a problem with this skill