peach-x
v1.0.20
Published
A Simple, Fast Vue 3 Component Library built with TypeScript
Readme
✨ 特性
- 🌸 默认车厘子色主题,清新优雅
- ⚙️ 支持按需引入与全局注册
- 🎨 自定义主题支持,可通过
CSS覆盖默认样式 - 📦 支持
Vite/Vue CLI项目 - 🧩 组件灵活扩展,适合二次封装
- 🌍 内置国际化支持(可选)
📦 安装
使用 pnpm / yarn / npm 安装:
# Using npm
npm install peach-x
# Using yarn
yarn add peach-x
# Using pnpm
pnpm add peach-x🛠 使用方式
// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import PeachX from 'peach-x'
import 'peach-x/theme/style.css' // 引入默认主题样式
const app = createApp(App)
app.use(PeachX)
app.mount('#app')然后你可以在 Vue 文件中使用组件:
<template>
<p-button>Click me</p-button>
</template>🧩 Volar 支持
如果您使用 Volar,请在 tsconfig.json 中通过 compilerOptions.types 指定全局组件类型。
"compilerOptions": {
"types": ["peach-x/global"]
}使用组件时会自动识别出组件的类型并提供 IDE 提示。
📚 文档
完整文档请访问:https://www.peach-x.com
🌐 浏览器支持
Peach X 支持现代浏览器以及 IE11 及以上版本(需额外引入 polyfill)。
💖 贡献指南
我们欢迎任何形式的贡献!
📄 License
Peach X is open source software licensed as MIT.
