Skip to content

Aiyoumi-FE/aym-ui

Repository files navigation

Build Status Commitizen friendly

爱又米专用VUE组件库。

aym-ui 是基于Vue 的移动端组件库

文档

文档地址

示例地址

使用说明

安装

npm install aym-ui --save

使用

全量使用

import aymUI from 'aym-ui'  
import 'aym-ui/index.css'
Vue.use(aymUI) 

按需引入

需要安装插件babel-plugin-component

npm i babel-plugin-component -D

使用方法

import { Button } from 'aym-ui'

配置.babelrc

"plugins": [
        "transform-runtime", [
            "component",
            {
                "libraryName": "aym-ui",
                "libraryDirectory": "lib",
                "style": true
            }
        ]
    ]

开发说明

  • 组件源码目录:src/components
  • demo目录: examples
  • document: document

构建说明

  • npm run dev 运行examples,调用src/index.js组件出口,组件修改后可以实时预览
  • npm run build:demo 构建demo和docs文件到dist目录
  • npm run build:mui 构建js,通过src/index.js打包到libs目录
  • npm run build 包含npm run build:muinpm run build:modules两个个命令
  • npm run deploy:docs 打包demo和docs 并推送到github
  • npm run new xx 在examples/pages、document/components/docs 和 src/components 目录下分别加入组件空模版