@breezeui/vue
v0.0.3
Published
轻量、可定制、基于TailwindCSS的Vue3组件库
Maintainers
Readme
BreezeUI
✨ 特性
- ⚡️ 轻量级: 专为性能打造,体积小巧。
- 🎨 TailwindCSS: 基于 TailwindCSS 构建,完全可定制。
- 🔧 TypeScript: 全量 TypeScript 编写,提供优秀的类型推导。
- 🧩 Vue 3: 拥抱 Vue 3 Composition API。
- 🌲 按需引入: 支持 Tree Shaking,只打包你用到的代码。
📦 安装
推荐使用 pnpm 进行安装。
pnpm add @breezeui/vue或者使用 yarn / npm。
yarn add @breezeui/vue
# or
npm install @breezeui/vue🚀 快速上手
全局引入
在你的 main.ts 或 main.js 入口文件中:
import { createApp } from 'vue';
import App from './App.vue';
import BreezeUI from '@breezeui/vue';
import '@breezeui/vue/dist/index.css'; // 引入样式
const app = createApp(App);
app.use(BreezeUI);
app.mount('#app');按需引入 (推荐)
配合 unplugin-vue-components 实现自动按需引入。
首先安装插件。
pnpm add -D unplugin-vue-components然后配置 vite.config.ts。
// vite.config.ts
import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import Components from 'unplugin-vue-components/vite';
import { BreezeUIResolver } from '@breezeui/vue';
export default defineConfig({
plugins: [
vue(),
Components({
resolvers: [BreezeUIResolver()],
}),
],
});注意:使用按需引入时,建议在入口文件(如
main.ts)中引入一次全局样式import '@breezeui/vue/dist/style.css',或者配置 Resolver 的importStyle选项(需确保 CSS 文件路径正确)。
🔨 开发
# 安装依赖
pnpm install
# 启动开发环境
pnpm dev
# 构建
pnpm build
# 运行测试
pnpm test
# 发布 (需要发布权限)
pnpm release📄 License
MIT License © 2024-PRESENT BL
