快速上手

本节将介绍如何在项目中使用 By Components。

完整引入

在 main.js 中写入以下内容：

import Vue from 'vue'
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
import ByComponents from '@weitutech/by-components'
import '@weitutech/by-components/lib/index.css'
import App from './App.vue'

Vue.use(ElementUI)
Vue.use(ByComponents)

new Vue({
  el: '#app',
  render: h => h(App)
})

以上代码便完成了 By Components 的引入。需要注意的是，样式文件需要单独引入。

按需引入

借助 babel-plugin-component，我们可以只引入需要的组件，以达到减小项目体积的目的。

首先，安装 babel-plugin-component：

npm install babel-plugin-component -D

然后，将 .babelrc 修改为：

{
  "presets": [["es2015", { "modules": false }]],
  "plugins": [
    [
      "component",
      {
        "libraryName": "@weitutech/by-components",
        "styleLibraryName": "theme"
      }
    ]
  ]
}

接下来，如果你只希望引入部分组件，比如 ByTable 和 ByPager，那么需要在 main.js 中写入以下内容：

import Vue from 'vue'
import { ByTable, ByPager } from '@weitutech/by-components'
import App from './App.vue'

Vue.component(ByTable.name, ByTable)
Vue.component(ByPager.name, ByPager)
/* 或写为
 * Vue.use(ByTable)
 * Vue.use(ByPager)
 */

new Vue({
  el: '#app',
  render: h => h(App)
})

全局配置

在引入 By Components 时，可以传入一个全局配置对象。该对象目前支持 size 与 zIndex 字段。size 用于改变组件的默认尺寸，zIndex 设置弹框的初始 z-index（默认值：2000）。

import Vue from 'vue'
import ByComponents from '@weitutech/by-components'
Vue.use(ByComponents, { size: 'small', zIndex: 3000 })

按照以上设置，项目中所有拥有 size 属性的组件的默认尺寸均为 'small'，弹框的初始 z-index 为 3000。

开始使用

至此，一个基于 Vue 和 By Components 的开发环境已经搭建完毕，现在就可以编写代码了。各个组件的使用方法请参阅它们各自的文档。