使用 JS 來動態操作 css ,你知道幾種方法?

前端小智發表於2019-12-03

作者:areknawo

譯者:前端小智

來源:css-tricks.com

你知道的越多,你不知道的越多

點贊再看,養成習慣


本文 GitHub:github.com/qq449245884… 上已經收錄,更多往期高贊文章的分類,也整理了很多我的文件,和教程資料。歡迎Star和完善,大家面試可以參照考點複習,希望我們一起有點東西。

JavaScript 可以說是互動之王,它作為指令碼語言加上許多 Web Api 進一步擴充套件了它的特性集,更加豐富介面互動的可操作性。這類 API 的例子包括WebGL APICanvas APIDOM API,還有一組不太為人所知的 CSS API

由於JSX和無數JS框架的出現,使通過JS APIDOM互動的想法真正流行起來,但是在 CSS 中使用類似技術似乎並沒有很多。 當然,存在像CSS-in-JS這類解決方案,但是最流行的解決方案還是基於轉譯(transpilation),無需額外執行即可生成 CSS。 這肯定對效能有好處,因為CSS API的使用可能導致額外的重繪,這與DOM API的使用一樣。 但這不是我們們想要的。 如果哪天公司要求我們們,既要操縱 DOM 元素的樣式和 CSS 類,還要像使用 HTML 一樣使用 JS 建立完整的樣式表,該怎麼辦?

內聯樣式

在我們們深入一些複雜的知識之前,先回來顧一下一些基礎知識。例如,我們們可以通過修改它的.style屬性來編輯給定的HTMLElement的內聯樣式。

const el = document.createElement('div')

el.style.backgroundColor = 'red'
// 或者 
el.style.cssText = 'background-color: red'
// 或者
el.setAttribute('style', 'background-color: red')
複製程式碼

直接在.style物件上設定樣式屬性將需要使用駝峰式命名作為屬性鍵,而不是使用短橫線命名。 如果我們們需要設定更多的內聯樣式屬性,則可以通過設定.style.cssText屬性,以更加高效的方式進行設定 。

請記住,**給cssText設定後原先的css樣式被清掉了,**因此,要求我們們一次死一堆樣式 。

如果這種設定內聯樣式過於繁瑣,我們們還可以考慮將.styleObject.assign()一起使用,以一次設定多個樣式屬性。

// ...
Object.assign(el.style, {
    backgroundColor: "red",
    margin: "25px"
})
複製程式碼

這些“基本知識”比我們們想象的要多得多。.style物件實現CSSStyleDeclaration介面。 這說明它帶還有一些有趣的屬性和方法,這包括剛剛使用的.cssText,還包括.length(設定屬性的數量),以及.item().getPropertyValue().setPropertyValue()之類的方法:

// ...
const propertiesCount = el.style.length
for(let i = 0; i < propertiesCount; i++) {
    const name = el.style.item(i) // 'background-color'
    const value = el.style.getPropertyValue(name) // 're'
    const priority = el.style.getPropertyPriority(name) // 'important'
    
    if(priority === 'important') {
        el.style.removeProperty()
    }
}
複製程式碼

這裡有個小竅門-在遍歷過程中.item()方法具有按索引訪問形式的備用語法。

// ...
el.style.item(0) === el.style[0]; // true
複製程式碼

CSS 類

接著,來看看更高階的結構——CSS類,它在檢索和設定時具有字串形式是.classname

// ...
el.className = "class-one class-two";
el.setAttribute("class", "class-one class-two");
複製程式碼

設定類字串的另一種方法是設定class屬性(與檢索相同)。 但是,就像使用.style.cssText屬性一樣,設定.className將要求我們們在字串中包括給定元素的所有類,包括已更改和未更改的類。

當然,可以使用一些簡單的字串操作來完成這項工作,還有一種就是使用較新的.classList屬性,這個屬性,IE9 不支援它,而 IE10 和 IE11 僅部分支援它

classlist屬性實現了DOMTokenList,有一大堆有用的方法。例如.add().remove()、.toggle()和.replace()允許我們們更改當前的 CSS 類集合,而其他的,例如.item().entries().foreach()則可以簡化這個索引集合的遍歷過程。

// ...
const classNames = ["class-one", "class-two", "class-three"];
classNames.forEach(className => {
    if(!el.classList.contains(className)) {
        el.classList.add(className);
    }
});
複製程式碼

Stylesheets

一直以來,Web Api 還有一個StyleSheetList介面,該介面由document.styleSheets屬性實現。 document.styleSheets 只讀屬性,返回一個由 StyleSheet 物件組成的 StyleSheetList,每個 StyleSheet 物件都是一個文件中連結或嵌入的樣式表。

for(styleSheet of document.styleSheets){
	console.log(styleSheet);
}
複製程式碼

通過列印結果我們們可以知道,每次迴圈列印的是 CSSStyleSheet 物件,每個 CSSStyleSheet 物件由下列屬性組成:

屬性 描述
media 獲取當前樣式作用的媒體。
disabled 開啟或禁用一張樣式表。
href 返回 CSSStyleSheet 物件連線的樣式表地址。
title 返回 CSSStyleSheet 物件的title值。
type 返回 CSSStyleSheet 物件的type值,通常是text/css。
parentStyleSheet 返回包含了當前樣式表的那張樣式表。
ownerNode 返回CSSStyleSheet物件所在的DOM節點,通常是<link><style>
cssRules 返回樣式表中所有的規則。
ownerRule 如果是通過@import匯入的,屬性就是指向表示匯入的規則的指標,否則值為null。IE不支援這個屬性。

CSSStyleSheet物件方法:

方法 描述
insertRule() 在當前樣式表的 cssRules 物件插入CSS規則。
deleteRule() 在當前樣式表刪除 cssRules 物件的CSS規則。

有了StyleSheetList的全部內容,我們們來CSSStyleSheet本身。 在這裡就有點意思了, CSSStyleSheet擴充套件了StyleSheet介面,並且只有這種只讀屬性,如.ownerNode.href.title.type,它們大多直接從宣告給定樣式表的地方獲取。回想一下載入外部CSS檔案的標準HTML程式碼,我們們就會明白這句話是啥意思:

<head>
<link rel="stylesheet" type="text/css" href="style.css" title="Styles">
</head>
複製程式碼

現在,我們們知道HTML文件可以包含多個樣式表,所有這些樣式表都可以包含不同的規則,甚至可以包含更多的樣式表(當使用@import時)。CSSStyleSheet有兩個方法:、.insertrule().deleterule() 來增加和刪除 Css 規則。

// ...
const ruleIndex = styleSheet.insertRule("div {background-color: red}");
styleSheet.deleteRule(ruleIndex);
複製程式碼

.insertRule(rule,index):此函式可以在cssRules規則集合中插入一個指定的規則,引數rule是標示規則的字串,引數index是值規則字串插入的位置。

deleteRule(index):此函式可以刪除指定索引的規規則,引數index規定規則的索引。

CSSStyleSheet也有自己的兩個屬性:.ownerRule.cssRule。雖然.ownerRule@import相關,但比較有趣的是.cssRules。簡單地說,它是CSSRuleListCSSRule,可以使用前面提到的.insertrule().deleterule()方法修改它。請記住,有些瀏覽器可能會阻止我們們從不同的來源(域)訪問外部CSSStyleSheet的.cssRules屬性。

那麼什麼是 CSSRuleList

CSSRuleList是一個陣列物件包含著一個有序的CSSRule物件的集合。每一個CSSRule可以通過rules.item(index)的形式訪問, 或者rules[index]。 這裡的rules是一個實現了CSSRuleList介面的物件, index是一個基於0開始的,順序與CSS樣式表中的順序是一致的。樣式物件的個數是通過rules.length表達。

對於CSSStyleRule物件:

每一個樣式表CSSStyleSheet物件可以包含若干CSSStyleRule物件,也就是css樣式規則,如下:

<style type="text/css">
  h1{color:red}
  div{color:green}
</style>
複製程式碼

在上面的程式碼中style標籤是一個CSSStyleSheet樣式表物件,這個樣式表物件包含兩個CSSStyleRule物件,也就是兩個css樣式規則。

CSSStyleRule物件具有下列屬性:

1.type:返回0-6的數字,表示規則的型別,型別列表如下:

0:CSSRule.UNKNOWN_RULE。

1:CSSRule.STYLE_RULE (定義一個CSSStyleRule物件)。

2:CSSRule.CHARSET_RULE (定義一個CSSCharsetRule物件,用於設定當前樣式表的字符集,預設與當前網頁相同)。

3:CSSRule.IMPORT_RULE (定義一個CSSImportRule物件,就是用@import引入其他的樣式表)

4:CSSRule.MEDIA_RULE (定義一個CSSMediaRule物件,用於設定此樣式是用於顯示器,印表機還是投影機等等)。

5:CSSRule.FONT_FACE_RULE (定義一個CSSFontFaceRule物件,CSS3的@font-face)。

6:CSSRule.PAGE_RULE (定義一個CSSPageRule物件)。

2.cssText:返回一個字串,表示的是當前規則的內容,例如:

div{color:green}
複製程式碼

3.parentStyleSheet:返回所在的CSSStyleRule物件。

4.parentRule:如果規則位於另一規則中,該屬性引用另一個CSSRule物件。

5.selectorText:返回此規則的選擇器,如上面的div就是選擇器。

6.style:返回一個CSSStyleDeclaration物件。

// ...
const ruleIndex = styleSheet.insertRule("div {background-color: red}");
const rule = styleSheet.cssRules.item(ruleIndex);

rule.selectorText; // "div"
rule.style.backgroundColor; // "red"
複製程式碼

實現

現在,我們們對 CSS 相關的 JS Api有了足夠的瞭解,可以建立我們們自己的、小型的、基於執行時的CSS-in-JS實現。我們們的想法是建立一個函式,它傳遞一個簡單的樣式配置物件,生成一個新建立的CSS類的雜湊名稱供以後使用。

實現流程很簡單,我們們需要一個能夠訪問某種樣式表的函式,並且只需使用.insertrule()方法和樣式配置就可以執行了。先從樣式表部分開始:

function createClassName(style) {
  // ...
  let styleSheet;
  for (let i = 0; i < document.styleSheets.length; i++) {
    if (document.styleSheets[i].CSSInJS) {
      styleSheet = document.styleSheets[i];
      break;
    }
  }
  if (!styleSheet) {
    const style = document.createElement("style");
    document.head.appendChild(style);
    styleSheet = style.sheet;
    styleSheet.CSSInJS = true;
  }
  // ...
}
複製程式碼

如果你使用的是ESM或任何其他型別的JS模組系統,則可以在函式外部安全地建立樣式表例項,而不必擔心其他人對其進行訪問。 但是,為了演示例,我們們將stylesheet上的.CSSInJS屬性設定為標誌的形式,通過標誌來判斷是否要使用它。

現在,如果如果還需要建立一個新的樣式表怎麼辦? 最好的選擇是建立一個新的<style/>標記,並將其附加到HTML文件的<head/>上。 這會自動將新樣式表新增到document.styleSheets列表,並允許我們們通過<style/>標記的.sheet屬性對其進行訪問,是不是很機智?

function createRandomName() {
  const code = Math.random().toString(36).substring(7);
  return `css-${code}`;
}

function phraseStyle(style) {
  const keys = Object.keys(style);
  const keyValue = keys.map(key => {
    const kebabCaseKey = 
        key.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
    const value = 
        `${style[key]}${typeof style[key] === "number" ? "px" : ""}`;
    
    return `${kebabCaseKey}:${value};`;
  });
  
  return `{${keyValue.join("")}}`;
}
複製程式碼

除了上面的小竅門之外。 自然,我們們首先需要一種為CS​​S類生成新的隨機名稱的方法。 然後,將樣式物件正確地表達為可行的CSS字串的形式。 這包括駝峰命名和短橫線全名之間的轉換,以及可選的畫素單位(px)轉換的處理。

function createClassName(style) {
  const className = createRandomName();
  let styleSheet;
  // ...
  styleSheet.insertRule(`.${className}${phraseStyle(style)}`);
  return className;
}
複製程式碼

完整程式碼如下:

HTML

<div id="el"></div>
複製程式碼

JS

function createRandomName() {
  const code = Math.random().toString(36).substring(7);
  return `css-${code}`;
}

function phraseStyle(style) {
  const keys = Object.keys(style);
  const keyValue = keys.map(key => {
    const kebabCaseKey = key.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase();
    const value = `${style[key]}${typeof style[key] === "number" ? "px" : ""}`;
    return `${kebabCaseKey}:${value};`;
  });
  return `{${keyValue.join("")}}`;
}

function createClassName(style) {
  const className = createRandomName();
  let styleSheet;
  for (let i = 0; i < document.styleSheets.length; i++) {
    if (document.styleSheets[i].CSSInJS) {
      styleSheet = document.styleSheets[i];
      break;
    }
  }
  if (!styleSheet) {
    const style = document.createElement("style");
    document.head.appendChild(style);
    styleSheet = style.sheet;
    styleSheet.CSSInJS = true;
  }
  styleSheet.insertRule(`.${className}${phraseStyle(style)}`);
  return className;
}

const el = document.getElementById("el");

const redRect = createClassName({
  width: 100,
  height: 100,
  backgroundColor: "red"
});

el.classList.add(redRect);
複製程式碼

執行效果:

使用 JS 來動態操作 css ,你知道幾種方法?

總結

正如本文我們們所看到的,使用 JS 操作CSS 是一件非常有趣的事,我們們可以挖掘很多好用的 API,上面的例子只是冰山一角,在CSS API(或者更確切地說是API)中還有更多方法,它們正等著被揭開神祕面紗。

原文:css-tricks.com/an-introduc…

編輯中可能存在的bug沒法實時知道,事後為了解決這些bug,花了大量的時間進行log 除錯,這邊順便給大家推薦一個好用的BUG監控工具 Fundebug


交流

乾貨系列文章彙總如下,覺得不錯點個Star,歡迎 加群 互相學習。

github.com/qq449245884…

因為篇幅的限制,今天的分享只到這裡。如果大家想了解更多的內容的話,可以去掃一掃每篇文章最下面的二維碼,然後關注我們們的微信公眾號,瞭解更多的資訊和有價值的內容。

使用 JS 來動態操作 css ,你知道幾種方法?

相關文章