Model or dataset
wzc520pyfm/ant-design-x-vue avatar
wzc520pyfm/ant-design-x-vue

ant-design-x-vue: Ant Design X for Vue, Reviewed for Adoption

Ant Design X For Vue. 🔥

1,834 stars132 forksTypeScriptMIT

At a glance

What is it?
ant-design-x-vue ports the Ant Design X component set to Vue 3, covering AI chat surfaces such as bubbles and senders. The README documents npm installation and a two-component example; the rest of the adoption picture has to be assembled from the repository layout.
Who is it for?
Adopt ant-design-x-vue if your application is already on Vue 3.5 or newer with ant-design-vue and you want Ant Design X's AI interaction components without moving to React. Do not adopt it if you need long-term API stability, if your app is on Vue 2, or if you cannot carry a second peer dependency next to your existing Ant Design Vue install.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 1 day ago.
What is it written in?
Mainly TypeScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on September 16, 2026, and from our analysis. They are not legal advice.

DEEP OPEN-SOURCE ANALYSIS

What ant-design-x-vue solves, and who should care

Building an AI chat interface in Vue usually means assembling a message list, an input box with a send button, loading and streaming states, and markdown rendering for model output. None of that is difficult on its own. The cost is in the details: keeping the input height in sync with content, showing a stop button while a response streams, and making the whole thing match the rest of your design system.

ant-design-x-vue packages those pieces as Vue components. The README describes it as "Ant Design X For Vue" and lists features including coverage of most AI conversation scenarios, easy connection to OpenAI-compatible model services, data stream management, TypeScript types, and fine-grained style control. The audience is narrow and clear: teams already using Ant Design Vue who want the AI-specific layer on top of it, rather than a general-purpose component library. If your product has no conversational surface, this library adds a dependency you will not exercise.

The component model behind Ant Design X in Vue

The README example imports two named exports, Bubble and XProvider, from the package. Bubble renders a single message; XProvider wraps the tree. That pairing is the visible part of the architecture: presentational components for chat elements, plus a provider that carries shared context.

The repository layout supports this reading. src/ holds the components, resolver/ is a separate build target for on-demand import resolution, docs/ is a VitePress site, and play/ is a Vite playground. The build script runs three tasks in parallel: build:es, build:dist and build:resolver. The package exports map confirms three entry points, a main module, ./dist/style.css for styles, and ./resolver. The presence of a resolver entry means tree-shaking is treated as a first-class concern rather than an afterthought. The README also claims data stream management, but it does not show the API for it, so the streaming surface is something you have to read the docs site to understand.

Installing ant-design-x-vue and rendering a first bubble

The README gives the install command for npm, yarn and pnpm. ant-design-vue is a peer dependency, so both packages go in together. The npm form is:

bash
npm i ant-design-vue ant-design-x-vue

After that, the README's sample imports Bubble and XProvider and renders a single bubble with static content:

html
<script setup lang="ts">
import { Bubble, XProvider } from 'ant-design-x-vue';
</script>

<template>
  <Bubble content="Hello AI" />
</template>

Run your dev server and you should see a message bubble containing the text. This is the smallest possible check that the package resolved and the component registered. Note that the example does not import the style file; the exports map exposes ./dist/style.css separately, so if the bubble renders unstyled, that import is the first thing to look at. The README does not spell out whether styles are injected automatically in every build mode, and it does not show how to wire Bubble to a live model response. For that, the docs site linked in the README is the only documented path.

Where this library will not help you

The README does not document a compatibility matrix for Vue versions beyond a badge reading Vue >= 3.5. That is a hard floor, not a suggestion. Projects still on Vue 2, or on a Vue 3 release below 3.5, cannot use the package as published.

A second limitation is the peer dependency on ant-design-vue. If your application already pins an older Ant Design Vue version, adding this package means reconciling two version constraints, and the README offers no guidance on which ant-design-vue releases are supported. The README also does not document rollback, deprecation policy, or a migration path between major versions, and it does not state a support window. The changelog file exists in the repository, but the README does not tell you what guarantee it carries. Treat the version you install as something to pin deliberately rather than float.

How it differs from Ant Design X for React

The obvious alternative is Ant Design X itself, the React implementation, which the README links to directly. The difference is not in the component concepts, which the Vue port mirrors, but in the runtime and the ecosystem around it. Choosing the React version means your application is written in React and can use the original project's documentation, issue history and release cadence as the reference point. Choosing ant-design-x-vue means staying in Vue and accepting that this port is the reference point instead.

That distinction matters at upgrade time. When the React project changes a component's API, the Vue port has to follow, and the README does not describe how quickly or how faithfully that happens. The repository does carry a Roadmap link in its contributing section, which is the place to check what is planned rather than what exists. If your team has no Vue constraint, the React implementation is the upstream and therefore the lower-risk choice. If your application is Vue, the port is the only option in this family.

Maintenance, releases and licence

The repository is not archived, and its last push was on 2026-09-15. Releases are tagged: v1.4.0 on 2025-12-01, v1.5.0 on 2025-12-09, and v1.6.0 on 2026-01-05, while package.json reports version 1.6.0. The gap between the latest release and the most recent push means work has continued on main without a new tag, which is worth knowing before you assume a fix is in a published version.

The release script chains tests, changelogen, npm publish and a tag push, so tagged releases are the intended distribution channel. The package is MIT licensed. In practical terms that permits commercial use and modification with the licence text retained, but it also means there is no warranty and no obligation on the maintainer to fix anything. The README does not state a support commitment, so the maintenance cost you are accepting is the cost of tracking a changelog and re-testing your chat surface on each upgrade.

Editorial conclusion

Adopt ant-design-x-vue if your application is already on Vue 3.5 or newer with ant-design-vue and you want Ant Design X's AI interaction components without moving to React. Do not adopt it if you need long-term API stability, if your app is on Vue 2, or if you cannot carry a second peer dependency next to your existing Ant Design Vue install. Verify the Vue version in your package.json, confirm that each component you plan to use is exported from the current release, and check the changelog for breaking changes before pinning.

Frequently asked questions

How do I install ant-design-x-vue?

Install it together with its peer dependency using npm i ant-design-vue ant-design-x-vue, or the equivalent yarn add or pnpm add command from the README. Both packages are required.

Which Vue version does ant-design-x-vue require?

The README carries a badge reading Vue >= 3.5, so Vue 3.5 or newer is the documented floor. The README does not give a compatibility matrix beyond that.

Can I use ant-design-x-vue to connect to an OpenAI-compatible model service?

The README lists easy connection to OpenAI-standard model inference services and data stream management among the features. It does not show the streaming API, so the docs site is where you would confirm the exact interface before committing.

Official sources

  1. License: MIT
  2. Project website
  3. README
  4. Releases
  5. wzc520pyfm/ant-design-x-vue on GitHub
Community notes

Community notes