README.md

Monki UI

Monki UI，是一款基于 Dumi，由 React + TypeScript 开发的个人组件库 🎉。

该开源项目是我为进阶 React，同时探索组件库设计开发思路所做的，故不可用于生产环境。由于个人设计能力有限，故 UI 设计方面会大量参考Ant Design 组件库，同时组件的使用方式也会参照 Ant Design 进行实现。如果你也想学习组件开发，欢迎加入或提供意见，你的 star ⭐，是对我最大的鼓励。

✨ 特性

• 🌈 提炼组件库设计良好的视觉风格
• 📦 渐进式探索高质量的前端代码的实现
• 🛡 使用 TypeScript 开发，提升开发体验
• ✅ 使用单元测试，为组件稳定性保驾护航
• 📖 提供开发过程的文档思路，助力你学习组件开发
• 🔖 欢迎贡献组件代码，探索最佳实践

📦 安装

使用 npm 或 yarn 安装（推荐）

yarn add monki-ui

npm install monki-ui

🔨 示例

import { Button } from 'monki-ui'

const App = () => (
  <>
    <Button type="primary">Primary Button</Button>
  </>
)

引入样式：

import 'monki-ui/dist/index.css'

计划

🚧 开发中......

• 开发 Upload 组件

✨ 已完成

• CSS 样式解决方案、初始化文件结构、UI 设计
• Button 组件开发与测试
• 增加 Travis CI
• 创建入口文件，并发布到 npm
• 开发 Alert 组件
• 开发 Menu 组件
• 开发 Tab 组件
• 开发 Input 组件
• 开发 AutoComplete 组件
• 开发 Tag 组件
• 开发 Select 组件

开源协议

版权 (c) 2020-至今 归 JackySummer 所有. 详情请阅 LICENSE.