如何利用CSS BEM规范编写高质量的UI库示例文档?

浅婷小哥_9390

浅婷小哥_9390

2026-07-13

324人浏览

原创

bem文档是模块契约说明书而非类名列表。需明确block物理边界(如button必须是独立dom节点)、三名一致(button.vue→button)、element层级约束(button__text仅限直接子节点)、modifier叠加规则与冲突警告,并杜绝嵌套element、大小写混用等错误。

如何利用css bem规范编写高质量的ui库示例文档?

直接说结论:BEM文档不是类名列表,而是模块契约说明书。写错位置、漏写叠加规则、用错连接符,都会让下游开发者在真实项目里卡住两小时——而且查不出问题。

怎么写清 Block 的物理边界和复用契约

文档里只写「按钮用 button 作 Block」远远不够。必须明确:

  • button 必须是可独立渲染的 DOM 节点(比如 <button class="button"></button> 或 <div class="button">),不能只是包裹用的 <code><div> <li>文件名、组件名、Block 类名三者必须严格一致:<code>Button.vue → button,不是 btn 或 ui-button
  • 如果某个视觉单元(如 icon)在按钮、导航、弹窗中都出现且行为一致,它就必须是独立 Block,不能塞进 button__icon
  • 常见错误现象:文档写“card__header 是卡片头部”,但没注明它是否允许嵌套 card__title;结果开发者写了 <div class="card__header"> <h2 class="card__title">,样式却失效——因为 <code>card__title 实际只接受 card 直接子节点。

    Element 文档必须标注 DOM 层级约束

    BEM 的 __ 不表示 DOM 嵌套深度,但 Element 在 HTML 中的位置是有硬约束的。文档需明确:

    • button__text 只能是 button 的**直接子节点**,中间不能隔 <span></span> 或 <div> <li>禁止出现 <code>button__text__highlight —— Element 不允许嵌套 Element,这是结构越界信号
    • 设计稿里若出现“带图标的按钮文字”,不能靠嵌套解决,而应拆成并列 Element:button__text + button__icon
    • 典型翻车点:设计师给的切图里 header__nav 下有 nav__item,文档没说明 nav__item 是否属于独立 Block;前端按 BEM 理解为 header__nav__item,结果样式全挂掉。

      CSS婚礼策划服务机构宣传网站模板
      CSS婚礼策划服务机构宣传网站模板

      CSS婚礼策划服务机构宣传网站模板是一款适合提供婚礼策划和婚庆服务机构宣传网站模板下载。提示:本模板调用到谷歌字体库,可能会出现页面打开比较缓慢。

      下载

      Modifier 文档要写明叠加规则与冲突警告

      修饰符不是开关贴纸,文档必须声明哪些能共存、哪些会打架:

      • button--primary 和 button--disabled 可叠加,但前提是 CSS 规则不依赖选择器权重(即必须用 .button--disabled { },而非 .button.button--disabled { })
      • button--large 和 button--small 互斥,文档需加 ⚠️:“二者不可同时使用,否则尺寸定义冲突”
      • 禁止出现 button__text--large —— -- 只能作用于 Block 或其直属 Element,不能降级到子元素内部

      错误示例不能只说“这样不对”,要附真实线索:比如写 class="button--primary button--large" 却没生效,实际是因为构建时 cssnano 合并了简写属性,把 padding: 12px 24px 压成了 padding: 12px 24px,但 button--large 的规则被覆盖了——这种线索比“命名错误”有用十倍。

      类名拼写错误是落地第一道坎

      __ 和 -- 写反不是风格问题,是直接导致样式不生效或意外覆盖。浏览器不报错,但人脑会卡住:

      • button--icon 匹配的是“一种叫 icon 的按钮”,你要改的其实是按钮里的图标——得用 button__icon
      • dialog__header__title 是非法结构,应为 dialog__title;BEM 工具不会报错,但团队 grep 搜不到 dialog__title,协作链就断了
      • button--primary__icon 解析失败,BEM 工具直接忽略,样式白写

      最隐蔽的坑是大小写混用:BtnPrimary 或 btnPrimary 都不合法,grep 搜不到,CI 检查也过不了——BEM 不处理大小写,但团队协作时它就是事实标准。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

作者最新文章

热门AI工具

更多

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

4456

6

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.27

977

5

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.28

1838

6

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

2023.08.01

3486

7

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

2023.08.10

6985

11

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

2023.08.10

5931

7

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

2023.08.21

2017

9

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

2023.08.22

2831

5

css禁止点击事件
css禁止点击事件

实现css禁止点击事件的方法有使用CSS的pointer-events属性和使用JavaScript禁用点击事件。本专题为大家提供点击事件相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2453

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

相关下载

更多

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 1.5万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 5.9万人学习

CSS教程
CSS教程

共754课时 | 96.8万人学习

最新文章

更多