ant-design-vue README

The project's README from github.com/vueComponent/ant-design-vue. As one markdown file: README.md.

Ant Design Vue

An enterprise-class UI components based on Ant Design and Vue.

test codecov npm package NPM downloads backers sponsors extension-for-VSCode issues-helper

Sponsored by
Mentorbook.AI - Your AI Mentor, Your Learning Journey Pireel - Open-source AI video editing agent

English | 简体中文

Features

Getting started & staying tuned with us.

Star us, and you will receive all releases notifications from GitHub without any delay!

star us

Environment Support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
Electron
Electron
Edge last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

Using npm or yarn

We recommend using npm or yarn to install, it not only makes development easier, but also allow you to take advantage of the rich ecosystem of Javascript packages and tooling.

$ npm install ant-design-vue --save
$ yarn add ant-design-vue

If you are in a bad network environment, you can try other registries and tools like cnpm.

Ecosystem

Project Description
vue-ref You can use the callback to get a reference like react
ant-design-vue-helper A vscode extension for ant-design-vue
vue-cli-plugin-ant-design Vue-cli 3 plugin to add ant-design-vue
vue-dash-event The library function, implemented in the DOM template, can use the custom event of the ant-design-vue component (camelCase)
@formily/antdv The Library with Formily and ant-design-vue
@ant-design-vue/nuxt A nuxt module for ant-design-vue
ant-design-x-vue A Vue AI interface solutions base on the Ant Design X design specification

Donation

ant-design-vue is an MIT-licensed open source project. In order to achieve better and sustainable development of the project, we expect to gain more backers. You can support us in any of the following ways:

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

More Sponsor (From Patreon、alipay、wechat、paypal...)

Contributors

Thank you to all the people who already contributed to ant-design-vue!

Let's fund issues in this repository

This project is tested with BrowserStack.

ant-design-vue (vueComponent/ant-design-vue)

vue3
Searching Database…

What is this?An enterprise-class UI component library for Vue, built on the Ant Design design system — one of the most-starred Vue UI kits on GitHub with over 21,000 stars.
So it's the Vue counterpart of Ant Design, not its own separate design system?Exactly: it is a component library — a set of ready-to-use Vue components that reuses the design resources of Ant Design for React, so both ecosystems look and behave the same.
How do I add it to a Vue project?Install it from the npm registry with npm or yarn like any other JavaScript package; the README suggests cnpm if your network is slow.
Do I need Vue 3, or does it work with Vue 2 as well?Both are supported — Vue 2 and Vue 3. For local development you also need Node.js 12.22 or newer.
Can I use it in a server-side rendered app?Yes, server-side rendering is explicitly supported, and the ecosystem includes an official @ant-design-vue/nuxt module for Nuxt projects.
Which browsers will it work in?All modern browsers: the last two versions of Edge, Firefox, Chrome, Safari and Opera. Internet Explorer 9+ is only supported by the older v1.x line, and only with polyfills.
Is it free to use in commercial projects?Yes — it is MIT-licensed open source, and the project is funded through donations on Patreon, OpenCollective and PayPal.
Is there tooling like a VS Code extension or Vue CLI plugin?Yes. The ecosystem ships a VS Code extension (ant-design-vue-helper), a Vue CLI 3 plugin (vue-cli-plugin-ant-design), plus small helpers like vue-ref and vue-dash-event.
Can I build desktop apps with it?Yes — Electron is listed among the supported environments, so the same components work in Electron-based desktop applications.
Does the ecosystem cover AI chat interfaces too?Yes — ant-design-x-vue is a Vue AI interface solution based on the Ant Design X design specification.
Size
33 MB
Stars
21.7K
Age
9y
Commits · 90 Days