Lighting Design

🚀 lighting-design 是基于 Ant Design 扩展的业务场景组件。可以显著的提升制作 CRUD 页面的效率。

特性

• 💎 简单易用 - 基于 Ant Design 进行面向常见业务的封装
• 📦 场景丰富 - 提供一些列面向常见业务场景基础组件
• 🍙 JSDoc - 提供 JSDoc 注释并集成 VSCode 提示
• 💡 TypeScript - 提供完整 TypeScript 类型定义
• 🎨 更少的代码 - 多种配置减少代码的书写

安装

antd 的版本必须大于等于 5.0.0

npm i lighting-design

#or

yarn add lighting-design

#or

pnpm add lighting-design

设置淘宝镜像源

npm config set registry https://registry.npmmirror.com/

yarn config set registry https://registry.npmmirror.com/

pnpm config set registry https://registry.npmmirror.com/

使用

import { LColor } from 'lighting-design';

按需加载

lighting-design 默认支持基于 ES modules 的 tree shaking，对于 js 部分，直接引入 import { LColor } from 'lighting-design' 就会有按需加载的效果

浏览器兼容性

• 现代浏览器和 Internet Explorer 11 (with polyfills)
• Electron

| | | | | | | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |

参与贡献

Install dependencies,

$ npm i

Start the dev server,

$ npm start

Build documentation,

$ npm run docs:build

Run test,

$ npm test

Build library via father,

$ npm run build

提交规范

(revert: )?(feat|fix|docs|UI|refactor|perf|workflow|build|CI|typos|chore|tests|types|wip|release|dep|locale)

• feat: 添加了个功能
• fix: 修复了一些 bug
• docs: 更新了一下文档
• UI: 修改了一下样式
• build: 项目本地打包
• release: 发布版本
• refactor: 重构代码
• chore: 脚手架配置修改
• dep: 项目依赖包的变动
• workflow: 工作流
• tests: 测试
• types: ts-类型
• perf: 性能优化
• locale: 国际化

特别感谢

特别感谢以下开源产品，部分灵感和思路来自他们。

• Ant Design
• ProComponents