@zq-comps/im
v1.0.13
Published
基于Vue 3.5的业务组件库
Readme
Beem Biz UI
基于 Vue 3.5 的业务组件库，支持 TypeScript。
安装
# 使用pnpm
pnpm add beem-biz-ui
# 使用npm
npm install beem-biz-ui使用
全局引入
import { createApp } from 'vue';
import BeemBizUI from 'beem-biz-ui';
import App from './App.vue';
const app = createApp(App);
app.use(BeemBizUI);
app.mount('#app');按需引入
import { createApp } from 'vue';
import { Button } from 'beem-biz-ui';
import App from './App.vue';
const app = createApp(App);
app.component('BizButton', Button);
app.mount('#app');开发
# 安装依赖
pnpm install
# 启动Storybook开发环境
pnpm storybook
# 类型检查
pnpm type-check
# 代码格式化
pnpm format
# 代码检查
pnpm lint
# 样式检查
pnpm stylelint
# 构建组件库
pnpm build
# 构建Storybook文档站
pnpm build-storybook代码规范
本项目使用以下工具来保证代码质量和一致性：
- ESLint: 代码检查工具
- Prettier: 代码格式化工具
- Stylelint: 样式检查工具
- EditorConfig: 编辑器配置
- Husky + lint-staged: Git提交前代码检查
- CommitLint: Git提交信息规范检查
提交代码时请遵循以下commit规范：
<type>(<scope>): <subject>
<body>
<footer>可用的type类型:
feat: 新功能fix: 修复docs: 文档变更style: 代码格式(不影响代码运行的变动)refactor: 重构(既不是增加feature，也不是修复bug)perf: 性能优化test: 增加测试chore: 构建过程或辅助工具的变动revert: 回退build: 打包ci: CI配置
TypeScript 支持
组件库完全使用 TypeScript 开发，提供完整的类型定义文件，支持 IDE 代码提示和类型检查。
VSCode推荐扩展
为了获得最佳的开发体验，建议安装以下VSCode扩展：
- Vue Language Features (Volar)
- ESLint
- Prettier
- EditorConfig
- StyleLint
可用组件
- Button 按钮组件