vexip-ui
Version:
A Vue 3 UI library, Highly customizability, full TypeScript, performance pretty good
118 lines (77 loc) • 8.11 kB
Markdown
<p align="center">
<a href="https://www.vexipui.com/" target="_blank" rel="noopener noreferrer">
<img src="./docs/public/vexip-ui.svg" width="180" alt="Vexip UI" style="width: 180px;" />
</a>
</p>
<h1 align="center">Vexip UI</h1>
<p align="center">
高度可定制化,全量 TypeScript,性能很不错
</p>
<p align="center">
<a href="https://www.npmjs.com/package/vexip-ui" target="_blank">
<img src="https://img.shields.io/github/package-json/v/vexip-ui/vexip-ui" alt="npm 版本"/>
</a>
<a href="https://github.com/vexip-ui/vexip-ui/commits/main" target="_blank">
<img src="https://img.shields.io/github/commit-activity/w/vexip-ui/vexip-ui" alt="commits pre week"/>
</a>
</p>
<p align="center">
如果你用 Vexip UI 写了一些很酷的东西,并希望在官网展示,可以联系我,如果你想要贡献代码,非常欢迎!
</p>
**中文 [含技术支持群]** | [English](./README.md)
Vexip (发音为 `/ˈvesɪp/`) UI 提供了一系列开箱即用的组件。
组件库使用全新的 **组合式 API** 编写,并尽可能采用 Vue 传统的方式设计和编写组件,全量的 **TypeScript**。
每个组件几乎所有的 **属性默认值** 均可以通过注入配置快速修改,轻松实现定制化。
同时,组件代码的编写非常注重降低 **源码阅读** 的门槛,代码的排布尽可能的贴近平时的业务代码的习惯,拒绝花里胡哨。
目前有 **78** 个组件,一些你几乎看烂了的组件这里都有并且更优秀,也有一些新颖的组件。
## 特性
- 📦 高质量的开箱即用 Vue 3 组件
- 📐 遵循直觉的、简约的 Api 设计
- 🔧 自由配置的属性默认值,快速完成全局/局部修改
- ⚡ 组合式 Api,良好的性能基础
- 🔨 TypeScript 编写,完整的类型
- 💪 1100+ 单元测试,为组件的提供良好的稳定性
- 🎨 支持 CSS 变量,内置暗黑主题
- 🚩 支持国际化
- 🛫 配套 Resolver,支持 unplugin 插件
- 🚤 支持 SSR
- 🩹 优秀的可访问性
- 👀 贴近业务代码编排,低源码阅读门槛
> 设计令牌基于 Open Color,并进行了一些调整。
## 安装
推荐使用 pnpm 或 yarn 的方式进行安装:
```sh
# 使用 pnpm
pnpm add vexip-ui
# 使用 yarn
yarn add vexip-ui
```
## 文档
[这里](https://www.vexipui.com) 可以查看在线文档。
> 作者的英语很差,如果你有任何改进英语文档的建议,可以创建一个 issue 或 PR。
## 帮助
在 [issue](https://github.com/vexip-ui/vexip-ui/issues) 给我留言,以便第一时间获得帮助。
如果你遇到可能是 bugs 的问题,请使用 [Vexip UI Playground](https://play.vexipui.com/) 提供一个最小的复现。
你也可以扫下方的二维码加入技术交流 QQ 群(点击也可以):
<a href="https://jq.qq.com/?_wv=1027&k=5KlA84xG" target="_blank">
<img src="./docs/public/vexip-ui-qq-group-qrcode.webp" alt="Vexip UI QQ 群" style="width: 240px;" />
</a>
## 贡献
欢迎你的加入!你可以查阅 [贡献指南](./CONTRIBUTING.md) 了解如何开始。
或者你可以赞助我们以帮助项目更好的发展!
微信:
<img src="./docs/public/sponsor-wechat.webp" alt="微信收款" style="width: 240px;" />
支付宝:
<img src="./docs/public/sponsor-alipay.webp" alt="支付宝收款" style="width: 240px;" />
## 贡献者
感谢他们的所做的一切贡献!
<a href="https://github.com/vexip-ui/vexip-ui/graphs/contributors">
<img src="https://contrib.rocks/image?repo=vexip-ui/vexip-ui" alt="贡献者" />
</a>
## 兼容环境
所有组件兼容现代浏览器,尽量保证近两三个版本的支持。
| [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/electron/electron_48x48.png" alt="Electron" width="24" height="24" />](http://godban.github.io/browsers-support-badges/)<br/>Electron |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions | last 2 versions |
## 授权
所有文件都基于 [MIT](./LICENSE.md) 授权。