jsx/tsx使用cssModule和typescript-plugin-css-modules

1,前言

vite/webpack搭建的項目中冒晰,不管是vue還是react,都可以寫jsx/tsx竟块,為了避免樣式污染壶运,常用的方式有兩種。一種是每個組件都用一個唯一類名class包裹浪秘,使用less/scss嵌套樣式蒋情。另一種是使用cssModule模塊化。本文就分享一下如何使用cssModule耸携,并推薦一個好用的插件:typescript-plugin-css-modules棵癣,讓你在vscode中,能擁有typeScript一樣的智能提示夺衍。

2狈谊,效果圖

效果圖
類型
類型

3,如何使用

注:本文各種配置均使用vscode編輯器沟沙。

3.1河劝,安裝

  • yarn
yarn add -D typescript-plugin-css-modules
  • npm
npm install -D typescript-plugin-css-modules

3.2,配置

配置后需要重啟vscode矛紫,然后項目中使用cssMoudule時赎瞎,就可以享受到typeScript提示的class類名了,配置如下:

  • 配置tsconfig.json
{
  "compilerOptions": {
    "plugins": [{"name": "typescript-plugin-css-modules"}]
  }
}
  • 配置settings.json

在項目根目錄新建.vscode文件夾颊咬,在文件夾中新建settings.json务甥,并寫入如下配置牡辽,用于指明使用typescript.tsdk的位置以及開啟提示,如果vscode有提示敞临,記得同意瞧柔。

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

注意:cssModule可以用于css柿赊,less诉儒,scss等日麸,使用時堪侯,css/less/scss文件后綴必須由.css/.less/.scss變?yōu)?.module.css/.module.less/.module.scss

4震嫉,示例

  • index.tsx
import { defineComponent } from 'vue'
import styles from './index.module.scss'

export default defineComponent({
  name: 'notFound',
  setup() {
    return () => (
      <div class={styles.main_box}>11111</div >
    )
  }
})
  • index.module.scss
.main_box {
  width: 100%;
  height: 100%;
  position: relative;
  overflow: hidden;
  text-align: center;
  background-color: #ffffff;
}

5珍策,插件錯誤處理

截止本文發(fā)布之時掷空,typescript-plugin-css-modules的版本為3.4.0铣耘,此插件有一個bug洽沟,會導(dǎo)致cssModule類型提取失敗,模塊類型是一個{}的情況蜗细,如下所示:

Property '<specific class name>' does not exist on type {}

出錯

issues地址

5.1裆操,錯誤觸發(fā)原因

這個bug目前有兩個方式都會觸發(fā):

  • 1,當(dāng)你項目中使用less/scss@include/@mixin等等指令的時候

  • 2炉媒,當(dāng)你的項目使用/ deep /這樣的深度選擇器語法的時候

5.2踪区,解決辦法

  • 1,在需要使用@include/@mixin等等指令的時候吊骤,在cssModule文件的頭上引入樣式缎岗,就可以解決(之前是全局引入),如下所示:
@use "../../../static/styles/common.scss" as *;
  • 2白粉,換一種深度選擇器寫法传泊,如下所示:
.main{
  & ::deep .el-button{
    background-image: linear-gradient(-90deg, #29bdd9 0%, #276ace 100%);
    &:hover{
      opacity: 0.8;
    }
  }
}

如果看了覺得有幫助的,我是@鵬多多11997110103鸭巴,歡迎 點贊 關(guān)注 評論眷细;
END

PS:在本頁按F12,在console中輸入document.querySelectorAll('._2VdqdF')[0].click()鹃祖,有驚喜哦

往期文章

個人主頁

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末池磁,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子楷兽,更是在濱河造成了極大的恐慌地熄,老刑警劉巖,帶你破解...
    沈念sama閱讀 210,978評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件芯杀,死亡現(xiàn)場離奇詭異端考,居然都是意外死亡雅潭,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,954評論 2 384
  • 文/潘曉璐 我一進(jìn)店門却特,熙熙樓的掌柜王于貴愁眉苦臉地迎上來扶供,“玉大人,你說我怎么就攤上這事裂明〈慌ǎ” “怎么了?”我有些...
    開封第一講書人閱讀 156,623評論 0 345
  • 文/不壞的土叔 我叫張陵闽晦,是天一觀的道長扳碍。 經(jīng)常有香客問我,道長仙蛉,這世上最難降的妖魔是什么笋敞? 我笑而不...
    開封第一講書人閱讀 56,324評論 1 282
  • 正文 為了忘掉前任,我火速辦了婚禮荠瘪,結(jié)果婚禮上夯巷,老公的妹妹穿的比我還像新娘。我一直安慰自己哀墓,他們只是感情好趁餐,可當(dāng)我...
    茶點故事閱讀 65,390評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著篮绰,像睡著了一般澎怒。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上阶牍,一...
    開封第一講書人閱讀 49,741評論 1 289
  • 那天喷面,我揣著相機(jī)與錄音,去河邊找鬼走孽。 笑死惧辈,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的磕瓷。 我是一名探鬼主播盒齿,決...
    沈念sama閱讀 38,892評論 3 405
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼困食!你這毒婦竟也來了边翁?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,655評論 0 266
  • 序言:老撾萬榮一對情侶失蹤硕盹,失蹤者是張志新(化名)和其女友劉穎符匾,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體瘩例,經(jīng)...
    沈念sama閱讀 44,104評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡啊胶,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,451評論 2 325
  • 正文 我和宋清朗相戀三年甸各,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片焰坪。...
    茶點故事閱讀 38,569評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡趣倾,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出某饰,到底是詐尸還是另有隱情儒恋,我是刑警寧澤,帶...
    沈念sama閱讀 34,254評論 4 328
  • 正文 年R本政府宣布黔漂,位于F島的核電站碧浊,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏瘟仿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,834評論 3 312
  • 文/蒙蒙 一比勉、第九天 我趴在偏房一處隱蔽的房頂上張望劳较。 院中可真熱鬧,春花似錦浩聋、人聲如沸观蜗。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,725評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽墓捻。三九已至,卻和暖如春坊夫,著一層夾襖步出監(jiān)牢的瞬間砖第,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,950評論 1 264
  • 我被黑心中介騙來泰國打工环凿, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留梧兼,地道東北人。 一個月前我還...
    沈念sama閱讀 46,260評論 2 360
  • 正文 我出身青樓智听,卻偏偏與公主長得像羽杰,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子到推,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,446評論 2 348

推薦閱讀更多精彩內(nèi)容