介绍

Miracle UI 是一个轻量、可定制的移动端组件库，于 2024 年开源，目前正在努力开发中，欢迎感兴趣的小伙伴一起参与贡献。

特性

• 🚀 性能极佳，组件平均体积小于 1KB（min+gzip）
• 🚀 高质量组件，覆盖移动端主流场景
• 🚀 零外部依赖，不依赖三方 npm 包
• 💪 使用 TypeScript 编写，提供完整的类型定义
• 💪 单元测试覆盖率超过 90%，提供稳定性保障
• 📖 提供丰富的中英文文档和组件示例
• 🍭 支持按需引入和 Tree Shaking
• 🍭 支持无障碍访问（持续改进中）
• 🍭 支持深色模式

脚手架

开发中，暂不支持使用脚手架创建项目， 敬请期待！

推荐使用 Rsbuild 来创建一个脚手架项目。

Rsbuild 是基于 Rspack 的构建工具，由 Vant 作者开发，具备一流的构建速度和开发体验。

你可以通过以下命令创建一个 Rsbuild 项目：

npm create rsbuild@latest

请访问 Rsbuild 仓库 了解更多信息。

快速上手

请阅读快速上手章节，通过该章节你可以了解到 Miracle UI 的安装方法和基本使用姿势。

浏览器支持

支持现代浏览器以及 Android >= 4.0、iOS >= 8.0。

支持现代浏览器以及 Chrome >= 51、iOS >= 10.0（与 Vue 3 一致）。

维护状态

目前 Miracle 各个版本的维护状态如下：

| 名称 | 框架 | 发布时间 | 最新版 | 维护状态 | | --- | --- | --- | --- | --- | | Miracle UI 1 | Vue 3 | 2024.3 | | 开发中，持续迭代新功能 |

链接

生态

由 Miracle 团队维护的项目如下：

| 项目 | 描述 | | --- | --- | | vite-vue3-h5-template | 基于 vue3 的移动端项目模板 | | vite-react-h5-template | 基于 react 的移动端项目模板 |

其他链接

• 意见反馈
• 更新日志
• 码云镜像仓库

贡献

核心团队

以下是 Miracle UI 的核心贡献者们：

| | | | | | | | :-: | :-: | :-: | :-: | :-: | :-: | | Tom Cat | | | | | |

贡献指南

贡献代码请阅读我们的贡献指南。

使用过程中发现任何问题都可以提 Issue 给我们，当然，我们也非常欢迎你给我们发 PR。

开源协议

本项目基于 MIT 协议，请自由地享受和参与开源。