【JS 】让浏览器支持<style scoped>

1. HTML style scoped 属性

今天无意中发现居然还有这么一个神仙属性 HTML style scoped 属性
他的作用主要是将 style的作用域控制在他自身的父元素之内。
例如:

<div>
  <style type="text/css" scoped>
    h1 {color:red;}
    p {color:blue;}
  </style>
  <h1>这个标题是红色的</h1>
  <p>这个段落是蓝色的。</p>
</div>

<h1>这个标题是黑色的</h1>
<p>这个段落是黑色的。</p>

以上代码中style中的样式只能作用于第一个div内的元素。
这样一个功能应用在目前公司老项目中非常nice(asp.net+mvc,导入部分页就不会影响当前页其他元素了)
但是可惜,除了火狐,其他浏览器都不支持!!!


所以我决定自己实现一个

2. 思路

  1. 判断浏览器是否支持scoped
  2. 找到页面中所有带有scoped属性的style元素,给其父元素添加一个属性
  3. 修改style中的所有css选择器,加上属性前缀
  4. 监听dom变化,处理动态创建的<style scoped>

3. 编码

1. 判断浏览器是否支持scoped

if (document.createElement("STYLE").scoped !== undefined) {
    return;
}

2. 找到页面中所有带有scoped属性的style元素,给其父元素添加一个属性

[...document.getElementsByTagName('style')].forEach(x => updateStyle(x));
/**
 * 处理 <style> 标签
 * @param style dom
 */
function updateStyle(style) {
    if (!style
        || style.parentElement == null
        || style.parentElement == document.head
        || style.parentElement == document.body
        || !style.hasAttribute("scoped")
        || style.scoped === true) {
        return;
    }
    style.scoped = true; // 防止重复处理
    const scope = ("_" + (Math.random() * 100000000).toString("36")).replace('.', '');
    style.parentElement.setAttribute(scope, '');
    // 处理css
}

3. 修改style中的所有css选择器,加上属性前缀

/**
 * 为选择器添加范围前缀scope
 * @param {String} selector css选择器
 * @param {String} scope css范围前缀
 * @returns 返回修改后的css选择器
 */
function updateSelector(selector, scope) {
    return selector.split(",").map(x => x.replace(/((?<=^\s*)\s|^)([\S])/, "$1" + scope + " $2")).join(",");
}
/**
 * 将css代码中所有选择器都加上范围前缀scope
 * @param {String} css css代码
 * @param {String} scope css范围前缀
 * @returns 返回修改后的css代码
 */
function updateCss(css, scope) {
    // css = css.replace(/[\n\r\s]+/g, " "); // 去掉多余的空格和回车
    css = css.replace(/("[^"]*")|('[^']*')/g, x => x.charAt(0) + encodeURIComponent(x.slice(1, -1)) + x.charAt(0)); // 去字符串干扰 
    css = css.replace(/[^{}]+{/g, x => updateSelector(x, scope));
    css = css.replace(/("[^"]*")|('[^']*')/g, x => x.charAt(0) + decodeURIComponent(x.slice(1, -1)) + x.charAt(0)); // 还原字符串 
    return css;
}

用正则处理还是会有一些问题的,不过胜在代码简洁,实际使用中只要注意避开就好了,比如下面这段css就会有问题

@keyframes show {
    100% {
        opacity: 1;
    }
}

4. 监听dom变化,处理动态创建的<style scoped>

// 当观察到变动时执行的回调函数
const callback = function (mutationsList) {
    if (mutationsList.length == 0) {
        return;
    }
    for (const mutation of mutationsList) {
        for (const node of mutation.addedNodes) {
            if (node.nodeName === "STYLE") {
                updateStyle(node);
            }
        }
    }
};
// 创建一个观察器实例并传入回调函数
const observer = new MutationObserver(callback);
const config = { childList: true, subtree: true };
observer.observe(document, config);
// MutationObserver 是异步的,回调时间不可控,所以需要设置一个轮询
setInterval(() => callback(observer.takeRecords()), 100);

5. 完整代码


// style scoped
(() => {
    // 检测原生 style是否支持 scoped 
    if (document.createElement("STYLE").scoped !== undefined) {
        return;
    }
    document.createElement("STYLE").__proto__.scoped = false;

    /**
     * 为选择器添加范围前缀scope
     * @param {String} selector css选择器
     * @param {String} scope css范围前缀
     * @returns 返回修改后的css选择器
     */
    function updateSelector(selector, scope) {
        return selector.split(",").map(x => x.replace(/((?<=^\s*)\s|^)([\S])/, "$1" + scope + " $2")).join(",");
    }

    /**
     * 将css代码中所有选择器都加上范围前缀scope
     * @param {String} css css代码
     * @param {String} scope css范围前缀
     * @returns 返回修改后的css代码
     */
    function updateCss(css, scope) {
        // css = css.replace(/[\n\r\s]+/g, " "); // 去掉多余的空格和回车
        css = css.replace(/("[^"]*")|('[^']*')/g, x => x.charAt(0) + encodeURIComponent(x.slice(1, -1)) + x.charAt(0)); // 去字符串干扰 
        css = css.replace(/[^{}]+{/g, x => updateSelector(x, scope));
        css = css.replace(/("[^"]*")|('[^']*')/g, x => x.charAt(0) + decodeURIComponent(x.slice(1, -1)) + x.charAt(0)); // 还原字符串 
        return css;
    }

    /**
     * 处理 <style> 标签
     * @param style dom
     */
    function updateStyle(style) {
        if (!style
            || style.parentElement == null
            || style.parentElement == document.head
            || style.parentElement == document.body
            || !style.hasAttribute("scoped")
            || style.scoped === true) {
            return;
        }
        style.scoped = true; // 防止重复处理

        const scope = ("_" + (Math.random() * 100000000).toString("36")).replace('.', '');
        style.parentElement.setAttribute(scope, '');

        style.textContent = updateCss(style.textContent, "[" + scope + "]");
    }

    // 当观察到变动时执行的回调函数
    const callback = function (mutationsList) {
        if (mutationsList.length == 0) {
            return;
        }
        for (const mutation of mutationsList) {
            for (const node of mutation.addedNodes) {
                if (node.nodeName === "STYLE") {
                    updateStyle(node);
                }
            }
        }
    };

    // 创建一个观察器实例并传入回调函数
    const observer = new MutationObserver(callback);
    const config = { childList: true, subtree: true };
    observer.observe(document, config);

    // MutationObserver 是异步的,回调时间不可控,所以需要设置一个轮询
    setInterval(() => callback(observer.takeRecords()), 100);

    [...document.getElementsByTagName('style')].forEach(x => updateStyle(x));
})();

6. Demo

https://jsrun.net/tgcKp

7. 项目中应用

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