Quick Start

This section describes how to use Vue Business Kit in your project.

Usage

Full Import

If you don’t care about the bundle size so much, it’s more convenient to use full import.

import { createApp } from "vue"
import VueBusinessKit from "vue-business-kit"
import "vue-business-kit/dist/index.css"
import App from "./App.vue"

const app = createApp(App)
app.use(VueBusinessKit)
app.mount("#app")

Volar support

If you use volar, please add the global component type definition to compilerOptions.types in tsconfig.json.

{
  "compilerOptions": {
    // ...
    "types": ["vue-business-kit"]
  }
}

On-demand Import

You need to use an additional plugin to import components you used.

Auto import Recommend

First you need to install unplugin-vue-components and unplugin-auto-import.

npm

$ npm install -D unplugin-vue-components unplugin-auto-import

yarn

$ yarn add -D unplugin-vue-components unplugin-auto-import

pnpm

$ pnpm install -D unplugin-vue-components unplugin-auto-import

Then add the code below into your Vite or Webpack config file.

Vite

import { defineConfig } from "vite"
import AutoImport from "unplugin-auto-import/vite"
import Components from "unplugin-vue-components/vite"
import { VueBusinessKitResolver } from "vue-business-kit"

export default defineConfig({
  // ...
  plugins: [
    // ...
    AutoImport({
      resolvers: [VueBusinessKitResolver()]
    }),
    Components({
      resolvers: [VueBusinessKitResolver()]
    })
  ]
})

Webpack

const AutoImport = require("unplugin-auto-import/webpack")
const Components = require("unplugin-vue-components/webpack")
const { VueBusinessKitResolver } = require("vue-business-kit")

module.exports = {
  // ...
  plugins: [
    AutoImport({
      resolvers: [VueBusinessKitResolver()]
    }),
    Components({
      resolvers: [VueBusinessKitResolver()]
    })
  ]
}

For more bundlers (Rollup, Vue CLI) and configs please reference unplugin-vue-components and unplugin-auto-import.

Manually import

Vue Business Kit provides out of box Tree Shaking functionalities based on ES Module.

<template>
  <ep-button>I am BkButton</e-button>
</template>

<script>
import { BkButton } from "vue-business-kit"

export default {
  components: { BkButton }
}
</script>

Global Configuration

When registering Vue Business Kit, you can pass a global config object with size and zIndex to set the default size for form components, and zIndex for popup components, the default value for zIndex is 2000.

Full import:

import { createApp } from "vue"
import VueBusinessKit from "vue-business-kit"
import App from "./App.vue"

const app = createApp(App)
app.use(VueBusinessKit, { size: "small", zIndex: 3000 })

On-demand:

<template>
  <el-config-provider :size="size" :z-index="zIndex">
    <app />
  </el-config-provider>
</template>

<script>
import { defineComponent } from "vue"
import { ElConfigProvider } from "element-plus"

export default defineComponent({
  components: {
    ElConfigProvider
  },
  setup() {
    return {
      zIndex: 3000,
      size: "small"
    }
  }
})
</script>

Let's Get Started

You can bootstrap your project from now on. For each components usage, please refer to the individual component documentation.