在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将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞?二、准备如何搞?三、说搞咱就搞!抓取文章提取内容构建html转存markdown

在React中引入Tailwind CSS的完整指南

《在React中引入TailwindCSS的完整指南》在现代前端开发中,使用UI库可以显著提高开发效率,TailwindCSS是一个功能类优先的CSS框架,本文将详细介绍如何在Reac... 目录前言一、Tailwind css 简介二、创建 React 项目使用 Create React App 创建项目

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面