wind-stream-ui
v1.0.3
Published
<p align="center"> <img alt="Wind Stream UI Logo" src="https://pub-94f4278f2fdf4cf3bbdc3d78db8bf24e.r2.dev/assets/windstream.png" width="200" style="margin-bottom: 20px;"> </p>
Readme
✨ 特性 (Features)
- 🏗 Monorepo 架构:采用
pnpmworkspace 管理代码,模块解耦,工程化标准对标企业级项目。 - ⚡ 极致性能:基于
Vite构建,支持 ESM/CJS 双产物,配合sideEffects实现精准的 Tree Shaking。 - 🍸 类型安全:全量 TypeScript 编写,提供完整的
.d.ts类型定义,杜绝any类型。 - 💡 DX 友好:支持 Volar 全局组件类型提示(Global Component Typing),编码体验丝滑。
- 🎨 主题定制:基于 CSS Variables 的样式系统,支持动态切换主题与暗黑模式。
- 🔧 自动化流程:集成 Changesets 与 GitHub Actions,实现全自动化的构建、测试与发版流。
📦 安装 (Installation)
# pnpm
pnpm add wind-stream-ui
# npm
npm install wind-stream-ui🔨 快速上手 (Usage)
全量引入 (Full Import)
import { createApp } from 'vue'
import App from './App.vue'
import WindStreamUI from 'wind-stream-ui'
import 'wind-stream-ui/dist/style.css' // 引入样式
const app = createApp(App)
app.use(WindStreamUI)
app.mount('#app')
按需引入 (On-demand Import) - 推荐 🚀借助于 ESM 的 Tree Shaking 特性,你只需要直接引入组件即可:
import { WsButton } from 'wind-stream-ui'
import 'wind-stream-ui/dist/style.css'
💻 本地开发 (Development)本项目采用 Monorepo 架构:
# 1. 克隆项目
git clone [email protected]:NAOXUAN4/wind-stream-ui.git
# 2. 安装依赖 (根目录)
pnpm install
# 3. 启动本地调试环境 (Playground)
pnpm dev
# 4. 构建组件库
pnpm build
License MIT © 2025 Nanyian
