mirror of https://gitee.com/ant-design-vue/ant-design-vue.git synced 2024-12-05 05:29:01 +08:00

2018-04-10 21:44:45 +08:00

4.8 KiB

Raw Blame History

Ant Design of Vue

Following the Ant Design specification, we developed a Vue UI library antd that contains a set of high quality components and demos for building rich, interactive user interfaces.

Features

An enterprise-class UI design language for web applications.
A set of high-quality Vue components out of the box.
Shared Ant Design of React design resources.

Environment Support

Modern browsers and Internet Explorer 9+ (with polyfills)
Server-side Rendering

Version

Stable:

You can subscribe to this feed for new version notifications: https://github.com/vueComponent/ant-design/releases.atom

Installation

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 vue-antd-ui --save

$ yarn add vue-antd-ui

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

Using the new features of vue, like slot-scope(2.5.0+), provide / inject(2.2.0+)

Import in Browser

Add script and link tags in your browser and use the global variable antd.

We provide antd.js antd.css and antd.min.js antd.min.css under vue-antd-ui/dist in antd's npm package. You can also download these files directly from or unpkg.

We strongly discourage loading the entire files this will add bloat to your application and make it more difficult to receive bugfixes and updates. Antd is intended to be used in conjunction with a build tool, such as webpack, which will make it easy to import only the parts of antd that you are using.

Note: you should import moment before using antd.js.

Usage

import Vue from 'vue'
import { DatePicker } from 'vue-antd-ui';
Vue.component(DatePicker.name, DatePicker)

And import stylesheets manually:

import 'vue-antd-ui/dist/antd.css';  // or 'vue-antd-ui/dist/antd.less'

Use modularized antd

Use babel-plugin-import (Recommended)

// .babelrc or babel-loader option
{
  "plugins": [
    ["import", { "libraryName": "vue-antd-ui", "libraryDirectory": "es", "style": "css" }] // `style: true` for less
  ]
}

Note: Don't set libraryDirectory if you are using webpack 1.

This allows you to import components from antd without having to manually import the corresponding stylesheet. The antd babel plugin will automatically import stylesheets.

// import js and css modularly, parsed by babel-plugin-import
import { DatePicker } from 'vue-antd-ui';

Manually import

import DatePicker from 'vue-antd-ui/lib/date-picker';  // for js
import 'vue-antd-ui/lib/date-picker/style/css';        // for css
// import 'vue-antd-ui/lib/date-picker/style';         // that will import less

Contributing

If you'd like to help us improve antd, just create a Pull Request. Feel free to report bugs and issues here.

If you're new to posting issues, we ask that you read How To Ask Questions The Smart Way and How to Ask a Question in Open Source Community and How to Report Bugs Effectively prior to posting. Well written bug reports help us help you!

THANK YOU

Ant Design Team

4.8 KiB Raw Blame History Unescape Escape