npm 包 jsd-plugins-bem 使用教程

作为前端开发者,我们时常需要用到 BEM 命名规范来实现页面的样式。这时候,一个好用的 BEM 插件就能大大提高我们的效率。jsd-plugins-bem 就是一个不错的选择。接下来,让我们来学习如何使用 jsd-plugins-bem 这个 npm 包。

npm 包 jsd-plugins-bem 简介

jsd-plugins-bem 是一个用于生成 BEM 类名的插件。它可以帮助我们快速而简便地生成符合 BEM 命名规范的类名,从而提高我们的开发效率。

安装 npm 包 jsd-plugins-bem

安装 npm 包 jsd-plugins-bem 很简单。只需要在命令行中运行以下命令:

--- - --------------- ----------

使用 npm 包 jsd-plugins-bem

使用 jsd-plugins-bem 可以非常方便地生成符合 BEM 命名规范的类名,并且还能避免重复命名,提高代码的可维护性。

定义 block、element、modifier

在使用 jsd-plugins-bem 之前,需要先了解 BEM 命名规范中的 block、element、modifier 的定义。以及它们之间的连接符。

  • block 代表一个独立的组件或模块,是一个命名空间。它一般由多个单词组成,以连词线 "-" 分隔。例如:header、button 等。

  • element 代表 block 内的一个子元素,是在 block 的基础上延伸而来的一个元素。也由多个单词组成,以连词线 "-" 分隔。例如:header-title、button-text 等。

  • modifier 代表 block 或 element 的一个状态或者变化,是一个可选的部分。它也由多个单词组成,以连词线 "-" 分隔。例如:header-active、button-disabled 等。

生成 BEM 类名

使用 jsd-plugins-bem 生成 BEM 类名的方法非常简单。只需要在 HTML 文件中通过 data 属性指定 block、element、modifier 的名称,就能自动生成类名。

---- ------------------- --------------------
  -----------------------------

这样就会生成一个具有以下类名的 div 元素:

---- -------------------- -----------------------------

这个 div 元素会同时具有 block、element 和 modifier 的类名,以及它们之间的连接符。

避免重复命名

有时候,我们需要在同一页面中使用多个相同的 block 或 element。这时候,就需要避免重复命名,以保证页面的样式正确。

为了避免重复命名,我们可以在 data 属性中添加一个可选的数字(order)来表示组件的顺序。jsd-plugins-bem 会相应地在类名中添加一个数字后缀。

---- ------------------- --------------------- ---------------------
---- ------------------- --------------------- ---------------------

这样就会生成两个不同的 div 元素:

---- --------------------- -------------------------
---- --------------------- -------------------------

示例代码

以下是一个使用 jsd-plugins-bem 的示例代码:

---- -------------------
  --------------
  ---------------------
-
  ---- -------------------
    --------------------
  -------
  ---- ------------------
    -------------------
    ----------------------
  -------
  ---- ---------------------
    ----------------------
  -------
------

生成的类名如下:

---- ------------- ---------------
  ---- ---------------------------
  ---- ------------------ ---------------------------
  ---- -----------------------------
------

总结

npm 包 jsd-plugins-bem 是一个专门用于生成 BEM 类名的 npm 插件。它可以大大提高我们的前端开发效率,避免繁琐的手动命名工作。通过本文的介绍,相信读者已经能够轻松上手使用 jsd-plugins-bem 来生成符合 BEM 命名规范的类名。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5f07dd36403f2923b035bfa4


猜你喜欢

  • npm 包 remark-containers 使用教程

    概述 Markdown 是一种轻量级标记语言,很方便的为文本添加样式和结构。然而 Markdown 本身缺少对自定义的段落类型的支持。为了弥补这一缺陷,有一种灵活的解决方案是使用 remark-con...

    4 年前
  • npm包retext-smartypants使用教程

    前言 随着网络技术的发展,前端技术也越来越多元化、复杂化。而为了使得前端开发更加高效、准确,前端技术工具也随之应运而生。其中,npm包成为前端工具中不可或缺的一部分。

    4 年前
  • npm 包 mdsvex 使用教程

    简介 Mdsvex 是一个可通过 Markdown 进行操作的 Svelte 类型组件的编译器,它能够将 Markdown 转化为 JavaScript 模块,从而可以在 Svelte 项目中使用。

    4 年前
  • npm 包 bower-art-resolver 使用教程

    前言 前端开发中,我们常常需要引用第三方库(如 jQuery、Bootstrap 等),而这些库往往是存放在 bower_components 目录下的。但是,使用 npm 管理项目时,我们却无法直接...

    4 年前
  • npm 包 ab-translate 使用教程

    简介 npm 是 JavaScript 生态圈中非常重要的一个组成部分,提供各种可复用的包和模块,为前端开发者提供了更好的开发效率和代码质量。 ab-translate 是一个基于 npm 包管理的翻...

    4 年前
  • npm 包 petri-specs 使用教程

    简介 petri-specs 是一个用于前端视图层实验的工具,可以快速的完成 A/B 测试、灰度测试、新功能验证等任务。petri-specs 提供了一套完整的 API,可以在前端实现一些类似后端控制...

    4 年前
  • npm 包 rtlcss-webpack-plugin 使用教程

    在前端开发中,我们经常需要处理阿拉伯语、波斯语等从右到左阅读的语言。通常,我们会使用 rtlcss 包来处理 CSS 文件。然而,手动处理 CSS 文件比较繁琐,尤其是在复杂项目中。

    4 年前
  • npm 包 ruby-haml-loader 使用教程

    前言 在前端开发中,我们通常需要将我们的静态页面转化为 HTML 格式。而 Haml 是一种非常优雅的 HTML 预处理器,它允许我们使用缩进而不是标记来描述 HTML 结构。

    4 年前
  • npm 包 @ctrl/eslint-config 使用教程

    介绍 ESLint 是一个广泛使用的 JavaScript 代码检查工具。 它可以帮助开发者保持代码的一致性和避免错误。使用恰当的 ESLint 配置可以大大提高代码质量和开发效率。

    4 年前
  • npm 包 @ctrl/tinycolor 使用教程

    随着前端技术的快速发展,越来越多的工具和框架不断涌现,npm 包成为前端开发中不可或缺的一部分。而在这些 npm 包中,@ctrl/tinycolor 是一款十分优秀的颜色处理工具,今天我们就来详细了...

    4 年前
  • npm 包 css-font-size-keywords 使用教程

    什么是 css-font-size-keywords? css-font-size-keywords 是一个 npm 包,提供一组预定义的 CSS 字号关键词,可以用来替代具体的字号值。

    4 年前
  • npm 包 css-font-stretch-keywords 使用教程

    css-font-stretch-keywords 是一个npm包,它提供了一组缩放字体的关键字,可以在CSS代码中直接使用。本篇文章将介绍如何使用该npm包,并提供一些实用的示例。

    4 年前
  • npm 包 css-font-style-keywords 使用教程

    在前端开发过程中,字体样式的设置是非常常见的任务。为了方便开发人员快速设置字体样式,有许多 npm 包被开发出来。其中,css-font-style-keywords 就是一款非常实用的 npm 包。

    4 年前
  • npm 包 css-font-weight-keywords 使用教程

    在前端开发中,CSS 样式是非常重要的一部分,不同的样式可以让页面展现出不同的效果。其中,字体的样式也是非常重要的一部分,而字体的粗细度量通常通过字体的 "font-weight" 属性来控制。

    4 年前
  • npm 包 css-list-helpers 使用教程

    在前端开发中,样式布局是一个重要的部分。然而,制作列表布局时,我们经常会遇到一些问题。例如,想要让列表的每个项都有相同的宽度,或者想要设置列表项之间的间距和 padding。

    4 年前
  • npm 包 css-system-font-keywords 使用教程

    在前端开发中,字体是设计中不可或缺的要素之一。为了方便样式定义,CSS 3 提供了一种快速定义字体的方式:system-ui 系统字体关键字。但是这些关键字在不同的操作系统和浏览器上会有不同的默认值,...

    4 年前
  • npm 包 @jedmao/tsconfig 使用教程

    前言 在前端开发过程中,我们经常会用到 TypeScript 进行开发。而使用 TypeScript 的基础条件之一就是要有一个合适的 tsconfig.json 文件,以配置 TypeScript ...

    4 年前
  • npm 包 @jedmao/tslint 使用教程

    前端开发过程中,我们经常需要写出清晰易读的代码,并保持代码的一致性。然而,由于多人参与的开发过程中,常常会出现代码规范不一致的情况。这时候,我们就需要使用一些专业的工具来规范代码风格。

    4 年前
  • npm 包 parse-css-font 使用教程

    在前端开发中,我们经常需要解析 CSS 中的字体属性,比如字体名称、字体大小、字体粗细、行高等等。如果你尝试过手动解析 CSS 字体属性,你会发现其中包含的规则非常复杂,并且容易出现错误。

    4 年前
  • npm 包 jest-teamcity-reporter 使用教程

    前置知识 在介绍 jest-teamcity-reporter 的使用方法之前,我们需要了解一些前置知识: 什么是 Jest? Jest 是 Facebook 开源的 JavaScript 测试框架,...

    4 年前

相关推荐

    暂无文章