在Vue工作流中使用CSS Modules

2023-12-23 18:30

本文主要是介绍在Vue工作流中使用CSS Modules,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

CSS在工程化上的一些问题

关于React的CSS in JS,有一个著名的talk,由Facebook的工程师vjeux带来。

里面最有名的一张slide是这样的:

css in js

里面列举了CSS的一些问题。其中,Dead Code Elimination,Minification,和Sharing Constants这些问题我们已经通过在我们的工作流中加入SASS和PostCSS这样的CSS预处理器解决了。

然而还有一些问题没有解决,比如全局命名空间。同一个document下的所有CSS的类名,都是在同一个“作用域”下的,因此我们常常要考虑如何避免命名冲突问题。现有的解决办法主要是靠BEM这样的命名惯例,或者是用多层CSS父子选择器来模拟命名空间。然而这样的办法对工程师有许多的限制。多级选择器有比较高的优先级,不容易维护。

解决全局作用域:Webpack css-loader

Webpack的css-loader首先做出了解决全局作用域的尝试。解决办法就是在写CSS类名时加入:local(...)这样的标记。

比如:

:local(.className) { background: red; }
:local .className { color: green; }
:local(.className .subClass) { color: green; }
:local .className .subClass :global(.global-class-name) { color: blue; }

会被转化为:

._23_aKvs-b8bW2Vg3fwHozO { background: red; }
._23_aKvs-b8bW2Vg3fwHozO { color: green; }
._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 { color: green; }
._23_aKvs-b8bW2Vg3fwHozO ._13LGdX8RMStbBE9w-t0gZ1 .global-class-name { color: blue; }

这里的办法就是把CSS类名转化为hash字符串,这样就可以保证每个类名都是独一无二的,自然也就不用在意命名冲突的问题了。只要在类名在当前模块内不会相互冲突就可以了。

CSS Modules

上述的办法,还是有一些不便。大多数情况下,比如在JavaScript中,变量都默认是局部变量。你想要声明一个全局变量,只能去全局作用域声明,或者把变量挂到local上(非严格模式下,不写var声明的是全局变量这种坑就不说了)。

Webpack的开发者之后将css-loader中的local变成了默认设定,于是CSS Modules这个规范就呼之欲出了。

CSS Modules规范。我们可以通过css-loader?modules这个参数来开启CSS Modules。

CSS Modules中的类名默认就是local的,如果你想要声明全局类名,可以加上:global(...)这个标记。

Single Responsibility Principle

讲CSS Modules的下一个特性之前。我们先聊点其他的,我们知道设计模式中有一条叫做Single Responsibility Principle。

比如我们有一个button:

.button {display:inline-block;padding:2em;background-color:red;
}

与其把这些属性写在一个class里,我们可以把它拆分成多个单独的class:

.button {display:inline-block;
}
.button--large{padding:2em;
}
.button--warnning{background-color:red;
}

然后在HTML中组合使用就可以了。

<button class="button button--large button--warnning">

这样的好处是什么呢?我们的UI中,一个组件往往有很多不同的状态。如果我们将每一个class写成只专注于一个属性,做好一件事,那就可以用这些class组合成所有我们想要的不同状态的组件。相比给每个状态的组件写一个单独的class,代码要更优雅简洁一些。

比如我们想要一个small尺寸的普通button,只要加两个class:

.button {display:inline-block;
}
.button--small{padding:1em;
}
.button--large{padding:2em;
}
.button--normal{background-color:blue;
}
.button--warnning{background-color:red;
}

然后组合就可以了:

<button class="button button--small button--normal">

CSS Classes Composing

要想实现上述的这种组合,可以使用SASS的Mixin,但Mixin主要是提供了源代码中的抽象,最后生成的代码,和手写不同状态class的代码量,是一样的。

CSS Modules提供的Classes Composing则刚好可以满足我们的需求。

比如我们想渲染一段文字:

.text{font-size: 20px;composes: red from "./common/color.css";
}

color.css里是这样的

.red{color: red;
}

最后渲染出的class是这样的

<div class="App-text-2AEnE_0 color-red-3ag3h_0"></div>

composes引入的类被作为一个单独的class引入,而不是和text类合在一起。

CSS Modules和Vue工作流的整合

Vue-loader在v9.8.0之后加入了对CSS Modules的支持。

我们只要在.vue文件的<style>处加一个module就行

<style lang="sass" module>
.text{font-size: 20px;composes: red from "sass!./common/color.scss";
}
</style>

这里有一点要注意,就是composes引入的如果是需要预处理器处理的,要在前面加上预处理器的标记,比如SASS用户就加上sass!

如果需要对CSS Modules进行一些配置(其实这个是对Webpack的css-loader的配置,所以配置时可以参考css-loader的文档),写在vue-loader的配置的cssModules属性里即可

loader: 'vue',
options: {cssModules: {localIdentName: '[name]-[local]-[hash:base64:5]',camelCase: true}
}    

vue-loader会自动将一个$style属性注入到对应的Vue实例中。在模板中用class binding语法写就可以了。

<template><div :class="$style.app"><div :class="$style.text">some text</div><main-text></main-text></div>
</template>

$style其实是一个原class名和处理之后class名的hash,像这样:

{app: "App-app-3cl75_0",text: "App-text-2AEnE_0 color-red-3ag3h_0"
}

我写一了一个简单的DEMO仓库,可以供参考。

结语

CSS Modules可以解决全局作用域和Class组合两个问题,加上SASS等预处理器,着实让我们在写CSS时的工程化程度大大提高了。

对于使用Vue的同学来说,vue-loader可以使CSS Modules可以轻松的整合到已有的工作流中。如果你正在使用Vue,可以试试使用CSS Modules。

Links

  • CSS Modules Welcome to the Future

  • The case for CSS modules - Mark Dalgleish

  • React: CSS in JS by vjeux

博客原文链接

这篇关于在Vue工作流中使用CSS Modules的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/529009

相关文章

C语言中联合体union的使用

本文编辑整理自: http://bbs.chinaunix.net/forum.php?mod=viewthread&tid=179471 一、前言 “联合体”(union)与“结构体”(struct)有一些相似之处。但两者有本质上的不同。在结构体中,各成员有各自的内存空间, 一个结构变量的总长度是各成员长度之和。而在“联合”中,各成员共享一段内存空间, 一个联合变量

找完工作该补充的东西

首先: 锻炼身体,包括乒乓球,羽毛球,都必须练习,学习,锻炼身体等是一个很重要的与人交际沟通的方式; 打牌,娱乐:会玩是一个人很重要的交际沟通的法宝; 摄影:这个是一个兴趣爱好,也是提高自己的审美,生活品质,当然也是与人沟通的重要途径; 做饭:这个的话就是对自己,对朋友非常有益的一件事情;

Tolua使用笔记(上)

目录   1.准备工作 2.运行例子 01.HelloWorld:在C#中,创建和销毁Lua虚拟机 和 简单调用。 02.ScriptsFromFile:在C#中,对一个lua文件的执行调用 03.CallLuaFunction:在C#中,对lua函数的操作 04.AccessingLuaVariables:在C#中,对lua变量的操作 05.LuaCoroutine:在Lua中,

Vim使用基础篇

本文内容大部分来自 vimtutor,自带的教程的总结。在终端输入vimtutor 即可进入教程。 先总结一下,然后再分别介绍正常模式,插入模式,和可视模式三种模式下的命令。 目录 看完以后的汇总 1.正常模式(Normal模式) 1.移动光标 2.删除 3.【:】输入符 4.撤销 5.替换 6.重复命令【. ; ,】 7.复制粘贴 8.缩进 2.插入模式 INSERT

vue, 左右布局宽,可拖动改变

1:建立一个draggableMixin.js  混入的方式使用 2:代码如下draggableMixin.js  export default {data() {return {leftWidth: 330,isDragging: false,startX: 0,startWidth: 0,};},methods: {startDragging(e) {this.isDragging = tr

Lipowerline5.0 雷达电力应用软件下载使用

1.配网数据处理分析 针对配网线路点云数据,优化了分类算法,支持杆塔、导线、交跨线、建筑物、地面点和其他线路的自动分类;一键生成危险点报告和交跨报告;还能生成点云数据采集航线和自主巡检航线。 获取软件安装包联系邮箱:2895356150@qq.com,资源源于网络,本介绍用于学习使用,如有侵权请您联系删除! 2.新增快速版,简洁易上手 支持快速版和专业版切换使用,快速版界面简洁,保留主

如何免费的去使用connectedpapers?

免费使用connectedpapers 1. 打开谷歌浏览器2. 按住ctrl+shift+N,进入无痕模式3. 不需要登录(也就是访客模式)4. 两次用完,关闭无痕模式(继续重复步骤 2 - 4) 1. 打开谷歌浏览器 2. 按住ctrl+shift+N,进入无痕模式 输入网址:https://www.connectedpapers.com/ 3. 不需要登录(也就是

工作流Activiti初体验—流程撤回【二】

已经玩工作流了,打算还是研究一下撤回的功能。但是流程图里面并不带撤回的组件,所以需要自己动态改造一下,还是延续上一个流程继续试验撤回功能。《工作流Activiti初体验【一】》 完整流程图 我们研究一下分发任务撤回到发起任务,其他环节的撤回类似 撤回的原理大概如下: 将分发任务后面的方向清空,把发起任务拼接到原来的判断网关,然后结束分发任务,这样流程就到发起任务了 此时的流程如上图,

工作流Activiti初体验【一】

在这里记录一下我的Activiti历程:(以下示例不涉及真实业务,所有逻辑均建立在学习的基础上) bpmn图 发起任务我设置了一个权限组user1,只要是这个权限的用户都可以发起任务 分发任务我设置了一个用户组,用户组中每个用户都可以处理这步流程,只要有一个人处理这步任务,分发的流程就算结束了 分发任务这一环节还有个判断,允许任务下发和不允许任务下发 任务分发完成则来到子流程,每个被分

vue项目集成CanvasEditor实现Word在线编辑器

CanvasEditor实现Word在线编辑器 官网文档:https://hufe.club/canvas-editor-docs/guide/schema.html 源码地址:https://github.com/Hufe921/canvas-editor 前提声明: 由于CanvasEditor目前不支持vue、react 等框架开箱即用版,所以需要我们去Git下载源码,拿到其中两个主