Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 3.5 KB

README_EN.md

File metadata and controls

94 lines (68 loc) · 3.5 KB
Raw

magicbox

license Release Version PRs Welcome

English | 简体中文

bk-magic-vue

A UI library base on BlueKing Magicbox and Vue2

Install

$ npm install --save bk-magic-vue

Use

Import All

import bkMagicVue from 'bk-magic-vue'
import 'bk-magic-vue/dist/bk-magic-vue.min.css'
Vue.use(bkMagicVue)

Import necessary components

We need babel-plugin-import-bk-magic-vue to import necessary components.

first, install babel-plugin-import-bk-magic-vue

npm i babel-plugin-import-bk-magic-vue -D

then, you need to add the plugins configuration in the .babelrc file of the project.

// baseLibName is bk-magic-vue package name，the defaults is bk-magic-vue
{
    "presets": ...,
    "plugins": [
        ...
        ["import-bk-magic-vue", {
            "baseLibName": "bk-magic-vue"
        }]
    ]
}

after that, you can import necessary components like this

import { bkButton } from 'bk-magic-vue'
import { bkButton as cc } from 'bk-magic-vue'
import { bkButton, bkDropdownMenu } from 'bk-magic-vue'
import { bkButton as cc, bkDropdownMenu as dd } from 'bk-magic-vue'
console.log(bkButton)
console.log(cc)
console.log(bkDropdownMenu)
console.log(dd)

Develop

npm run dev

Build

npm run build

BlueKing Community

  • BK-CMDB：BlueKing CMDB is an enterprise-level management platform designed for assets and applications.
  • BK-CI：BlueKing Continuous Integration platform is a free, open source CI service, which allows developers to automatically create - test - release workflow, and continuously, efficiently deliver their high-quality products.
  • BK-BCS：BlueKing Container Service is a container-based basic service platform that provides management service to microservice businesses.
  • BK-PaaS：BlueKing PaaS is an open development platform that allows developers to efficiently create, develop, set up, and manage SaaS apps.
  • BK-SOPS：BlueKing SOPS is a system that features workflow arrangement and execution using a graphical interface. It's a lightweight task scheduling and arrangement SaaS product of the Blueking system.
  • BK-JOB：BlueKing JOB is a set of operation and maintenance script management platform with the ability to handle a large number of tasks concurrently.
  • BK-BASE：BlueKing BASE is a basic computing platform focusing on the field of operation and maintenance, creating a one-stop, low-threshold basic service.

Contributing

For bkui-vue2 branch management, issues, and pr specifications, read the CONTRIBUTING(In Chinese)

If you are interested in contributing, check out the [CONTRIBUTING.md], also join our Tencent OpenSource Plan.

License

bkui-vue2 is based on the MIT protocol. Please refer to LICENSE.