gyhu3-ui v0.0.24

羚羊 Design - 移动端组件库

基于 Vant 3.x 封装的羚羊移动端 UI 组件库、组件使用文档

:sparkles: 特性

• TypeScript 4.x + JavaScript + ES6+
• Vue 3.x
• Vue Router 4.x
• Pinia 2.x
• Vant 3.x
• Tsx/Jsx
• Sass
• ESLint + JavaScript Standard Style + Stylelint + Prettier 代码风格检测
• Git Hook Husky + Lint-Staged 代码提交规范

安装

可在 LYDesign 主目录通过 pnpm i 统一安装所有项目依赖，也可以 cd projects/ly-design-h5 通过 pnpm i 独立安装此项目依赖

运行

1. 在 LYDesign 主目录下通过 pnpm start or pnpm start:h5
2. cd 到 projects/ly-design-h5 录下通过 pnpm start or npm start

主目录结构

├── config               // 构建配置
│   ├── plugins          // 各种插件
│   ├── build            // 打包配置
|   └── css              // scss配置
|
├── public               // 静态资源文件，打包后会直接复制到 dist 文件夹中
|
├── packages             // 组件文件夹，所有UI组件在此文件内创建
|   └── Button
|         ├── demo       // 组件具体使用效果Demo，会展示在文档在右侧
|         ├── docs       // 组件使用文档 README.md 文件
|         ├── src        // 组件源码
|         ├── test       // 组件单元测试用例
|         └── index.ts   // 单个引入、导出组件
|   └── index.ts         // 全局引入、导出所有组件
|
├── src                  // 整体项目文档、组件使用文档展示
│    ├── router          // 路由文件
│         ├── guard      // 各类路由守卫
│         └── modules    // 各类路由文件
│    ├── store           // 状态管理
│         └── modules    // 各类状态文件
│    ├── styles          // 全局样式
│    ├── views           // 业务页面
│         ├── common     // 通用页面
│         └── docs       // 项目文档、组件文档具体实现
│
│    ├── App.vue         // 页面入口
│    └── main.ts         // 项目入口ts
├── types                // ts类型声明
├── tsconfig.json        // ts配置
└── vite.config.ts       // vite全局配置