vue-bem v0.0.3

Vue.js BEM Directive

If you find yourself writing a lot of long, tedious CSS class names in order to be consistent with the BEM naming convention, then try this directive. It automagically does all the heavy lifting based on the component's name found in $options.name.

It can produce BEM classes similar to those Harry Roberts advocate in this article.

In its essence it's just a helper for myself, but I thought maybe it would help others out there. Feel free to improve it.

With that said, if you write this:

Vue.component('user', {
  template: `
    <div v-bem:o-media.block v-bem:,premium>
     <img src="" alt="" v-bem:o-media,img.block v-bem:photo v-bem:c-avatar.block />
     <p v-bem:o-media,body,large.block v-bem:bio>...</p>
    </div>
  `
})

It produces:

<div class="o-media c-user c-user--premium">
 <img src="" alt="" class="o-media__img c-user__photo c-avatar">
 <p class="o-media__body c-user__bio">...</p>
</div>

A different example with a more tedious component name like 'congratulations-card':

Vue.component('congratulations-card', {
  props: [
    'title',
    'message'
  ],
  template:
    `<div v-bem>
      <section v-bem:content>
        <div v-bem:title>{{ title }}</div>
        <p v-bem:message>{{ message }}</p>
      </section>    
      <footer v-bem:footer>
        <slot name="footer"></slot>
      </footer>
    </div>`
})

Produces:

<div class="c-congratulations-card">
 <section class="c-congratulations-card__content">
   <div class="c-congratulations-card__title"></div>
   <p class="c-congratulations-card__message"></p>
 </section>    
 <footer class="c-congratulations-card__footer"></footer>
</div>

Installation

$ npm install vue-bem

Usage

First, import it...

import VueBem from 'vue-bem'

Then register it globally...

Vue.use(VueBem)

Or locally, for vue-loader or vue-cli situations where single file components are used...

import VueBem from 'vue-bem'
export default {
  directives: {
    'bem': VueBem
  }
}