1.0.2 • Published 1 year ago

muxi-ui-su v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

muxi-ui

打造木犀前端高质量、可扩展的公共 UI 库

src目录结构

├─assets       // 少部分静态资源,需要rollup构建支持
│  └─images
├─components
│  ├─Button
│  └─Input
│      ├─Mobile
│      └─Pc
└─helpers   // 公共辅助函数,处理键盘事件,触摸事件等

项目构建

本项目参考博客教程 搭建。 核心技术:

  • rollup 构建
  • storybook 组件文档
  • jest 测试

开发说明

本地开发

yarn install      // 安装依赖
yarn storybook    // 启动本地服务 根据文档需求开发组件

组件测试

yarn rollup       // 打包构建组件库
yarn link         // 本机电脑全局安装

cd muxi_workbench_fe  //切换到需要使用muxi-ui仓库
yarn link muxi-ui     // 连接本地仓库
import {Button} from 'muxi-ui'     // 测试打包后组件

开发重点

  • eslint
  • prettier
  • commitlint
  • less
  • 规范 ts(禁止 any)
  • jest 组件测试
  • 严格按照文档需求,先写需求再开发
  • 代码审核
  • rollup 构建规范:less、静态资源

开发文档

借助金山文档在线文档组,利用画图能力协作能力实现组件原型设计文档。

组件开发规范:https://kdocs.cn/l/chHqqGN0rQSR