npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mukhindev/create-bem

v1.0.3

Published

Utility for creating BEM class names. CSS Modules support

Downloads

507

Readme

Create BEM

Utility for creating BEM class names. CSS Modules support.

BEM

Block, Element, Modifier

Elements is a child of Block. Modifiers refer of to Block or Element.

block-name
__element-name
_modifier-name or _modifier-key _modifier-value
mix-name

<label class="input">
  <span class="input__label"></span>
  <input class="input__field input__field_disabled input__field_size_large" />
</label>

CSS

import { createBem } from "@mukhindev/create-bem";

// BEM-block (function)
const bem = createBem("input");

bem(element, modifier(s), mix(es)) return class names in BEM-style:

bem(); // input
bem("label"); // input__label
bem("label", "active"); // input__label input__label_active
bem("label", ["active", "large"]); // input__label input__label_active input__label_large
bem("label", { color: "red", large: false, active: true }); // input__label input__label_color_red input__label_active
bem("", { color: "red", large: false, active: true }); // input input_color_red input_active
bem("", "", "main-page"); // input main-page
bem("label", { color: "red" }, "main-page"); // input__label input__label_color_red main-page

CSS Modules

The second argument to createBem is the object created by the CSS module:

import { createBem } from "@mukhindev/create-bem";
import classes from "./style.module.css";

const bem = createBem("input", classes);

bem("label", "active"); // _input__label_{hash} _input__label_active_{hash}

If the css selector is undefined or empty, CSS modules ignore class generation. Utility createBem also ignores this selector:

bem("message", "", "mix"); // "mix"

If you find problems, check how your CSS selectors are hashed. Hashed names should be converted like this:

input -> _input_{hash}
input__label -> _input__label_{hash}

Options

Often the modifier is separated by --. The third argument to createBem is options:

const bem = createBem("input", undefined, { modifierKeyDivider: "--" });

Default options:

                             ↓
elementDivider: "__" // input__field_size_large
                                        ↓                          ↓
modifierKeyDivider: "_" //  input__field_size_large or input__field_active
                                              ↓
modifierValueDivider: "_" // input__field_size_large