81

I am trying to wrap my head around BEM naming convention. I am stuck at this. I may misunderstanding something, lets see.

I have a sidebar nav and a content nav.

My sidebar nav looks like this

<div class="sidebar">
    <ul class="sidebar__nav">
        <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
        <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
    </ul>
</div>

And my content nav looks like this

<div class="content">
    <ul class="content__nav">
        <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
        <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
    </ul>
</div>

Now I will run into a problem if I style .nav__item, they occur in both my navigations and should not have the same styling. Should I do some nesting here, or am I naming my blocks and elements wrong?

Nesting example in CSS:

.content__nav .nav__item { background: Red; }

Or should I name it like this:

<li class="content__nav__item"><a href="#" class="content__nav__link">LINK</a></li>

Can you help?

aventic
  • 1,494
  • 2
  • 16
  • 23

3 Answers3

95

There are a number of variants on how to write BEM classes, so be aware that are multiple competing standards. It started as a set of loose guidelines. Since posting this answer, Yandex has significantly overhauled their official standard (it's quite an improvement). The version of BEM I use is based heavily from an article by Nicolas Gallagher.

At this point I use "Atomic OOBEMITLESS", which is really just a way of saying that classes are modular and namespaced, selectors have low specificity, and states may be toggled with classes which allows CSS to be scaled, on top of a CSS preprocessor to make the code more concise and expressive.

All that said, I will be using the following BEM standard:

  • hyphenated class names as blocks:
    foo-bar
  • block name followed by __ followed by hyphenated class names for elements:
    foo-bar__fizz-buzz
  • block or element names followed by -- followed by hyphenated class names for modifiers:
    foo-bar--baz, foo-bar--baz__fizz-buzz, foo-bar__fizz-buzz--qux

BEM short form: block-name__element-name--modifier-name

You have three different blocks in your examples:

  1. sidebar, which has a sidebar__nav element
  2. content, which has a content__nav element
  3. nav, which has nav__item and nav__link elements

The sidebar and content blocks appear to be variations on the same block, and could be represented as .region.region--sidebar and .region.region--content.

The nav block is implicit on the ul element, and you should make it explicit:

<ul class="nav"><!-- could be content__nav or sidebar__nav as well if you choose -->
    <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
    <li class="nav__item"><a href="#" class="nav__link">LINK</a></li>
</ul>

Once you've specified that the ul element is a nav block, it makes sense to have the nav block be modified:

<ul class="nav nav--content">
    <li class="nav__item nav--content__item"><a href="#" class="nav__link nav--content__link">LINK</a></li>
    <li class="nav__item nav--content__item"><a href="#" class="nav__link nav--content__link">LINK</a></li>
</ul>

Once you've set up the CSS classes, styling all nav__item elements is simply:

.nav__item {
    ...styles here...
}

and overriding those styles for the content nav__item elements is:

.nav--content__item {
    ...styles here...
}
zzzzBov
  • 174,988
  • 54
  • 320
  • 367
  • Alright this makes much more sense! Thank you very much for the explanation. – aventic Mar 21 '14 at 18:35
  • @zzzzBov ok ! ok... where... ? – Cyril CHAPON Nov 29 '17 at 15:38
  • @CyrilCHAPON, I don't understand what you're asking. – zzzzBov Nov 29 '17 at 15:51
  • @zzzzBov "It has since been formalized much more rigorously" => where ? =) – Cyril CHAPON Dec 01 '17 at 15:11
  • @CyrilCHAPON, oh, that was in reference to a comment that has since been deleted that linked to the BEM site which I've included in my updated answer (https://en.bem.info/). I'm going to delete the "this post predates..." comment as it's no longer relevant given the updates I'd made since then. – zzzzBov Dec 01 '17 at 15:39
60

You should probably have a look at BEM's FAQ.

What would be a class name for an element inside another element? .block__elem1__elem2?

What should I do if my block has a complex structure and its elements are nested? CSS classes like block__elem1__elem2__elem3 look scaring. According to BEM method, block structure should be flatten; you do not need to reflect nested DOM structure of the block. So, the class names for this case would be:

.block{}
.block__elem1{}
.block__elem2{}
.block__elem3{}

Whereas the DOM representation of the block may be nested:

<div class='block'>
    <div class='block__elem1'>
        <div class='block__elem2'>
            <div class='block__elem3'></div>
        </div>
    </div>
</div>

Besides the fact that the classes look much nicer, it makes the elements be dependent on the block only. So, you can easily move them across the block when providing changes to the interface. The changes of the block DOM structure would not need corresponding changes to the CSS code.

<div class='block'>
    <div class='block__elem1'>
        <div class='block__elem2'></div>
    </div>
    <div class='block__elem3'></div>
</div>
Henrique Barcelos
  • 7,670
  • 1
  • 41
  • 66
4

Consider idea of _key_value pairs for modifiers (block or element is separated from modifier name with one underscore and its value with another one).

That makes sense to distinguish modifiers one from another (e.g. nav_type_content and nav_type_sidebar are both about the place where nav apper on the page but modifiers setting theme, size or making links work via ajax are different) and so to understand which modifiers can't be used together on one DOM-node.

Also it's more convenient to work with key: value pairs in javascript.

And there are quite a lot of ready-made components and tools which uses such convention: https://github.com/bem/

tadatuta
  • 2,007
  • 11
  • 12