npm 包 easy-bem-naming 使用教程

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

BEM(Block-Element-Modifier)是一种前端编码方法论,它提供了一种规则化的 CSS 类名命名方式,有助于提高可维护性和可扩展性。但是,BEM 的类名命名方式相对繁琐,易于出错。因此,开发了 easy-bem-naming 这个 npm 包,用于快速生成符合 BEM 命名规范的类名。

安装 easy-bem-naming

使用 npm 包管理工具,在项目根目录下执行以下命令安装 easy-bem-naming:

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

使用 easy-bem-naming

初始化 easy-bem-naming

在 JavaScript 代码中引入 easy-bem-naming:

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

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

执行上述代码,输出结果为:

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

easy-bem-naming 提供了默认的 BEM 命名规范,并将初始块名设置为 'block'。

基本用法

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

以上代码就是一些 easy-bem-naming 最基本的使用示例,将会得到他们所对应的 BEM 类名。

命名约定

在 BEM 的命名约定中,block、element、modifier 的命名需遵循一定的规则,例如:

  • block - 定义块名,使用 kebab-case(短横线)命名方式。
  • element - 如果 block 内的元素需要添加 class,需使用双下划线(__)连接。
  • modifier - 块和元素的状态变化,需使用单下划线(_)连接,如 block_mod。
----- ------ - --- ------------------------
-------------------- -- ------------------
------------------ -- ----------------

自定义命名约定

在 BEM 命名约定中,各个部分的命名方式可自行定制,可通过实例化时传入自定义参数进行设置。

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

指定作用域

在 BEM 命名规范中,block 是必选参数,如果在某些场景下不需要 block,请使用 childScope 来指定作用域,例如:

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

项目应用示例

以下代码演示了在 React 项目中如何使用 easy-bem-naming 生成符合 BEM 命名规范的样式类:

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

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

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

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

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

上述代码实现了一个 Button 组件,Button 组件使用 easy-bem-naming 生成符合 BEM 命名规范的类名,并将组件的 props 转换成对应的 BEM 类名。此示例代码有助于开发人员更好地理解如何在实际项目中使用 easy-bem-naming。

结论

easy-bem-naming 是一个非常实用的 npm 包,可用于快速生成符合 BEM 命名规范的类名。使用 easy-bem-naming 可以大大提高前端项目的可维护性和可扩展性。

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


猜你喜欢

  • npm 包 bmjs-random 使用教程

    npm 包 bmjs-random 使用教程 什么是 bmjs-random bmjs-random 是一个用于生成随机数的 npm 包。它提供了多种生成随机数的方式和选项,适用于前端和后端开发,可以...

    3 年前
  • npm 包 @vong/ssm-client 使用教程

    背景 在现代化的前端开发中,许多应用都需要从后端服务请求数据。但是,在实际项目中,业务代码与密钥信息的混淆会导致许多问题。在这种情况下,使用 AWS SSM Parameter Store 存储您的密...

    3 年前
  • npm 包 kobe-pull-element 使用教程

    在前端开发中,滑动下拉刷新是一个常见的交互功能。kobe-pull-element 是一款可以帮助我们实现滑动下拉刷新的 npm 包。本文将介绍如何使用 kobe-pull-element 实现滑动下...

    3 年前
  • npm 包 blendr.io-unified-api-js-sdk 使用教程

    在前端开发中,我们经常需要调用一些第三方的 API 来完成一些任务。而这些 API 的接口可能各式各样,对于前端开发者来说处理起来可能比较麻烦。为了帮助前端开发者更方便地使用各种 API,npm 上有...

    3 年前
  • npm 包 nodebb-plugin-save-plugins 使用教程

    简介 NodeBB 是一个基于 Node.js 的现代化论坛系统,具有高度的自定义和可扩展性。作为前端开发人员,我们需要不断寻找并尝试使用一些优秀的 NodeBB 插件来辅助我们开发。

    3 年前
  • 使用npm包starbucks-store-finder查找星巴克门店

    在前端开发中,使用npm包是非常常见的方式。特别是对于需要与第三方数据集成的任务,npm包能够极大的提高开发的效率。本文将介绍如何使用starbucks-store-finder获取星巴克门店数据。

    3 年前
  • npm 包 waapi-pack 使用教程

    WAAPI (Web Animation API) 是一组 Web API 的规范,用于在 Web 上创建和控制动画。WAAPI 通过提供一个可编程且有扩展性的动画效果实现机制来帮助开发者实现高质量动...

    3 年前
  • npm 包 clean-git 使用教程

    在前端项目开发中,我们经常会使用 Git 进行版本控制。但是有时候我们会因为一些不可避免的原因,比如误删除、误操作等,导致 Git 历史记录变得混乱。这个时候我们可以使用一个 npm 包来进行 Git...

    3 年前
  • npm 包 elite-dangerous-utils 使用教程

    在前端开发领域,npm 是一个非常重要的工具。它是一个包管理器,用于安装、更新、卸载本地的 JavaScript 包。这些包包含了有用的工具、库以及应用程序,用于帮助我们开发更高效、更可靠的应用程序。

    3 年前
  • npm 包 nestedtypes-next 使用教程

    在前端开发中,我们经常需要用到数据模型来管理和操作数据。而 npm 包 nestedtypes-next 就是一个非常强大的数据模型库。它可以帮助我们以一种有组织、可维护的方式管理复杂数据结构。

    3 年前
  • npm 包 reduxfire 使用教程

    在前端开发中,使用 Redux 进行状态管理已经成为一种非常常见的技术选择。而 reduxfire 是一个用于将 Firebase 实时数据库与 Redux 集成的 npm 包,它可以使我们更加方便地...

    3 年前
  • npm 包 rselect 使用教程

    npm 包 rselect 使用教程 在前端开发中,我们难免会遇到需要对表格或数据进行筛选的情况。使用 npm 包 rselect 可以快速实现自定义筛选功能,以提高用户体验和提升开发效率。

    3 年前
  • npm 包 elemental-modal 使用教程

    简介 elemental-modal 是一个基于 ReactJS 的模态框组件,功能简单但十分实用。在前端开发中,模态框常常用于展示用户交互信息,提示框等等,因此 elementa-modal 是一个...

    3 年前
  • npm 包 targiehandlu-ekomersy 使用教程

    在前端开发中,我们经常会使用各种工具和库来完成代码开发和优化。而 npm 是一个非常重要的包管理工具,可以让我们方便地安装和使用各种第三方包。其中,包括一个叫做 targiehandlu-ekomer...

    3 年前
  • npm 包 mobitel-iso-3166-countries 使用教程

    随着全球化和数字化的发展,越来越多的应用程序需要涉及国家和地区的信息。mobitel-iso-3166-countries 是一个专门针对国家和地区信息的 npm 包,为前端开发者提供了方便快捷的解决...

    3 年前
  • 使用graphql-needle包的详细教程

    什么是graphql-needle GraphQL-Needle 是一个轻便、易用的 GraphQL HTTP 客户端库,适用于浏览器和 Node.js。它支持全部 GraphQL 的特性,并为你提供...

    3 年前
  • npm包 mobitel-iso-639-locales使用教程

    前言 在前端开发中,我们常常需要处理国际化问题,比如针对不同地区的语言和文化进行本地化处理。为了便捷地实现这些本地化效果,我们通常会使用 npm 上的相关库和包。今天我们要介绍的是一个非常实用的 np...

    3 年前
  • NPM 包: mobitel-iso-4217-currencies 使用教程

    在前端开发中,我们常常需要对不同的货币进行处理。操作货币时,我们必须使用符合标准的三位字符货币代码。通常情况下,我们会手动查找符合要求的货币代码并进行处理。但是,这个过程非常耗时,而且容易出错。

    3 年前
  • npm 包 toggle-hotplug 使用教程

    随着前端技术的不断发展,开发人员在日常工作中使用的工具也越来越多。其中,npm 是前端工程师最常用的 JavaScript 包管理工具之一。它提供了数以万计的开源软件包,帮助开发人员更快速地构建应用程...

    3 年前
  • npm 包 react-native-duphlux 使用教程

    介绍 React Native Duphlux 是一个 React Native 库,可用于集成 Duphlux 服务。Duphlux 是一个自动电话验证服务,允许您验证来自任何国家的任何电话号码。

    3 年前

相关推荐

    暂无文章