Install

npm install vimi-ui -S

Quick Start

Global Use

import Vue from 'vue'
import vimi from 'vimi-ui'
import "vimi-ui/lib/styles/index.css";

Vue.use(vimi)

On-demand Loading

Firstly, you should install babel-plugin-component in your project.

npm i babel-plugin-component -D

Then, configure your .babelrc file like this

{
  "plugins": [
    [
      "component",
      {
        "libraryName": "vimi-ui",
        "styleLibrary": {
          "name": "styles",
          "base": false
        }
      }
    ]
  ]
}

Finally, you can import component on demand, and you don't need to care about importing styles, the babel plugin will do it automaticly.

import Vue from 'vue'
import { Button } from 'vimi-ui'

Vue.component(Button.name, Button)

Development

You can clone this project to the local and run it.

git clone https://github.com/csdoker/vimi-ui.git
cd vimi-ui
npm install
npm run serve

Todo List

• [x] Button
• [x] Checkbox
• [x] Input
• [x] Switch
• [x] Icon
• [x] Tabs
• [x] Pager
• [x] Carousel
• [ ] Tree
• [ ] Preview demo and docs online
• [ ] Use Vue3 to refactor component（Doing and need help）
• [ ] Support TypeScript
• [ ] Component unit testing ...

Reference

This project references some other UI libraries, including design and code. Thanks to these open source community contributors.

• Element
• Ant Design
• iView
• wheels
• qing
• yu.js.ui
• xy-ui
• gulu
• layui
• bootstrap