在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

相关文章

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

MySQL中EXISTS与IN用法使用与对比分析

《MySQL中EXISTS与IN用法使用与对比分析》在MySQL中,EXISTS和IN都用于子查询中根据另一个查询的结果来过滤主查询的记录,本文将基于工作原理、效率和应用场景进行全面对比... 目录一、基本用法详解1. IN 运算符2. EXISTS 运算符二、EXISTS 与 IN 的选择策略三、性能对比

使用Python构建智能BAT文件生成器的完美解决方案

《使用Python构建智能BAT文件生成器的完美解决方案》这篇文章主要为大家详细介绍了如何使用wxPython构建一个智能的BAT文件生成器,它不仅能够为Python脚本生成启动脚本,还提供了完整的文... 目录引言运行效果图项目背景与需求分析核心需求技术选型核心功能实现1. 数据库设计2. 界面布局设计3

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

C#中lock关键字的使用小结

《C#中lock关键字的使用小结》在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时,其他线程无法访问同一实例的该代码块,下面就来介绍一下lock关键字的使用... 目录使用方式工作原理注意事项示例代码为什么不能lock值类型在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时

MySQL 强制使用特定索引的操作

《MySQL强制使用特定索引的操作》MySQL可通过FORCEINDEX、USEINDEX等语法强制查询使用特定索引,但优化器可能不采纳,需结合EXPLAIN分析执行计划,避免性能下降,注意版本差异... 目录1. 使用FORCE INDEX语法2. 使用USE INDEX语法3. 使用IGNORE IND