Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 6.81 KB

README.zh-CN.md

File metadata and controls

87 lines (57 loc) · 6.81 KB

Vexip UI

高可定制化的属性值,全量的 TypeScript,性能应该还不错

如果你用 Vexip UI 写了一些很酷的东西,你都可以告诉我!如果你可以并愿意贡献代码,非常欢迎!

中文 | English

Vexip UI 提供了一系列开箱即用的组件。

该组件库使用全新的 组合式 Api 编写,并尽可能采用 Vue 传统的方式设计和编写组件,全量的 TypeScript(不是 AnyScript)。

每个组件几乎所有的 属性默认值 均可以通过注入配置快速修改(除了值和选项属性),轻松实现定制化。

目前有 70 多个组件,一些你几乎看烂了的组件这里大多有,或许也有一些你不太常见的组件。

工作清单

  • 迁移至 css 变量(已在 2.0.0-beta.0 发布)
  • 重构图标(已在 2.0.0-beta.0 发布)
  • 重构全局配置(已在 2.0.0-beta.4 发布)
  • 编写单元测试(进行中,见 tests 分支)
  • 适配 ssr 渲染

特性

  • 还算多的组件和功能,为网站开发助力,希望能提高点效率
  • 开箱即用 Vue3 组件(如果你还在用 Vue2,这里可能帮不到你)
  • 可配置的 属性默认值,轻松实现定制化
  • 完全使用组合式 Api 编写,性能与拓展性应该还不错

安装

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

# 使用 pnpm
pnpm install vexip-ui

# 使用 yarn
yarn add vexip-ui

文档

这里 可以查看在线文档。

帮助

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

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

贡献

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

兼容环境

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

但我一个人精力有限,现在也还没开始写单元测试,所以有问题的话不要骂我,给我提点 issue 和 PR 吧。

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 授权。