前端React框架下的书写规范

1.规范命名
变量名:驼峰法
例如:
isShow (isXXX: is开头的变量代表 boolean 类型)
teacherName (第一个字母不建议缩写,建议写全)
ids (xxxs:s结尾的变量代表 array 类型)
事件名:驼峰法
例如:
onTap (onXXX: on开头的方法名代表点击触发事件)
catchDown (catchXXX: catch开头的方法名与on类似,
在小程序中,catch事件不向上冒泡,bind事件冒泡)
方法名:驼峰法
例如:handleOk (handleXXX: 内部方法名,区分事件)
常用方法名简写
例如:
delXXX, updateXXX, hasXXX
组件名:大驼峰法
根据上下文路径命名
例如:路径 Home/List/index.tsx
组件名称为 HomeList
const HomeList:React.FC = (props) => {}
export default HomeList;
避免匿名组件的写法,如
export default (props) => {
},报错无法定位
2.规范文件
全局组件 components
例如:
src/components/Toast/index.tsx
路由组件 pages
例如:
src/page/Customer/Teacher/Check/index.tsx
模块组件 /pages/Customer/components
例如:
src/pages/Customer/components/Loading.tsx
3.规范写法
组件写法
书写顺序 props, useState, useEffect ...
例如:const User: React.FC = (props) => {
const { id } = props;
const [value, setValue] = useState([]);
const getList = (id) => {
setValue([...]);
}
useEffect(() => {
getList(id);
}, [id]);
return (
<Table/>
)
}
4.样式隔离
style 写法不适合组件式开发,css 功能缺少,例如 :hover 、媒体查询
Css-in-Js
例如:
JSS: 支持 媒体查询与 :hover
Aphrodite:与React Native写法一致
import { StyleSheet, css } from 'aphradite';
const Button = () => (
<span className={css(styles.red)}>
Red
</span>
)
const styles = StyleSheet.create({
red: {
backgroundColor: 'red
},
});
css Modules:支持全部 css 功能,但不支持动态 css
在 webpack 配置 css-loader, options 中 module: true 选项即可使用;
import styles from './index.css';
const Button = () => (
<span className={styles.red}>
Red
</span>
)
缺点:css名必须是驼峰形式;全局css需要使用 :global;配置 babel-plugin-react-css-modules 解决;
styled-components:支持全部 css 功能,且支持动态 css
import styled from 'styled-component';
const Title = styled.h1font-size: 1.5em;;
const Wrapper= styled.spancolor: ${props => props.bgColor};
const App = () => (
<Wrapper bgColor="red">
<Title>Red</Title>
</Wrapper>
)
推荐:styled-jsx Emotion

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容