kb-ui-plus
v1.0.1
Published
Page level components developed based on Element Plus.
Maintainers
wocwinReadme
Kb-ui-Plus
基于 vue3+ ts+ Element-plus 二次封装组件
pnpm 方式安装使用
pnpm i kb-ui-plus --registry=http://219.135.209.147:4873全局注册使用
前提条件：使用项目必须全局注册 Element-plus组件库
// 在main.js中按下引入
import { createApp } from "vue";
import App from "./App.vue";
import ElementPlus from "element-plus";
import "element-plus/dist/index.css";
import "element-plus/theme-chalk/dark/css-vars.css";
import locale from "element-plus/es/locale/lang/zh-cn";
// element-plus图标
import * as ElementPlusIconsVue from "@element-plus/icons-vue";
import KbuiPlus from 'kb-ui-plus'
import 'kb-ui-plus/index.css'
const app = createApp(App)
// 注册所有图标
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
app.component(key, component);
}
// 注册ElementPlus
app.use(ElementPlus, {
locale // 语言设置
// size: Cookies.get('size') || 'medium' // 尺寸设置
});
app.use(TuiPlus)
app.mount('#app')按需引入
// 在main.js中按下引入
import 'kb-ui-plus/index.css'
// 单个.vue文件引入
<script setup lang="ts">
import {TDetail, TForm} from "kb-ui-plus"
</script>浏览器直接引入
直接通过浏览器的 HTML 标签导入 kb-ui-plus，然后就可以使用全局变量 KbuiPlus 了。
根据不同的 CDN 提供商有不同的引入方式， 我们在这里以unpkg 和 jsDelivr 举例。 你也可以使用其它的 CDN 供应商。
unpkg
<head>
<!-- 导入element-plus样式 -->
<link rel="stylesheet" href="//unpkg.com/element-plus/dist/index.css" />
<!-- 导入vue3 -->
<script src="//unpkg.com/vue@3"></script>
<!-- 导入element-plus -->
<script src="//unpkg.com/element-plus"></script>
<!-- 导入t-ui-plus样式 -->
<link rel="stylesheet" href="//unpkg.com/kb-ui-plus/index.css" />
<!--导入t-ui-plus" -->
<script src="//unpkg.com/kb-ui-plus"></script>
</head>jsDelivr
<head>
<!-- 导入element-plus样式 -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/element-plus/dist/index.css" />
<!-- 导入vue3 -->
<script src="//cdn.jsdelivr.net/npm/vue@3"></script>
<!-- 导入element-plus -->
<script src="//cdn.jsdelivr.net/npm/element-plus"></script>
<!-- 导入t-ui-plus样式 -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/kb-ui-plus/index.css" />
<!--导入t-ui-plus" -->
<script src="//cdn.jsdelivr.net/npm/kb-ui-plus"></script>
</head>Vue - Official （Volar）待验证
// 需要在使用的项目的tsconfig.json文件中添加以下
compilerOptions：{
"types": [
"kb-ui-plus/index.d.ts"
],
}
自动按需导入 (暂不支持--待完善)
- 安装插件
pnpm install -D unplugin-vue-components unplugin-auto-import @kb-ui-plus/resolver- 配置
vite.config.ts或者配置webpack(vue).config.js
- 配置
vite.config.ts配置
// vite.config.ts
import { defineConfig } from 'vite'
import AutoImport from 'unplugin-auto-import/vite'
import Components from 'unplugin-vue-components/vite'
import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
import { KbuiPlusResolver } from '@kb-ui-plus/resolver'
export default defineConfig({
// ...
plugins: [
// ...
AutoImport({
resolvers: [ElementPlusResolver()]
}),
Components({
resolvers: [ElementPlusResolver(), KbuiPlusResolver()]
})
]
})vue.config.js配置
const { defineConfig } = require('@vue/cli-service')
const AutoImport = require('unplugin-auto-import/webpack')
const Components = require('unplugin-vue-components/webpack')
const { ElementPlusResolver } = require('unplugin-vue-components/resolvers')
const { KbuiPlusResolver } = require('@kb-ui-plus/resolver')
module.exports = defineConfig({
// ...
configureWebpack: {
plugins: [
// ...
AutoImport({
resolvers: [ElementPlusResolver()]
}),
Components({
resolvers: [KbuiPlusResolver(), ElementPlusResolver()]
})
]
}
})安装依赖
注意: 本地环境版本最好安装 Node.js 18.x+、pnpm 7.x+
npm install -g pnpm
# 安装依赖
pnpm install --registry=https://registry.npmjs.org/
>pnpm config get registry 查看当前指向源
# 如果安装依赖失败，可以尝试使用淘宝镜像 --registry=https://registry.npmmirror.com/
>pnpm config set registry https://registry.npmmirror.com/ 切换淘宝镜像源
>pnpm install
本地运行 vitepress 中组件文档
npm run docs:dev
Git 提交规范
ci: ci 配置文件和脚本的变动;chore: 构建系统或辅助工具的变动;fix: 代码 BUG 修复;feat: 新功能;perf: 性能优化和提升;refactor: 仅仅是代码变动，既不是修复 BUG 也不是引入新功能;style: 代码格式调整，可能是空格、分号、缩进等等;docs: 文档变动;test: 补充缺失的测试用例或者修正现有的测试用例;revert: 回滚操作;