MiniEx UI

MiniEx-UI

命名由来

MiniEx 取自 Minimal and Exquisite，意义为极简精致。

项目简介

• 项目组件库致力于打造为极简且精致的形式面向用户

• 项目组件仍处于开发过程中，因此不建议引用本项目的组件用于实际业务场景中

The project component library is intended to be Minimal and Exquisite for the user

The project components are still under development, so it is not recommended to reference the components of the project for use in real business scenarios

项目技术栈

React、TypeScript、Less、MDX

项目实现功能

💎 极简的UI呈现、较好的性能、较完备的基础组件

🎉 从"0"搭建项目架构（无依赖任何现成的组件文档库，整合UI组件库和文档站，统一编写）

⚡️ 本地开发场景优化，区分本地、生产环境

🚀 支持MDX（React in Markdown）快速编写文档站

🌗 支持黑夜/白天主题动态切换

🇨🇳 支持中/英文国际化语言切换

🎨 全局公共样式统一，@mixin支持

✏️ 支持CHANGELOG.md记录更新项

🎯 引入jest编写组件单测用例，保证代码稳定性

💬 Vercel构建文档站，master分支commit自动触发站点更新

🔍 支持全文档快速搜索

🔒 开发规范保证（各类lint校验）

📌 项目待办

1. 组件开发完善

2. jest单测覆盖率达100%

3. 新建组件的开发提效（node脚本）

4. 类码上掘金、codepen、codesandbox，支持在线实时编辑代码，便于用户调试

5. 文档站兼容移动端（@media）

   ...

页面展示

白天Light

黑夜Dark

目录注释

├── docs/             # 文档相关
│ └── config.json     # 文档配置文件，待定
├── src/              # 源码
│ ├── components/     # 组件
|  ├── button/
|   ├── demo/         # demo 目录
|   ├── style/        # 组件样式
|   ├── button.md     # 组件文档
|   ├── index.ts      # 组件入口
|   └── type.ts       # 组件 props 类型定义
|  ├── input/
|  └── ...
| ├── utils/          # util 方法
| ├── hooks/          # hooks
| ├── styles/         # 全局主题样式
| ├── index.less      # NPM 样式入口
│ └── index.ts        # NPM 入口
├── .eslintrc.js      # eslint 配置文件
├── .npmrc
├── package.json
└── tsconfig.json     # typescript 配置文件

如何使用组件库

使用npm安装依赖

npm install miniex-ui --save

引入组件使用

import { ComponentName } from 'miniex-ui'

如何使用项目

项目安装依赖

pnpm i

项目文档站开发环境启动

pnpm run dev

项目文档站生产环境启动

pnpm run start

单测用例

如何为项目编写单测用例

关于我们

tsja2001

Junlingon

Whiskeyi

Lorde

Liny777

MirrorChild

palax0

• 本项目由MiniEx团队共同开发。项目的团队成员来自中国各地，有研究生、即将毕业的本科生、本科入学不久的在校生...

• 我们会及时解决Issues，也欢迎向我们提任何Issues（请准确描述所遇到的问题）

Licensed

MIT.