React组件开发规范

简介: React组件开发规范

React组件规范


文件命名

  • 每一个文件只包含一个组件,每一个基本组件只包含单一功能  
  • 如果文件返回是一个类,文件名首字母大写  
  • 测试用例文件名使用.spec.jsx后缀  
  • 每一个组件使用一个单独的测试用例文件  

Js规范

  • 使用es6+开发,尽量使用常用的ES6+语法  
  • 使用jsx语法  
  • 组件文件命名使用大驼峰, ComponentDemo  
  • 带命名空间的组件,如果一个组件包含只有自身使用的子组件,以该组件为命名空间编写组件,例如Table,Table.Head  
  • 不使用displayName命名  
  • 自定义属性使用data-  
  • 使用propTypes进行props类型校验  
  • 使用defaultProps定义默认参数  
  • 定义props避开react关键字及保留字,常用的props及state定义可参考下表  
  • 尽量少或者不使用ref获取和操作dom节点,使用state和prop进行控制dom,如遇必须使用的情况,添加详细注释信息  
  • 事件调用使用在元素上onClick调用  
  • 注意,react和html的表单元素的差异  
  • 不支持mixin,使用decorator进行扩展和高阶组件方式扩展。  
  • 不能私自添加第三方js库,如需要使用,必须通知本组组长,并在工作群里提出,At所有前端负责人,经讨论后再添加
  • 尽量多而有用的代码注释,方法使用块级注释  
  • 避免使用定时器类的编码,如必须使用,需添加详细注释,各组长合并代码时需要审查是否合理,合确认是否含有销毁方法  
  • 自身定义的props属性应避免与react的关键字相同  

样式规范

  • 在添加src/style/theme/default.sess中添加公共样式变量,各开发人员尽可能使用里面定义的公共样式变量  
  • 组件多样式调用,使用classnames模块,进行样式处理,使用className调用  
  • 所有组件类名命名以‘expo-’开头  

通用组件接口规范

参数

说明 类型 默认值
size 尺寸 string medium
color 颜色 string ''
shape 形状 string ''
disabled 是否禁用 bool false
className 增加额外的类名 string ''
htmlType html dom 的 type 属性 string string
style 内联样式 object object

参考链接

airbnb规范

代码规范

相关文章
|
前端开发 安全 JavaScript
【Message 全局提示】基于 React 实现 Message 组件
使用 ReactDOM.createRoot、React.forwardRef、React.useImperativeHandle 实现 Message 组件。使用 Web Crypto API 生成符合密码学要求的安全的随机 ID。
|
5月前
|
前端开发
React Hooks实战技巧:提升你的组件开发效率
【7月更文挑战第16天】React Hooks为React开发带来了革命性的变化,使得函数式组件更加强大和灵活。通过掌握上述实战技巧,你可以更高效地编写清晰、可维护和可复用的React组件。希望这些技巧能帮助你在React开发之路上走得更远。
|
7月前
|
前端开发 JavaScript 测试技术
【第55期】一文读懂React组件开发环境
【第55期】一文读懂React组件开发环境
101 1
|
前端开发 数据处理 API
react中的目录规范
react中的目录规范
109 1
|
前端开发 JavaScript 开发者
React格式化规范
React格式化规范
205 0
|
JavaScript 前端开发 安全
react.ts规范
react.ts规范
120 0
|
JavaScript 前端开发 安全
react.ts规范
react.ts规范
|
JSON 前端开发 JavaScript
【脚手架】从0到1搭建React18+TS4.x+Webpack5项目(三)代码质量和git提交规范
【脚手架】从0到1搭建React18+TS4.x+Webpack5项目(三)代码质量和git提交规范
|
前端开发
【React工作记录四十六】react中的目录规范
【React工作记录四十六】react中的目录规范
152 0
|
前端开发
react笔记之学习之添加card组件
react笔记之学习之添加card组件
188 0
react笔记之学习之添加card组件