npm 包 bem-kit 使用教程

在前端开发中,特别是在大型项目中,使用 BEM(块、元素、修饰符)命名约定可以帮助我们规范化命名、减少命名冲突,并且使代码更具可读性。然而,BEM 的书写方式比较繁琐,特别是对于新手来说,可能会感到不方便。

因此,开发者开发了一些工具来帮助快速有效地使用 BEM 命名约定,在此介绍一款常用的 npm 包,即 bem-kit。

什么是 bem-kit

bem-kit 是一个快速为 BEM 命名约定生成样式类名称的工具。它遵循原生 CSS 和 SCSS 的书写规范,使用变量和混合器封装了 BEM 命名规则,让“根据 BEM 命名约定编写 CSS”的过程更简便。

如何安装 bem-kit

你可以在命令行中使用 npm 安装 bem-kit:

--- - -------

如何使用 bem-kit

安装完成后,需要在 css 或 scss 文件中引入 bem-kit:

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

该语句将在 your-project/node_modules/bem-kit/src 目录中搜索样式源码。

例如,我们为“header”组件添加样式:

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

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

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

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

在这个例子中,我们使用 @include block 创建一个块级样式,然后使用 @include element@include modifier 创建元素和修饰符样式。

  • @include block 的作用是用于添加块元素样式;
  • @include element 用于创建块元素内的元素样式,如上例的 logo,输出的样式类名为 .header__logo
  • @include modifier 用于创建带有修饰符的样式,输出的样式类名为 .header--primary.header--secondary

bem-kit 还提供了一些其他的命名封装,如 @include utility 将帮助我们快速编写常用的可复用的样式类。

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

Stylelint 集成

bem-kit 与 Stylelint 集成可以有效帮助过滤未正确命名的样式,以确保代码遵循规范。要使用 bem-kit 和 Stylelint 需要遵循以下步骤:

  1. 安装依赖:
--- - --------- -------------- -------------------------------- ----------------------------------
  1. 在项目根目录中创建 .stylelintrc 文件,并添加样式配置:
-
  ---------- -
    -----------------------------------
    ------------------------------------
  --
  -------- -
    --------------------- -
      -----
      -
        ---------------- ------------ -----
      -
    --
    -------------------- --
    ---------------------------------- -
  -
-
  1. 将 bem-kit 添加到 .stylelintrc 文件中:
-
  ---------- -
    -----------------------------------
    -------------------------------------
    ---------
  --
  -------- -
    --------------------- -
      -----
      -
        ---------------- ------------ -----
      -
    --
    -------------------- --
    ---------------------------------- -
  -
-

总结

bem-kit 是一个简单易用的 BEM CSS 命名工具,它可以帮助我们更高效地在项目中应用 BEM 命名约定。使用 bem-kit 不仅可以提高开发效率,还能避免因人工书写样式类名称而引起的错误。我们希望这篇文章能帮助你更好的了解 bem-kit 并在实践中使用它。

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


猜你喜欢

  • npm 包 @corbinu/code 使用教程

    前言 前端开发过程中,我们经常使用各种工具和框架来辅助我们开发。其中,npm 包是非常重要的一部分,因为 npm 是一个庞大的生态系统,其中有数以千计的第三方包,可以极大地方便我们的开发。

    3 年前
  • npm 包 shimiteer 使用教程

    引言 随着前端开发的快速发展,前端技术领域的 npm 包数量也越来越多。npm 这一包管理工具极大地简化了开发者的工作,让前端应用的开发变得更加高效和便捷。而在许多 npm 包中,极具实用性的 shi...

    3 年前
  • npm 包 redux-asynch-middleware 使用教程

    介绍 redux-asynch-middleware 是一个用于处理异步 action 的 redux 中间件。它可以使得我们在 redux 中以更加清晰规范的方式进行异步处理。

    3 年前
  • npm 包 cordova-plugin-acmp 使用教程

    简介 cordova-plugin-acmp 是一个 Cordova 插件,用于 Android 平台音乐播放和控制。该插件封装了 Android 可用的 MediaPlayer 类,以便于前端开发者...

    3 年前
  • npm 包 express-resolve-path 使用教程

    npm包express-resolve-path使用教程 在前端开发中,我们通常需要使用Node.js和npm包管理器来构建Web应用程序。而其中一个重要的npm包就是express-resolve-...

    3 年前
  • npm 包 mip-forms 使用教程

    mip-forms 是一个用于快速创建表单的 npm 包。在前端开发中,表单常常是不可或缺的一部分。mip-forms 可以帮助开发者快速创建表单,并提供轻松的表单数据管理功能。

    3 年前
  • npm 包 pinyin-engine 使用教程

    简介 Pinyin Engine 是一个用于将中文汉字转化成拼音的 npm 包。通过这个包,您可以方便地将中文汉字转化成拼音,并且可以选择不同的转化模式。本文将向您介绍 pinyin-engine 的...

    3 年前
  • npm 包 vue-simple-assistive-ball 使用教程

    介绍 vue-simple-assistive-ball 是一个 Vue.js 组件,提供一个半透明的浮动球,用户可以拖动它来打开相关的功能弹窗,如回到顶部、侧边栏等功能。

    3 年前
  • npm 包 react-vr-hand 使用教程

    在实际的前端开发中,我们往往需要使用到各种第三方库来提高我们的开发效率和代码质量。npm 是目前最为流行的 JavaScript 包管理器之一,而 react-vr-hand 就是 npm 上提供的一...

    3 年前
  • npm 包 hummus-form-basics 使用教程

    介绍 npm 包 hummus-form-basics 是一个基于 HummusJS 的 PDF 表单操作工具。使用该工具,您可以轻松地在 PDF 文件中创建、填写、保存表单。

    3 年前
  • npm 包 notify_sender 使用教程

    1. 简介 notify_sender 是一个基于 Node.js 的 npm 包,用于发送桌面通知。它支持 Windows、macOS 和 Linux 平台,并且可以自定义通知的标题、消息内容和图标...

    3 年前
  • npm 包 react-category-jd 使用教程

    介绍 react-category-jd 是一个层次分类组件,可以让用户方便地选择多个分类项。react-category-jd 针对京东的分类展示进行了优化,界面美观且易于使用。

    3 年前
  • NPM包react-native-cards使用教程

    介绍 react-native-cards是一个React Native组件库,它可以让你轻松地创建卡片式UI。它提供了多种样式和皮肤,你可以根据自己的需要选择合适的卡片风格。

    3 年前
  • npm 包 unixtimejs 使用教程

    1. 简介 Unix 时间戳(Unix Time Stamp)是从 1970 年 1 月 1 日 00:00:00 UTC 到当前时间的秒数。在前端开发中,经常会涉及到时间戳的转换和比较,这时我们可以...

    3 年前
  • npm 包 hyper-giphy-stickers 使用教程

    简述 hyper-giphy-stickers 是一个帮助我们在 Hyper 终端中使用 Giphy 表情包的 npm 包。它以命令行的形式为终端用户提供了一个接口,用于搜索并自动粘贴 Giphy 表...

    3 年前
  • npm 包 jquery.autocomplete-multiple 使用教程

    介绍 jquery.autocomplete-multiple 是一个能够提供自动补全多选功能的 jQuery 插件。该插件利用了 jQuery UI Autocomplete 控件的能力,提供了多选...

    3 年前
  • Neutrino 中间件 neutrino-middleware-case-sensitive-paths 使用教程

    简介 在前端开发中,我们经常遇到因为大小写不敏感而导致的一些问题,如文件名大小写不一致、import 导入时错误等。neutrino-middleware-case-sensitive-paths 就...

    3 年前
  • npm 包 neutrino-preset-stylelint-l3e 使用教程

    在前端开发中,我们经常遇到要编写样式的情况。而写好的样式需要保持良好的可读性和可维护性,这是我们需要使用规范化工具的原因之一。StyleLint 是一款常用的样式规范工具之一,它可以让我们在写 CSS...

    3 年前
  • npm 包 chalk-optimiser 使用教程

    在前端开发过程中,控制台日志是很重要的一环,但是默认的控制台输出往往不够直观、美观,而 npm 包 chalk-optimiser 则可以帮助我们更好地定制控制台输出样式,让日志信息更加易读易懂。

    3 年前
  • npm 包 foxtrel-command-release 使用教程

    介绍 在前端开发中,我们经常需要发布我们的 Web 应用程序。这涉及到许多步骤,如测试、构建、打包和发布。为了自动化这些任务,我们可以使用一些工具来帮助我们完成这些任务。

    3 年前

相关推荐

    暂无文章