React项目样式管理规范

在最近的工作中,大大小小已开发过数个基于react的前端项目,从一开始的单打独斗到现在的多人协作开发,由于缺乏规范,样式管理一直是开发中的痛点,样式污染,难以定制化,依赖性高,各种问题层出不穷。痛定思痛,我们针对开发中遇到的问题并总结开发中的实际经验和网上的主流解决方案,最终形成一套样式管理规范。

本文首先对样式进行了分类,然后详细讲解了不同类别样式的管理方法。本样式管理规范只针对我们的项目,但对其他React项目也有普遍适用性,可以根据自己的需求进行个性化的定制与修改。

样式分类

对于react项目,可以大致将样式分为四类:

  1. 公共样式
  2. 第三方样式
  3. 容器样式,即container样式
  4. 组件样式,即component样式

前两类样式的管理与传统前端项目并无差异,react项目的重点在于后两类样式的管理。

公共样式

主要包括:

  1. reset——样式重置及设置默认值,通常包括normalize.css和base.css,可根据需求定制
  2. layout——项目主体框架布局的相关样式
  3. variable——存放sass变量,主要包括各种主题颜色、按钮颜色
  4. mixin——可复用的样式片段,包括清除浮动、圆角边框、文本溢出省略显示、文本强制换行

引入方式:reset样式在入口文件index.html中通过link标签引入,layout也可以在index.html引入。如果在layout中使用sass,可以与其他文件统一放在styles文件夹中,在index.js中引入。对于variable和mixin,同样放在styles文件夹中,如果文件体积较小,可以合并成一个文件。

styles文件夹

variable.scss

// 主色
$primary-color          : #5a8def;

// 标准色
$green                  : #117511;
$red                    : #950505;
$blue                   : #5a8def;

// 文字颜色、标题颜色、背景颜色、字体大小
$body-background        : #fff;
$text-color             : #666;
$text-color-secondary   : #999;
$font-size-sm           : 12px;
$font-size-base         : 12px;
$font-size-lg           : 14px;

// 边框颜色以及圆角
$border-color-base      : #d9d9d9;        
$border-color-split     : #e9e9e9;        
$border-base            : 1px solid #d9d9d9;
$border-split           : 1px solid #e9e9e9;
$border-radius-base     : 0px;
$border-radius-lg       : 4px;

// 行高
$line-height-sm         : 28px;
$line-height-normal     : 30px;
$line-height-lg         : 36px;

// 间距
$space-sm               : 5px;
$space-base             : 10px;
$space-lg               : 20px;

mixin.scss

// 清除浮动
@mixin clearfix() {
    &:before,
    &:after {
        content: "";
        display: table;
    }
    &:after {
        clear: both;
    }
}

.container {
    @include clearfix;
}

// 圆角边框
@mixin border-radius($radius) {
    -webkit-border-radius: $radius;
     -moz-border-radius: $radius;
      -ms-border-radius: $radius;
          border-radius: $radius;
}

.box {
    @include border-radius(10px);
}

// 文本溢出省略显示
@mixin text-ellipsis () {
    white-space: nowrap;
    overflow: hidden;
    text-overflow: ellipsis;
}

第三方样式

主要是第三方类库的依赖样式,一般通过link标签引入。

引入方式:index.html通过link标签引入

容器样式

容器即container,一般不为container单独编写样式文件,将所有容器的样式提取到一个文件中(暂定为container.scss,放在styles文件夹中),这样可以避免样式污染,提高代码复用性。类名命名采用类BEM的方式(开发人员表示不太习惯传统BEM命名,所以进行了改进),在项目开始前,前端开发人员集中对页面进行统一分析,分解为模块并命名。之后添加新类名要与其他开发人员统一确认,并保证无重名。

引入方式:放在styles文件夹中,在入口index.js引入

类BEM命名

// 主要由三部分组成:块名、元素名、状态
.blockName-elName.modifier

// 例
.shopCart
.shopCart-title
.shopCart-item
.shopCart-item.selected

.menu
.menu-item
.menu-item.active

组件样式

根据React的组件化开发思想,同时为了避免CSS的全局作用域的影响,对于组件即component的样式,我们采用css-in-js的方案。我们的项目中使用的是styled-components,它是目前 React 样式方案中最受关注的一种,它既具备了 css-in-js 的模块化与参数化优点,又完全使用CSS的书写习惯,不会引起额外的学习成本。

Styled-components

import React from 'react';

import styled from 'styled-components';

// Title组件将生成一个字体大小1.5em,居中对齐,红色文字的h1标签
const Title = styled.h1`
  font-size: 1.5em;
  text-align: center;
  color: red;
`;

//Wrapper组件将生成一个内边距为4em,背景颜色为白色的section标签
const Wrapper = styled.section`
  padding: 4em;
  background: white;
`;

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,028评论 25 707
  • 蓝天、白云、阳光、风和你。 冬天的洱海是安静的,极少的大风吹起大浪。 清晨太阳慵懒地从苍山的肩上爬起,给静谧得洱海...
    木子and子木阅读 379评论 0 3
  • 新的一天 No.118 又是一个下雨天,每一个路口似乎都是氤氲着,欲说还休。 背上电脑,买了一包MM豆,走进咖啡馆...
    水浅_bling阅读 147评论 0 1
  • 我是一个十分吝啬的人。 就拿今晚上去洗脚为例,给我�服务的美女,身材婀娜到喷血,长发飘飘一身黑丝,十分惹火。 我明...
    不用多说什么阅读 344评论 0 0
  • 这是一个传统媒体哀鸿遍野的时代。 几乎每天都能看到铺天盖地的消息,这个报社的主编离职啦,那个报社的主编跳槽啦,哎呀...
    霜寒烈日阅读 1,412评论 5 14