0.0.2 • Published 2 years ago
lightd-mobile v0.0.2
快速使用
npm install lightd
cnpm install lightd
yarn add lightd
引入使用
import React from 'react';
import { Space, Button } from 'lightd';
export default function Demo() {
return (
<Space>
<Button round>圆角按钮</Button>
<Button type="primary" round>圆角按钮</Button>
</Space>
)
}
愉快开始
<Button>默认按钮</Button>
<Button type="primary">主要按钮</Button>
lightd 贡献指南
首先非常感谢您能选择使用 lightd,lightd 是基于 React+Ts 开发,并集成 vite 构建;lightd 旨在秉承数据驱动视图,力求更小的体积、更快的相应、更强的拓展性、更完美的支持、更友好的渲染。任何一个开源库都离不开大家的共同贡献和维护,如果您愿意参与贡献,请阅读以下内容。
分支规范
- 贡献代码请保持在 dev 分支,禁止操作 main 分支。
- 组件文档暂时需要提供 md 文件,包括(使用方式、演示、配置项、事件 API、插槽说明...)。
- 提交代码前请先 rebase。
- git 提交流程示例:
git add .
git commit -m"add component:button" //示例
git pull --rebase origin dev
git push origin dev
文档集成规范
- src/pages/packages/ 下创建组件文档文件,使用公用组件 Title 和 InstanceView 完成文档可视化集成。
- src/demo/ 下创建对应组件 demo 文件,用来传递给 InstanceView 组件渲染。
- src/pages/packages/ 下组件文档文件首行必须包含组件注释信息,用来自动生成路由配置。具体参考 /src/pages/packages/button.tsx 文件。
- InstanceView 组件所需参数及说明请阅读 /src/layout/instanceView.tsx 文件。
- API 集成请使用 Table 组件完成,具体请参考 Button 组件的实现方式。
Issue 规范
- 在提交 issue 之前,请搜索相关内容是否已被提出。
- 请说明 lightd 和 React 或者 TS 的版本号,并提供操作系统和浏览器信息。推荐使用 JSFiddle 生成在线 demo,这能够更直观地重现问题。
Pull Request 规范
- 请先 fork 一份到自己的项目下,不要直接在仓库下建分支。
- commit 信息要以组件名: 描述信息 的形式填写,例如 Button: fix xxx bug。
- 执行 build 后可以正确打包文件。
- 提交 PR 前请 rebase,确保 commit 记录的整洁。
- 确保 PR 是提交到 dev 分支,而不是 main 分支。
- 如果是修复 bug,请在 PR 中给出描述信息。
- 合并代码会有专人审核,避免滥用植入等,审核通过后即可合并。
- 打包测试组件命令为 yarn build 或 npm run build
- 打包网页文件包命令为 yarn build:html 或 npm run build:html
开发环境
- 你需要 Node.js 14+,yarn 1.1+,react 18+,typescript 4+ 和 npm 6+ 及 vite 3+。
- 如果您在使用 yarn 安装依赖的过程中出现 eslint 检查不通过,请执行:
yarn config set ignore-engines true
项目启动
yarn dev
项目打包
yarn build
代码规范
- 避免过多的 html 代码累赘,秉承数据驱动视图思想,简化使用繁琐度,提供更强的拓展性。
- 其他请参考 eslint standard
0.0.2
2 years ago