跳到正文

组件状态和就近差异样式(1):根状态、BEM 与样式隔离

组件状态和就近差异样式

  1. 根状态、BEM 与样式隔离(当前)
  2. 选择器简写的匹配边界
  3. SCSS、Less、Stylus 与 PostCSS 的维护成本

写组件样式时,经常需要处理一层联动:组件本身进入某个状态,里面一组子元素的表现随之变化。

比如一个上传组件进入已选择文件、上传中、上传失败这几种状态时,预览图、按钮、提示文案都会跟着变。问题是,这个状态到底应该放在哪里。

如果状态全散在子元素上,模板很快会变乱;如果样式全堆在文件底部,读代码时又要来回跳。更好的入口是组件根元素:组件自己的状态放在根元素上,子元素只负责根据这个状态改变表现。

根状态怎样匹配子元素,取决于选择器的写法。&、@at-root、空格和拼接这些机制,主要来自 SCSS、Less、Stylus 这类预处理器,或 PostCSS 插件这类后处理器;React 和 Vue 在此基础上叠加各自的样式隔离方式。

BEM 在这里解决什么

BEM 是一套 class 命名方法:Block 表示组件或模块,Element 表示组件内部元素,Modifier 表示变体或状态。

放到上传组件里,大概就是这样:

  • upload-card 是 Block,表示整个上传组件。
  • upload-card__preview 是 Element,表示上传组件里的预览区域。
  • upload-card--is-ready 是 Modifier,表示上传组件进入已准备状态。

一个组件状态影响多个子元素时,状态 class 写成裸 is-ready 很难看出它属于哪个组件;子元素写成 .preview、.button 也容易在大项目里撞名,搜索时也看不出归属。

BEM 的价值是把归属写进 class 名里:upload-card--is-ready 影响的是 upload-card 这个 Block,upload-card__preview 也是同一个 Block 里的元素。后面讨论根状态和子元素联动时,才能明确知道这些选择器是在同一个组件边界里工作。

在浏览器检查元素时,根 class 也能成为源码入口。普通 Vue SFC 通常按文件名取组件名,EmptyState.vue 的根 Block 就写 empty-state。Nuxt 默认自动导入会把目录拼进组件名,例如 app/components/common/empty-state.vue 自动注册为 CommonEmptyState,根写 common-empty-state,子元素写 common-empty-state__heading。Vue 的 scoped 属性负责限定样式匹配,Block 名负责表达归属。 Vue 的组件引用 · Nuxt 的组件命名

目录路径与组件名直接对应的项目,可以启用 ESLint 检查单个原生根元素的静态 Block。多根组件、插槽和组件转发根按实际 DOM 归属处理,避免为命名多包一层元素。

组件自己的状态放在根元素上

组件自己的状态指的是会影响整个组件表现的状态。它不一定改变根元素自己的样式,但它会让多个子元素同时变化。

比如上传组件里的这些状态:

  • 已选中文件:预览图出现,按钮文案变化,文件信息出现。
  • 上传中:预览图变淡,按钮禁用,进度提示出现。
  • 上传失败:提示文案变成错误态,按钮变成重试入口。

先只看状态入口和样式摆放,最常见的是三种放法。

第一种是每个子元素自己判断:预览图加一个状态,按钮再加一个状态,提示文案也加一个状态。

<section class="upload-card">
  <div class="upload-card__preview upload-card__preview--is-ready"></div>
  <button class="upload-card__button upload-card__button--is-ready">继续上传</button>
  <p class="upload-card__hint upload-card__hint--is-ready">文件已准备好。</p>
</section>
.upload-card__preview {
  opacity: 0;
}

.upload-card__preview--is-ready {
  opacity: 1;
}

.upload-card__button {
  border-color: #b8c4d6;
}

.upload-card__button--is-ready {
  border-color: #1976d2;
}

.upload-card__hint {
  display: none;
}

.upload-card__hint--is-ready {
  display: block;
}

这能工作,但真实模板里这些 --is-ready 往往都来自同一个条件。状态越多,模板里重复判断越多,状态入口也被拆散了。

第二种是把状态放到组件根元素上。

<section class="upload-card upload-card--is-ready">
  <div class="upload-card__preview"></div>
  <button class="upload-card__button">继续上传</button>
  <p class="upload-card__hint">文件已准备好。</p>
</section>
.upload-card__preview {
  opacity: 0;
}

.upload-card__button {
  border-color: #b8c4d6;
}

.upload-card__hint {
  display: none;
}

.upload-card--is-ready .upload-card__preview {
  opacity: 1;
}

.upload-card--is-ready .upload-card__button {
  border-color: #1976d2;
}

.upload-card--is-ready .upload-card__hint {
  display: block;
}

这比第一种好,状态入口已经集中到了根元素。但样式文件变成了「先写基础样式,再去别处找状态覆盖」。读到 upload-card__preview 时,看不全预览图自己的变化;状态多了以后,成组的状态覆盖选择器也会堆在一起。

第三种仍然把状态放在根元素上,但把差异样式放回被影响的子元素附近。

<section class="upload-card upload-card--is-ready">
  <div class="upload-card__preview"></div>
  <button class="upload-card__button">继续上传</button>
  <p class="upload-card__hint">文件已准备好。</p>
</section>
.upload-card__preview {
  opacity: 0;
}

.upload-card--is-ready .upload-card__preview {
  opacity: 1;
}

.upload-card__button {
  border-color: #b8c4d6;
}

.upload-card--is-ready .upload-card__button {
  border-color: #1976d2;
}

.upload-card__hint {
  display: none;
}

.upload-card--is-ready .upload-card__hint {
  display: block;
}

这版基础写法把状态入口放在根元素,子元素的状态差异紧邻自己的基础样式。完整的标准 CSS 选择器,也能直接看出根状态和子元素的关系。

完整选择器的问题也很明显:每个差异都要重复写 .upload-card--is-ready 和对应的子元素 class。预处理器和后处理器提供的 &、嵌套和 @at-root 等能力,可以在保持选择器关系的同时减少重复代码,让差异就近维护。CSS Modules 和 scoped 处理样式作用范围,BEM 标明结构和状态归属。

这段关系适合先用一个小演示试一遍。切换「根 BEM modifier」「子元素重复状态」「裸祖先状态」和「CSS 变量通道」时,注意统计里的状态 class 分布;再勾选「外层容器也带 is-ready」,裸祖先状态会更容易暴露误伤风险。

组件根状态和子元素差异演示正在加载代码工作区...

根元素既带有状态 class,也是子元素的祖先。选择器需要准确表达这层联动;&、@at-root、拼接和空格的用法,决定状态匹配的是当前元素还是祖先元素。

& 和 @at-root 的选择器输出

& 引用的是当前完整父选择器。它既可以参与后代选择器,也可以参与拼接选择器。两者差一个空格,语义完全不同。

先看 Less:

.outer {
  .inner {
    .is-b& {
      color: red;
    }

    .is-b & {
      color: blue;
    }
  }
}

输出是:

.is-b.outer .inner {
  color: red;
}

.is-b .outer .inner {
  color: blue;
}

第一段是拼接:.is-b 被拼到当前完整选择器的第一个 compound selector 上。第二段是后代:.is-b 是外部祖先。

后代选择器 .is-b & 明确表示外层有一个状态祖先;.is-b& 则把状态 class 拼到当前 selector 上。少了一个空格,状态匹配的位置就变了。

SCSS 不接受 .is-b&。按 Sass parent selector 的规则,& 不能放在 span& 这类 compound selector 后面。SCSS 要用插值和 @at-root:

.outer {
  .inner {
    @at-root .is-b#{&} {
      color: red;
    }

    @at-root .is-b #{&} {
      color: blue;
    }
  }
}

输出同样分成拼接和后代:

.is-b.outer .inner {
  color: red;
}

.is-b .outer .inner {
  color: blue;
}

这时还没有框架,也没有 CSS Modules 或 scoped。这里只能得出一个基础结论:@at-root .is-b#{&} 是 SCSS 里的拼接写法,@at-root .is-b #{&} 是外部祖先写法。

再看一个更贴近组件的例子:

.root {
  @at-root .is-ready#{&} {
    border-color: #86efac;
  }

  .preview-image {
    @at-root .is-ready#{&} {
      opacity: 0.72;
    }
  }
}

输出是:

.is-ready.root {
  border-color: #86efac;
}

.is-ready.root .preview-image {
  opacity: 0.72;
}

这就是 @at-root .is-ready#{&} 的一个好处:不用关心当前写在根节点块里,还是写在子元素块里。& 是 .root 时输出 .is-ready.root;& 是 .root .preview-image 时输出 .is-ready.root .preview-image。

先展开 SCSS,再看选择器的真实含义

命名、class 映射与属性约束,分别解决什么

React

React 这边可以先按样式隔离方式分成两条路:用了 CSS Modules,就按模块局部 class 处理;不用 CSS Modules、继续写普通全局 CSS,就可以按 BEM 处理。

CSS Modules:不必套 BEM

在 React 场景里,如果仍然用样式文件管理组件样式,CSS Modules 是很常见的主流写法。换成 CSS Modules 后,class 名进入模块局部作用域,源码里可以回到小驼峰:

<section className={clsx(styles.root, fileIsReady && styles.isReady)}>
  <img className={styles.previewImage} src={previewUrl} alt="" />
  <button className={styles.copyButton}>复制</button>
</section>;

styles.isReady 仍然挂在组件根节点。它只是模块内的局部状态 class,不需要写成 root--is-ready,也不需要硬套 BEM。CSS Modules 后续会把 .root、.isReady、.previewImage 映射成带 hash 的实际 class,唯一性由工具链兜住。

根状态影响根节点自己时,两种写法都可以:

.root {
  &.isReady {
    border-color: #86efac;
  }
}

也可以写成:

.root {
  @at-root .isReady#{&} {
    border-color: #86efac;
  }
}

两者都会命中根节点。为了和子元素就近写法保持一致,CSS Modules 场景里也可以统一用 @at-root .isReady#{&}。这样写的时候不用关心当前块是根节点还是子元素,& 会自己展开成当前选择器。

根状态影响子元素时:

.root {
  .previewImage {
    opacity: 1;

    @at-root .isReady#{&} {
      opacity: 0.72;
    }
  }
}

Sass 输出是:

.isReady.root .previewImage {
  opacity: 0.72;
}

.isReady.root 和 .root.isReady 命中的是同一个根节点,顺序不影响表现。

再看几个组合:

.root {
  &.isUploading {
    cursor: progress;
  }

  &.isCompact {
    .copyButton {
      min-width: 96px;
    }
  }

  .copyButton {
    @at-root .isReady#{&} {
      color: #047857;
    }

    @at-root .isUploading#{&} {
      pointer-events: none;
    }
  }
}

这些写法都建立在一个前提上:样式文件从唯一根 class .root 开始。顶层不要再套外部容器、逗号选择器或根级 :global(...)。如果顶层先套一层 .card:

.card {
  .root {
    .previewImage {
      @at-root .isReady#{&} {
        opacity: 0.72;
      }
    }
  }
}

输出会变成:

.isReady.card .root .previewImage {
  opacity: 0.72;
}

状态被拼到了 .card 上;但 React 代码通常把 styles.isReady 挂在 .root 所在的 DOM 上,这时选择器就匹配不上。

逗号选择器也容易让分支丢状态:

.root,
.panel {
  .previewImage {
    @at-root .isReady#{&} {
      opacity: 0.72;
    }
  }
}

Sass 输出是:

.isReady.root .previewImage,
.panel .previewImage {
  opacity: 0.72;
}

第二个分支没有 isReady 约束。

在本文的单一 .root 约定下,状态 class 挂根节点,根节点和子元素都可以用 @at-root .isReady#{&}。class 的局部命名由 CSS Modules 处理,不需要再靠 BEM 保证唯一性。

普通全局 CSS:用 BEM 标明归属

React 项目如果使用普通全局 CSS,仍然可以按 BEM 写:

<section className={clsx('upload-card', fileIsReady && 'upload-card--is-ready')}>
  <img className="upload-card__preview" src={previewUrl} alt="" />
  <button className="upload-card__button">复制</button>
</section>;

这时要像 Vue scoped + BEM 一样考虑状态归属、根状态和子元素的关系;额外还要保证 Block 在全局样式空间里足够唯一。React 普通 CSS 没有 Vue scoped 的 data-v-* 自动限制,也没有 CSS Modules 的 hash 映射,.upload-card 这类 Block 一旦命名太泛,就会和其他页面或组件互相影响。

Vue

Vue 同样支持 CSS Modules。本文主要讨论我采用的 SFC scoped + BEM 写法,先说明它与 CSS Modules 的职责差异。

CSS Modules:局部 class 由工具链处理

Vue 也能用 CSS Modules。写法大概是这样:

<template>
  <section :class="[$style.root, fileIsReady && $style.isReady]">
    <img :class="$style.previewImage" :src="previewUrl" alt="" />
    <button :class="$style.copyButton">复制</button>
  </section>
</template>

<style module lang="scss">
.root {
  border-color: #d8e0ea;
}

.previewImage {
  opacity: 1;
}

.copyButton {
  color: #2563eb;
}

.root.isReady {
  border-color: #86efac;
}

.root.isReady .previewImage {
  opacity: 0.72;
}
</style>

如果 Vue 项目真的使用 CSS Modules,它和 React CSS Modules 一样,不需要靠 BEM 解决 class 全局唯一性,也不需要纠结 upload-card--is-ready 这类 Block modifier。状态仍然挂在根节点,差异样式仍然描述根状态和子元素的关系,只是 class 的局部化交给 CSS Modules。

采用 scoped 时,模板可以直接写语义化 class,再由 Vue 编译器加上 data-v-* 限制,不需要 $style.xxx。这条路线里,scoped 负责选择器范围,BEM 负责让读者看出结构和状态归属,两者不能互相替代。

Scoped + BEM:状态要带上 Block

Vue SFC 的 <style scoped> 会把当前组件里的样式限制在当前组件 DOM 上。按 Vue SFC CSS Features 的说明,scoped 会通过类似 data-v-* 的属性改写选择器和组件渲染出来的元素;子组件根节点也会同时受到父组件 scoped 样式和子组件自身 scoped 样式影响。

这层 data-v-* 对 Vue 项目很重要。没有它,.title、.button、.is-ready 这类普通 class 在大项目里很容易互相撞。BEM 能提升命名可读性和搜索能力,但真正把当前 SFC 样式限制在当前组件里的,是 Vue scoped 的 data attribute 机制。

所以 Vue scoped + BEM 里,组件状态不要写成裸 is-ready。根节点应该这样:

<section class="upload-card upload-card--is-ready">
  <div class="upload-card__preview"></div>
  <button class="upload-card__button">继续上传</button>
</section>

upload-card--is-ready 属于整个 upload-card。预览区变淡、按钮文案变化、底部信息出现,都是同一个根状态派生出来的表现。

可以这样分:

  • upload-card--compact 这类稳定形态,用普通 BEM modifier。
  • upload-card--is-ready、upload-card--is-uploading、upload-card--is-failed 这类影响整个组件的运行时状态,也用 BEM modifier,但 modifier 内容以 is- 开头。
  • upload-card__drop-zone--is-dragging 这类只属于某个元素的瞬时状态,跟着那个元素自己的 class 走。

这样做有两个收益:

  • 搜 upload-card--is-ready 就能知道状态属于哪个组件。
  • scoped 输出里,状态选择器也会继续带当前组件的 data-v-* 限制。

Scoped + BEM 的差异样式要靠近被影响元素

状态放在根节点以后,样式还有一个取舍:差异应该写在根节点状态块里,还是写在子元素块里?

可以写成这样:

.upload-card {
  &--is-ready {
    .upload-card__preview {
      opacity: 0.72;
    }

    .upload-card__button {
      border-color: #1976d2;
    }
  }
}

这能看出 upload-card--is-ready 会影响哪些子元素,但子元素自己的基础样式和状态差异被拆开了。组件复杂一点以后,读 upload-card__preview 时还要去根节点状态块里找它被谁改过。

更适合维护的写法是把差异放回子元素附近:

.upload-card {
  $root: &;

  &__preview {
    opacity: 1;

    #{$root}--is-ready & {
      opacity: 0.72;
    }
  }

  &__button {
    border-color: #b8c4d6;

    #{$root}--is-ready & {
      border-color: #1976d2;
    }
  }
}

Sass 输出的关键选择器是:

.upload-card--is-ready .upload-card__preview {
  opacity: 0.72;
}

经过 Vue scoped 后,普通后代选择器会在目标元素一侧加上作用域属性。以 Vue 3.5.44 的 compileStyle 输出为例:

.upload-card--is-ready .upload-card__preview[data-v-xxx] {
  opacity: 0.72;
}

生成的选择器需要同时满足两层关系:

  • upload-card--is-ready 和 upload-card__preview 都属于同一个 Block。
  • data-v-xxx 限制被匹配的预览元素;编译器没有给这里的祖先状态段自动补上同样的属性。

因此 scoped 不能替裸祖先状态补出 Block 归属。.is-ready .upload-card__preview[data-v-xxx] 仍可能被外层同名状态触发,祖先关系要由 class 选择器自己表达。子组件根节点和递归组件的匹配范围也仍需按 Vue 的 scoped 规则检查。

总结

同一个组件状态影响多个子元素时,状态入口留在根节点,差异样式靠近被影响的元素,可以同时减少模板里的重复判断和样式里的来回查找。选择器仍要准确表达根与子元素的关系:CSS Modules 负责局部 class 映射;Vue scoped 限制匹配范围,BEM 补足结构和状态归属,不能靠 scoped 把裸祖先状态变成当前 Block 的状态。

下一篇:选择器简写的匹配边界。