Skip to content

Latest commit

 

History

History
117 lines (77 loc) · 7.93 KB

README.zh-CN.md

File metadata and controls

117 lines (77 loc) · 7.93 KB
Raw

Vexip UI

Vexip UI

高度可定制化，全量 TypeScript，性能很不错

npm 版本 commits pre week

如果你用 Vexip UI 写了一些很酷的东西，并希望在官网展示，可以联系我，如果你想要贡献代码，非常欢迎！

中文 [含技术支持群] | English

Vexip (发音为 /ˈvesɪp/) UI 提供了一系列开箱即用的组件。

组件库使用全新的 组合式 API 编写，并尽可能采用 Vue 传统的方式设计和编写组件，全量的 TypeScript。

每个组件几乎所有的 属性默认值 均可以通过注入配置快速修改，轻松实现定制化。

同时，组件代码的编写非常注重降低 源码阅读 的门槛，代码的排布尽可能的贴近平时的业务代码的习惯，拒绝花里胡哨。

目前有 78 个组件，一些你几乎看烂了的组件这里都有并且更优秀，也有一些新颖的组件。

特性

  • 📦 高质量的开箱即用 Vue 3 组件
  • 📐 遵循直觉的、简约的 Api 设计
  • 🔧 自由配置的属性默认值，快速完成全局/局部修改
  • ⚡ 组合式 Api，良好的性能基础
  • 🔨 TypeScript 编写，完整的类型
  • 💪 1100+ 单元测试，为组件的提供良好的稳定性
  • 🎨 支持 CSS 变量，内置暗黑主题
  • 🚩 支持国际化
  • 🛫 配套 Resolver，支持 unplugin 插件
  • 🚤 支持 SSR
  • 🩹 优秀的可访问性
  • 👀 贴近业务代码编排，低源码阅读门槛

设计令牌基于 Open Color，并进行了一些调整。

安装

推荐使用 pnpm 或 yarn 的方式进行安装:

# 使用 pnpm
pnpm add vexip-ui

# 使用 yarn
yarn add vexip-ui

文档

这里 可以查看在线文档。

作者的英语很差，如果你有任何改进英语文档的建议，可以创建一个 issue 或 PR。

帮助

在 issue 给我留言，以便第一时间获得帮助。

如果你遇到可能是 bugs 的问题，请使用 Vexip UI Playground 提供一个最小的复现。

你也可以扫下方的二维码加入技术交流 QQ 群（点击也可以）：

Vexip UI QQ 群

贡献

欢迎你的加入！你可以查阅 贡献指南 了解如何开始。

或者你可以赞助我们以帮助项目更好的发展！

微信：

微信收款

支付宝：

支付宝收款

贡献者

感谢他们的所做的一切贡献！

贡献者

兼容环境

所有组件兼容现代浏览器，尽量保证近两三个版本的支持。

IE / Edge
Edge		 Firefox
Firefox		 Chrome
Chrome		 Safari
Safari		 iOS Safari
iOS Safari		 Opera
Opera		 Electron
Electron
last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions last 2 versions

授权

所有文件都基于 MIT 授权。