{"id":18976401,"url":"https://github.com/ant-design/pro-chat","last_synced_at":"2025-04-08T04:13:46.778Z","repository":{"id":202570145,"uuid":"707504998","full_name":"ant-design/pro-chat","owner":"ant-design","description":"🤖 Components Library for Quickly Building LLM Chat Interfaces.","archived":false,"fork":false,"pushed_at":"2024-05-22T09:14:52.000Z","size":1803,"stargazers_count":497,"open_issues_count":41,"forks_count":57,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-05-22T10:36:58.468Z","etag":null,"topics":["ant-design","chat","chatbot","pro-components","pro-editor","react"],"latest_commit_sha":null,"homepage":"https://pro-chat.antdigital.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ant-design.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-20T03:39:47.000Z","updated_at":"2024-05-22T10:37:15.635Z","dependencies_parsed_at":"2023-11-22T11:27:02.336Z","dependency_job_id":"4f0c84a4-52bb-4963-b374-c69c7d42e1d7","html_url":"https://github.com/ant-design/pro-chat","commit_stats":null,"previous_names":["arvinxx/pro-chat"],"tags_count":60,"template":false,"template_full_name":"arvinxx/npm-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ant-design%2Fpro-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ant-design%2Fpro-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ant-design%2Fpro-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ant-design%2Fpro-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ant-design","download_url":"https://codeload.github.com/ant-design/pro-chat/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247773719,"owners_count":20993639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ant-design","chat","chatbot","pro-components","pro-editor","react"],"created_at":"2024-11-08T15:24:34.893Z","updated_at":"2025-04-08T04:13:46.761Z","avatar_url":"https://github.com/ant-design.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## 前言\n\n新用户请直接使用 [ant-design/x](https://github.com/ant-design/x)\n\n一些道歉和想说的：https://github.com/ant-design/pro-chat/issues/340\n\n\n\u003cdiv align=\"center\"\u003e\n\n\u003cimg height=\"120\" src=\"https://gw.alipayobjects.com/zos/kitchen/wzToJwlSw%24/logo.svg\"\u003e\n\u003cimg height=\"120\" src=\"https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg\"\u003e\n\u003cimg height=\"120\" src=\"https://mdn.alipayobjects.com/huamei_re70wt/afts/img/A*Mo27Sr3kS4kAAAAAAAAAAAAADmuEAQ/original\"\u003e\n\n\u003ch1\u003eProChat\u003c/h1\u003e\n\nComponents Library for Quickly Building LLM Chat Interfaces.\n\n[![][npm-release-shield]][npm-release-link] [![][npm-downloads-shield]][npm-downloads-link] [![][github-releasedate-shield]][github-releasedate-link] [![][github-action-test-shield]][github-action-test-link] [![][github-action-release-shield]][github-action-release-link] [![][codecov-shield]][codecov-link] \u003cbr/\u003e [![][github-contributors-shield]][github-contributors-link] [![][github-forks-shield]][github-forks-link] [![][github-stars-shield]][github-stars-link] [![][github-issues-shield]][github-issues-link] [![][github-license-shield]][github-license-link] \u003cbr/\u003e [![][ant-design-shield]][ant-design-link] [![][devops-dumi-shield]][devops-dumi-link] [![][devops-father-shield]][devops-father-link]\n\nEnglish · [简体中文](./README.zh-CN.md) · [Changelog](./CHANGELOG.md) . [Report Bug][github-issues-link] · [Request Feature][github-issues-link]\n\n![](https://gw.alipayobjects.com/zos/kitchen/Aa%2452FxhWU/pro-chat.webp)\n\n\u003c/div\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003ckbd\u003eTable of contents\u003c/kbd\u003e\u003c/summary\u003e\n\n#### TOC\n\n- [📦 Installation](#-installation)\n  - [Compile with Next.js](#compile-with-nextjs)\n- [🔨 Usage](#-usage)\n- [✨ Features](#-features)\n- [👀 Showcase](#-showcase)\n- [🖥 Browser compatibility](#-browser-compatibility)\n- [⌨️ Local Development](#️-local-development)\n- [🤝 Contributing](#-contributing)\n- [🛣️ Ecosystem](#️-ecosystem)\n\n####\n\n\u003c/details\u003e\n\n## 📦 Installation\n\n\u003e \\[!IMPORTANT]\n\u003e\n\u003e This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).\n\nTo install `@ant-design/pro-chat`, run the following command:\n\n```bash\n$ pnpm install @ant-design/pro-chat\n```\n\nThe default `auto-install-peers` in pnpm is `true`. If you use other package managers, you may need to install `antd` and `antd-style` separately.\n\n### Compile with Next.js\n\nIf you have some errors when using Next.js, check [here](https://pro-chat.antdigital.dev/en-US/guide/nextjs#frequently-asked-questions).\n\n## 🔨 Usage\n\n```jsx\nimport { ProChat } from '@ant-design/pro-chat';\n\nexport default () =\u003e (\n  \u003cProChat\n    request={async (messages) =\u003e {\n      // Send a request with Message as the parameter\n      return Message; // Supports both streaming and non-streaming\n    }}\n  /\u003e\n);\n```\n\n\u003cbr/\u003e\n\n## ✨ Features\n\n\u003e \\[!NOTE]\n\u003e\n\u003e ProChat focuses on quickly setting up a large language model chat dialogue framework. It aims to empower developers to easily create rich, dynamic, and intuitive chat interfaces.\n\n[![](https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=707504998\u0026image_size=auto\u0026color_scheme=dark)](https://next.ossinsight.io/widgets/official/compose-activity-trends?repo_id=707504998)\n\n**Framework and Solutions for Chat Interface Components:**\n\n- 🔄 **Automatic Chat Caching**: Maintains conversation continuity without any extra effort, ensuring a smooth user experience.\n- 💬 **Streamlined Conversations**: Offers the choice between different conversation styles, catering to diverse user preferences.\n- ✏️ **Message Editing Features**: Provides a suite of editing tools, including request redo, edit combination, and deletion, for precise conversation control.\n- 📖 **Auto-rendered Markdown**: Delivers a rich text experience that immerses users by transforming Markdown into beautifully formatted messages.\n- 🎚️ **Programmatic Controls (Ref)**: Commands the chat flow with precision, allowing developers to create a tailored conversational experience.\n\n\u003cbr/\u003e\n\n**Design Evolution / In Progress**\n\n- [ ] **Customized Dialogue Rendering with Edit Capabilities** - [issue/21](https://github.com/ant-design/pro-chat/issues/21)\n- [ ] **Enhanced Request Parameters** - The power to infuse additional parameters into your requests is on the horizon\n- [ ] **Personalized Error Handling** - Craft unique fallbacks and configurations for those unexpected moments\n- [ ] **Expanded Documentation \u0026 Globalization** - Access comprehensive guides and international support for a truly borderless experience\n- [ ] **Atomic Component Design** - Anticipate a modular approach to design that promises both simplicity and versatility\n\n\u003cbr/\u003e\n\n## 👀 Showcase\n\nLet's showcase some of ProChat's signature features:\n\n| **Streamlined Dialogue** | **Content Editor** |\n| :-: | :-: |\n| Engage in Streamlined Conversations that flow as naturally as a river | Refine, reshape, and perfect your dialogue with tools that allow for real-time edits. |\n| ![][prevew-1] | ![][prevew-3] |\n| **Integrated Render** |  |\n| Dive into the vivid world of chat with our Built-in Render, a tool designed to bring text to life. |  |\n| ![][prevew-2] |  |\n\n\u003cbr/\u003e\n\n## 🖥 Browser compatibility\n\n\u003e \\[!NOTE]\n\u003e\n\u003e - Modern browsers and Internet Explorer 11 (with [polyfills](https://stackoverflow.com/questions/57020976/polyfills-in-2019-for-ie11))\n\u003e - [Electron](https://www.electronjs.org/)\n\n| [![edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![Edge](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png)](http://godban.github.io/browsers-support-badges/) | [![electron_48x48](https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png)](http://godban.github.io/browsers-support-badges/) |\n| --- | --- | --- | --- | --- |\n| Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |\n\n\u003cbr/\u003e\n\n## ⌨️ Local Development\n\nYou can use Github Codespaces for online development:\n\n[![][github-codespace-shield]][github-codespace-link]\n\nOr clone it for local development:\n\n```bash\n$ git clone https://github.com/ant-design/pro-chat.git\n$ cd pro-chat\n$ pnpm install\n$ pnpm dev\n```\n\n\u003cbr/\u003e\n\n## 🤝 Contributing\n\n\u003e \\[!IMPORTANT]\n\u003e\n\u003e Join our collaborative ecosystem. Your contributions are the heartbeat of our project. Here's how you can be an integral part of our vibrant community:\n\n- **Integrate and Innovate**: Incorporate Ant Design Pro, umi, and ProChat into your projects. Your real-world usage and feedback are invaluable to us.\n- **Voice Your Insights**: Encounter a glitch? Have a query? Your perspectives matter. Share them by submitting [issues][github-issues-link] and help us enhance the user experience.\n- **Shape the Future**: Have code enhancements or feature ideas? We invite you to propose [pull requests][pr-welcome-link] and contribute directly to the evolution of our codebase.\n\nEvery contribution, big or small, is celebrated. Join us in our mission to refine and elevate the world of open-source enterprise UI components. 😃\n\n[![][pr-welcome-shield]][pr-welcome-link]\n\n\u003ca href=\"https://github.com/ant-design/pro-chat/graphs/contributors\" target=\"_blank\"\u003e\n  \u003ctable\u003e\n    \u003ctr\u003e\n      \u003cth colspan=\"2\"\u003e\n        \u003cbr\u003e\u003cimg src=\"https://contrib.rocks/image?repo=ant-design/pro-chat\"\u003e\u003cbr\u003e\u003cbr\u003e\n      \u003c/th\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\n        \u003cimg src=\"https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active\u0026period=past_28_days\u0026owner_id=12101536\u0026repo_ids=707504998\u0026image_size=2x3\u0026color_scheme=dark\"\u003e\n      \u003c/td\u003e\n      \u003ctd rowspan=\"2\"\u003e\n        \u003cimg src=\"https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=active\u0026period=past_28_days\u0026owner_id=12101536\u0026repo_ids=707504998\u0026image_size=4x7\u0026color_scheme=dark\"\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n      \u003ctd\u003e\n        \u003cimg src=\"https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new\u0026period=past_28_days\u0026owner_id=12101536\u0026repo_ids=707504998\u0026image_size=2x3\u0026color_scheme=dark\"\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/table\u003e\n\u003c/a\u003e\n\n\u003cbr/\u003e\n\n## 🛣️ Ecosystem\n\n- **[ProComponents](https://github.com/ant-design/pro-components)** - Designed for Enterprise-Level Application, Use Ant Design like a Pro!.\n- **[ProEditor](https://github.com/ant-design/pro-editor)** - The Ultimate Editor UI Framework and Components.\n- **[ProFlow](https://github.com/ant-design/pro-flow)** - A Flow Editor Framework base on React-Flow.\n- **[ProChat](https://github.com/ant-design/pro-chat)** - Components Library for Quickly Building LLM Chat Interfaces.\n\n\u003cbr/\u003e\n\n---\n\n#### 📝 License\n\nCopyright © 2023 - present [AFX][ant-design-link] \u0026 [Ant Digital](https://antdigital.com). \u003cbr/\u003e This project is [MIT](./LICENSE) licensed.\n\n\u003c!-- LINK GROUP --\u003e\n\n[ant-design-link]: https://ant.design\n[ant-design-shield]: https://img.shields.io/badge/-Ant%20Design-1677FF?labelColor=black\u0026logo=antdesign\u0026style=flat-square\n[codecov-link]: https://codecov.io/gh/ant-design/pro-chat\n[codecov-shield]: https://img.shields.io/codecov/c/github/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\u0026logo=codecov\u0026logoColor=white\n[devops-dumi-link]: https://d.umijs.org/\n[devops-dumi-shield]: https://img.shields.io/badge/docs%20by-dumi-blue?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[devops-father-link]: https://github.com/umijs/father\n[devops-father-shield]: https://img.shields.io/badge/build%20with-father-028fe4.svg?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-action-release-link]: https://github.com/ant-design/pro-chat/actions/workflows/release.yml\n[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/ant-design/pro-chat/release.yml?color=1677FF\u0026label=release\u0026labelColor=black\u0026logo=githubactions\u0026logoColor=white\u0026style=flat-square\n[github-action-test-link]: https://github.com/ant-design/pro-chat/actions/workflows/test.yml\n[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/ant-design/pro-chat/test.yml?color=1677FF\u0026label=test\u0026labelColor=black\u0026logo=githubactions\u0026logoColor=white\u0026style=flat-square\n[github-codespace-link]: https://codespaces.new/ant-design/pro-chat\n[github-codespace-shield]: https://github.com/codespaces/badge.svg\n[github-contributors-link]: https://github.com/ant-design/pro-chat/graphs/contributors\n[github-contributors-shield]: https://img.shields.io/github/contributors/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-forks-link]: https://github.com/ant-design/pro-chat/network/members\n[github-forks-shield]: https://img.shields.io/github/forks/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-issues-link]: https://github.com/ant-design/pro-chat/issues\n[github-issues-shield]: https://img.shields.io/github/issues/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-license-link]: https://github.com/ant-design/pro-chat/blob/main/LICENSE\n[github-license-shield]: https://img.shields.io/github/license/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-releasedate-link]: https://github.com/ant-design/pro-chat/releases\n[github-releasedate-shield]: https://img.shields.io/github/release-date/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[github-stars-link]: https://github.com/ant-design/pro-chat/network/stargazers\n[github-stars-shield]: https://img.shields.io/github/stars/ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026style=flat-square\n[npm-downloads-link]: https://www.npmjs.com/package/@ant-design/pro-chat\n[npm-downloads-shield]: https://img.shields.io/npm/dt/@ant-design/pro-chat?labelColor=black\u0026style=flat-square\u0026color=1677FF\n[npm-release-link]: https://www.npmjs.com/package/@ant-design/pro-chat\n[npm-release-shield]: https://img.shields.io/npm/v/@ant-design/pro-chat?color=1677FF\u0026labelColor=black\u0026logo=npm\u0026logoColor=white\u0026style=flat-square\n[pr-welcome-link]: https://github.com/ant-design/pro-chat/pulls\n[pr-welcome-shield]: https://img.shields.io/badge/%E2%9D%A4%EF%B8%8F%20PR%20WELCOME-%E2%86%92-1677FF?labelColor=black\u0026style=for-the-badge\n[prevew-1]: https://mdn.alipayobjects.com/huamei_re70wt/afts/img/A*0uQhSIzSS3YAAAAAAAAAAAAADmuEAQ/original\n[prevew-2]: https://mdn.alipayobjects.com/huamei_re70wt/afts/img/A*e4JbQKfupVQAAAAAAAAAAAAADmuEAQ/original\n[prevew-3]: https://mdn.alipayobjects.com/huamei_re70wt/afts/img/A*wVSCTb7bq8UAAAAAAAAAAAAADmuEAQ/original\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fant-design%2Fpro-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fant-design%2Fpro-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fant-design%2Fpro-chat/lists"}