@hg-ui/big-data-design v1.1.4

快速上手

如何在项目中使用 big-data-design

引入 big-data-design

你可以引入整个 big-data-design，或是根据需要仅引入部分组件。我们先介绍如何引入完整的 big-data-design。

完整引入

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

import Vue from 'vue';
import SnDesign from '@hg-ui/big-data-design';
import '@hg-ui/big-data-design/lib/theme-chalk/index.css';
import App from './App.vue';

Vue.use(SnDesign);

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

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

按需引入

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

首先，安装 babel-plugin-component：

npm install babel-plugin-component -D

然后，将 .babelrc 修改为：

{
  "presets": [
    [
      "env",
      {
        "modules": false,
        "targets": {
          "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
        }
      }
    ],
    "stage-2"
  ],
  "plugins": [
    "transform-vue-jsx",
    "transform-runtime",
    [
      "component",
      {
        "libraryName": "@hg-ui/big-data-design",
        "styleLibraryName": "theme-chalk"
      }
    ]
  ]
}

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

import Vue from 'vue';
import { Button, Input } from '@hg-ui/big-data-design';
import App from './App.vue';

Vue.component(Button.name, Button);
Vue.component(Input.name, Input);
/* 或写为
 * Vue.use(Button)
 * Vue.use(Input)
 */

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

全局配置

在引入 SnUIElement 时，可以传入一个全局配置对象。该对象目前支持 size 与 zIndex 字段。size 用于改变组件的默认尺寸，zIndex 设置弹框的初始 z-index（默认值：2000）。按照引入 SnUIElement 的方式，具体操作如下：

完整引入 SnUIElement：

import Vue from 'vue';
import SnDesign from '@hg-ui/big-data-design';
Vue.use(SnDesign, { size: 'small', zIndex: 3000 });

按需引入 Element：

import Vue from 'vue';
import { Button } from '@hg-ui/big-data-design';

Vue.prototype.$SNDESIGN = { size: 'small', zIndex: 3000 };
Vue.use(Button);

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

开始使用

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