vue3+ts jsx写法css module处理方案

关于vue3与jsx(tsx)写法自己了解哦,也可以看博主之前的博客。

css带有全局性,当我们的项目复杂到一定程度的时候,css文件会很多,如果像传统的引入方式,那么这些css文件都会全局生效,难免会照成样式冲突。
这时候就需要对样式进行模块化,就是一个样式文件只对一个组件产生作用。vue已经提供了scoped解决方案,当一个style标签拥有scoped属性时候,它的css样式只能用于当前的Vue组件,可以使组件的样式不相互污染。如果一个项目的所有style标签都加上了scoped属性,相当于实现了样式的模块化。
相信scoped这个写法大家都非常熟悉,下面是它的实现原理:
转译前:

<style scoped>
    .example{
        color:red;
    }
</style>

<template>
    <div>scoped测试案例</div>
</template>

转译后:

.example[data-v-5558831a] {
  color: red;
}

<template>
    <div class="example" data-v-5558831a>scoped测试案例</div>
</template>

这个方式非常简单也是最常用的,但是有个局限性,就是只能作用于vue文件。
当我想使用jsx写法编写组件的时候,无法使用scoped这个用法,因为jsx等同于一个js文件,里面可写不了templatestyle标签。那么当我想使用一个样式文件的时候,就类似于下面这样:
test.tsx文件

import { defineComponent } from 'vue'
import './test.scss'

export default defineComponent({
  setup () {
    return () => {
      return <div class="test">
      </div>
    }
  }
})

test.scss文件:

.test {
  width: 100px;
  height: 100px;
  background: rebeccapurple;
}

这样样式确实能够作用到div上,但是当我们看网页代码的时候:

image.png

可以看到这个样式文件会挂载到全局的style标签上,且类名没有任何转译,这样就会容易造成样式污染。

解决方案就是css module,vue对于样式除了scoped这种方案其实还有css module,可能大家平时用得也比较少(反正我没用过),因为vue文件使用scoped实在是太方便而且已经满足需求。
css module文档
vue cli已经集成了,我们都可以直接使用。

那么,在jsx文件中该如何使用呢,我们需要改一下项目配置:
vue.config.js中,添加:

module.exports = {
  css: {
    requireModuleExtension: true
  }
}

关于requireModuleExtension的作用,看这里:https://cli.vuejs.org/zh/config/#configurewebpack
然后将上面的test.scss文件改名,更改为test.module.scss:

image.png

回到test.tsx文件中,将引入的方式修改:

import { defineComponent } from 'vue'
import styles from './test.module.scss'

export default defineComponent({
  setup () {
    return () => {
      return <div class={styles.test}>
      </div>
    }
  }
})

如果你跟我一样使用的是ts,那么from一个scss文件的时候会报错,因为ts不识别这类文件的定义,我们需要到src文件夹下的shims-vue.d.ts中添加一项:

declare module "*.scss" {
  const classes: { readonly [key: string]: string };
  export default classes;
}

定义了scss文件的类型,如果你是css、less、stylus这些样式的话,把上面的scss改成你们的样式文件后缀就可以。

好了,现在来看一下效果:


image.png

可以看到css module会自动将我们类名进行转译,避免了全局污染。

如果你跟我一样使用ts,使用vscode,那么还有更厉害的,类名自动提示!!!
首先安装typescript-plugin-css-modules

npm install typescript-plugin-css-modules --save-dev

然后ts开启这个插件,到项目下的tsconfig.json中,在compilerOptions属性下添加:

"plugins": [{"name": "typescript-plugin-css-modules"}]

最后一步,配合vscode,在项目根目录上创建.vscode文件夹,添加settings.json文件:

image.png

在settings.json中,添加:

{
    "typescript.tsdk": "node_modules/typescript/lib",
    "typescript.enablePromptUseWorkspaceTsdk": true
}

效果:


image.png

非常好用!

我是鸭子,祝你幸福。

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

推荐阅读更多精彩内容