Skip to content

Commit

Permalink
* proj: change README.
Browse files Browse the repository at this point in the history
  • Loading branch information
catouse committed Jul 26, 2024
1 parent 6726d79 commit f18e664
Showing 1 changed file with 2 additions and 19 deletions.
21 changes: 2 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

ZUI 3 是一个全新的开源 UI 组件库,提供了丰富的实用组件,并提供自由的定制使用方式,不依赖任何 JavaScript 框架,可以在任何 Web 应用中通过原生的方式使用。

访问 https://easysoft.github.io/zui/3/ 来提前预览组件库。
访问 https://openzui.com/ 来提前预览组件库。

👉 如果你需要访问 ZUI 1,请访问 https://openzui.com/ ,ZUI 1 源码已经转移到 `zui1` 分支。
👉 如果你需要访问 ZUI 1,请访问 https://openzui.com/1/ ,ZUI 1 源码已经转移到 `zui1` 分支。

## 特性

Expand All @@ -14,16 +14,6 @@ ZUI 3 是一个全新的开源 UI 组件库,提供了丰富的实用组件,
* 💎 **强大的 JS 组件**:通过 JS 实现很多功能强大的组件,包括下拉菜单、工具提示、对话框、数据表格、文件上传等;
* 📦 **使用灵活**:不依赖具体的框架,所有 CSS 工具类开箱即用,所有 JS 组件支持原生调用,丰富的引入方式,支持通过 ESM 导入,或者直接在浏览器中引用整个 JS 和 CSS,支持打包定制自己的组合版本。

一些激动人心的新特性正在开发,包括:

* [ ] 交互式的文档示例;
* [ ] 在线演练场;
* [ ] 主题设计器;
* [ ] 设计规范指导文档;
* [ ] 可配置的定制打包机制,支持在线生成打包配置;
* [ ] 适用于 React 和 Preact 的组件库;
* [ ] 通用组件插件机制,允许对所有组件进行扩展。

## 快速预览

### 使用 CSS 工具类
Expand Down Expand Up @@ -88,10 +78,3 @@ $ pnpm docs:build
* TypeScript 4.5+
* 字体图标生成:[Fantasticon](https://github.com/tancredi/fantasticon)
* JS 组件开发 [preact.js](https://preactjs.com/)

## FAQ

* 为何没有 ZUI 2?
* ZUI 3 和 ZUI 1 跨度太大了,所以跳过了大版本号。
* 我可以在项目中使用吗?
* 目前 ZUI 3 处理快速开发中的不稳定状态,如果没有深入了解项目源码,不建议在真实项目中使用,欢迎参与项目开发。

0 comments on commit f18e664

Please sign in to comment.